Skip to content

feat: enhance customer resources with real examples and OAuth2 documentation #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dfcoffin merged 2 commits into from
Feb 8, 2026
Merged

feat: enhance customer resources with real examples and OAuth2 documentation #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
19f3919
feat: update customer response examples with real ESPI sample data
dfcoffin Feb 8, 2026
17eeb1d
feat: enhance OAuth2 docs and add customer supporting schemas
dfcoffin Feb 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 21 additions & 9 deletions openapi/components/responses/AtomEntry_Customer.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,30 @@ content:
summary: A single Customer entry
value: |
<entry xmlns="http://www.w3.org/2005/Atom">
<id>urn:uuid:c8e5f2d9-3a7b-5e4c-9d1f-6b8a2c3e5d7f</id>
<link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Customer/407630" type="cust-entry/Customer"/>
<link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Customer" type="cust-feed/Customer"/>
<link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Customer/407630/CustomerAccount" type="cust-feed/CustomerAccount"/>
<id>urn:uuid:6c6d986b-bae0-54c9-b20c-f63b5fa9de56</id>
<link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e" type="cust-entry/Customer"/>
<link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer" type="cust-feed/Customer"/>
<link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount" type="cust-feed/CustomerAccount"/>
<link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters/TIMEZONE_407607_1455265" type="cust-entry/LocalTimeParameters"/>
<title>Customer</title>
<published>2023-10-20T17:32:35.448812Z</published>
<updated>2023-10-20T17:33:23.054424Z</updated>
<published>2023-10-20T17:56:19.660350Z</published>
<updated>2023-10-20T17:57:21.627755Z</updated>
<content>
<Customer xmlns="http://naesb.org/espi/customer">
<kind>0</kind>
<locale>en_US</locale>
<customerName>John Smith</customerName>
<Organisation>
<streetAddress>
<streetDetail>
<addressGeneral>200 SECOND AVE</addressGeneral>
</streetDetail>
<townDetail>
<name>OLDCASTLE</name>
<stateOrProvince>ON</stateOrProvince>
</townDetail>
<postalCode>N9V 2T7</postalCode>
</streetAddress>
</Organisation>
<kind>other</kind>
<customerName>JOHN DOE</customerName>
</Customer>
</content>
</entry>
28 changes: 20 additions & 8 deletions openapi/components/responses/AtomEntry_CustomerAccount.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,29 @@ content:
summary: A single CustomerAccount entry
value: |
<entry xmlns="http://www.w3.org/2005/Atom">
<id>urn:uuid:e3f7b9d1-5c8a-6e4d-9f2b-7a1c5e8d3f6b</id>
<link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/CustomerAccount/123456" type="cust-entry/CustomerAccount"/>
<link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/CustomerAccount" type="cust-feed/CustomerAccount"/>
<link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/CustomerAccount/123456/CustomerAgreement" type="cust-feed/CustomerAgreement"/>
<id>urn:uuid:118b34f4-64ab-5242-8ec9-bd2c6c2ae002</id>
<link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe" type="cust-entry/CustomerAccount"/>
<link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount" type="cust-feed/CustomerAccount"/>
<link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement" type="cust-feed/CustomerAgreement"/>
<link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e" type="cust-entry/Customer"/>
<title>CustomerAccount</title>
<published>2023-10-20T17:32:35.448812Z</published>
<updated>2023-10-20T17:33:23.054424Z</updated>
<published>2023-10-20T17:56:19.660350Z</published>
<updated>2023-10-20T17:57:21.627755Z</updated>
<content>
<CustomerAccount xmlns="http://naesb.org/espi/customer">
<billingCycle>15</billingCycle>
<accountId>ACC-123456</accountId>
<contactInfo>
<streetAddress>
<streetDetail>
<addressGeneral>200 SECOND AVE</addressGeneral>
</streetDetail>
<townDetail>
<name>OLDCASTLE</name>
<stateOrProvince>ON</stateOrProvince>
</townDetail>
<postalCode>N9V 2T7</postalCode>
</streetAddress>
</contactInfo>
<accountId>30000000-00</accountId>
</CustomerAccount>
</content>
</entry>
18 changes: 10 additions & 8 deletions openapi/components/responses/AtomEntry_CustomerAgreement.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,19 @@ content:
summary: A single CustomerAgreement entry
value: |
<entry xmlns="http://www.w3.org/2005/Atom">
<id>urn:uuid:a9f3c5e8-7b6d-5e4c-9f2a-8d1c6e5b3a7f</id>
<link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/CustomerAgreement/789012" type="cust-entry/CustomerAgreement"/>
<link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/CustomerAgreement" type="cust-feed/CustomerAgreement"/>
<link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/CustomerAgreement/789012/ServiceLocation" type="cust-feed/ServiceLocation"/>
<id>urn:uuid:b4d2b756-7442-558e-bfb2-5c3288e92f04</id>
<link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265" type="cust-entry/CustomerAgreement"/>
<link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement" type="cust-feed/CustomerAgreement"/>
<link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceSupplier" type="cust-feed/ServiceSupplier"/>
<link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ProgramDateIdMappings" type="cust-feed/ProgramDateIdMappings"/>
<link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation" type="cust-feed/ServiceLocation"/>
<link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe" type="cust-entry/CustomerAccount"/>
<title>CustomerAgreement</title>
<published>2023-10-20T17:32:35.448812Z</published>
<updated>2023-10-20T17:33:23.054424Z</updated>
<published>2023-10-20T17:56:20.594174Z</published>
<updated>2023-10-20T17:57:21.627755Z</updated>
<content>
<CustomerAgreement xmlns="http://naesb.org/espi/customer">
<currency>840</currency>
<agreementId>AGR-789012</agreementId>
<agreementId>30000000-00_004_electric</agreementId>
</CustomerAgreement>
</content>
</entry>
14 changes: 7 additions & 7 deletions openapi/components/responses/AtomEntry_EndDevice.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@ content:
summary: A single EndDevice entry
value: |
<entry xmlns="http://www.w3.org/2005/Atom">
<id>urn:uuid:e9f5d3c8-6b7a-5e4d-9f2c-7a1d6e5b8c3f</id>
<link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/EndDevice/901234" type="cust-entry/EndDevice"/>
<link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/EndDevice" type="cust-feed/EndDevice"/>
<id>urn:uuid:73a40799-2c91-5a15-a561-25102c959fcd</id>
<link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d/EndDevice/bd159f17-68fc-5b0e-a3d4-bd86dcade888" type="cust-entry/EndDevice"/>
<link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d/EndDevice" type="cust-feed/EndDevice"/>
<link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d" type="cust-entry/ServiceLocation"/>
<title>EndDevice</title>
<published>2023-10-20T17:32:35.448812Z</published>
<updated>2023-10-20T17:33:23.054424Z</updated>
<published>2023-10-20T17:56:20.594174Z</published>
<updated>2023-10-20T17:57:21.627755Z</updated>
<content>
<EndDevice xmlns="http://naesb.org/espi/customer">
<isVirtual>false</isVirtual>
<isPan>false</isPan>
<serialNumber>inverter-01-51111111111</serialNumber>
</EndDevice>
</content>
</entry>
14 changes: 7 additions & 7 deletions openapi/components/responses/AtomEntry_Meter.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@ content:
summary: A single Meter entry
value: |
<entry xmlns="http://www.w3.org/2005/Atom">
<id>urn:uuid:a8f7e6d5-9c8b-5e4d-9f2a-7d1c6e5b8a3f</id>
<link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Meter/567890" type="cust-entry/Meter"/>
<link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Meter" type="cust-feed/Meter"/>
<id>urn:uuid:aba939ae-5ce7-5393-bcfe-cceaa298424b</id>
<link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d/Meter/1556ef79-d143-595d-9e4c-8695bd5bc0df" type="cust-entry/Meter"/>
<link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d/Meter" type="cust-feed/Meter"/>
<link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d" type="cust-entry/ServiceLocation"/>
<title>Meter</title>
<published>2023-10-20T17:32:35.448812Z</published>
<updated>2023-10-20T17:33:23.054424Z</updated>
<published>2023-10-20T17:56:20.594174Z</published>
<updated>2023-10-20T17:57:21.627755Z</updated>
<content>
<Meter xmlns="http://naesb.org/espi/customer">
<formNumber>16S</formNumber>
<intervalLength>900</intervalLength>
<serialNumber>EPP00004</serialNumber>
</Meter>
</content>
</entry>
16 changes: 11 additions & 5 deletions openapi/components/responses/AtomEntry_ProgramDateIdMappings.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,20 @@ content:
summary: A single ProgramDateIdMappings entry
value: |
<entry xmlns="http://www.w3.org/2005/Atom">
<id>urn:uuid:f8e9d6c7-5b4a-5e4d-9f2c-7a1d6e5b8c3f</id>
<link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ProgramDateIdMappings/555666" type="cust-entry/ProgramDateIdMappings"/>
<link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ProgramDateIdMappings" type="cust-feed/ProgramDateIdMappings"/>
<id>urn:uuid:913830f7-e2e4-5dc2-8264-3dd7ab3cf316</id>
<link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ProgramDateIdMappings/5495fa4a-ce1e-57fa-beb4-862cb1a94370" type="cust-entry/ProgramDateIdMappings"/>
<link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ProgramDateIdMappings" type="cust-feed/ProgramDateIdMappings"/>
<link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265" type="cust-entry/CustomerAgreement"/>
<title>ProgramDateIdMappings</title>
<published>2023-10-20T17:32:35.448812Z</published>
<updated>2023-10-20T17:33:23.054424Z</updated>
<published>2023-10-20T17:56:20.594174Z</published>
<updated>2023-10-20T17:57:21.627755Z</updated>
<content>
<ProgramDateIdMappings xmlns="http://naesb.org/espi/customer">
<programDateIdMapping>
<programDateType>CUST_DR_PROGRAM_ENROLLMENT_DATE</programDateType>
<code>DR-01</code>
<name>DR Enrollment</name>
</programDateIdMapping>
</ProgramDateIdMappings>
</content>
</entry>
29 changes: 22 additions & 7 deletions openapi/components/responses/AtomEntry_ServiceLocation.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,31 @@ content:
summary: A single ServiceLocation entry
value: |
<entry xmlns="http://www.w3.org/2005/Atom">
<id>urn:uuid:c7f9e5d2-8a6b-5e4c-9f3a-7d1c6e5b8a2f</id>
<link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ServiceLocation/345678" type="cust-entry/ServiceLocation"/>
<link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ServiceLocation" type="cust-feed/ServiceLocation"/>
<link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ServiceLocation/345678/EndDevice" type="cust-feed/EndDevice"/>
<id>urn:uuid:fce8847d-4dac-5019-9d72-a2b756ac55b6</id>
<link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d" type="cust-entry/ServiceLocation"/>
<link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation" type="cust-feed/ServiceLocation"/>
<link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d/Meter" type="cust-feed/Meter"/>
<link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d/EndDevice" type="cust-feed/EndDevice"/>
<link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters/TIMEZONE_407607_1455265" type="cust-entry/LocalTimeParameters"/>
<link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265" type="cust-entry/CustomerAgreement"/>
<title>ServiceLocation</title>
<published>2023-10-20T17:32:35.448812Z</published>
<updated>2023-10-20T17:33:23.054424Z</updated>
<published>2023-10-20T17:56:20.594174Z</published>
<updated>2023-10-20T17:57:21.627755Z</updated>
<content>
<ServiceLocation xmlns="http://naesb.org/espi/customer">
<needsInspection>false</needsInspection>
<mainAddress>
<streetDetail>
<addressGeneral>200 SECOND AVE</addressGeneral>
</streetDetail>
<townDetail>
<name>OLDCASTLE</name>
<stateOrProvince>ON</stateOrProvince>
</townDetail>
<postalCode>N9V 2T7</postalCode>
</mainAddress>
<UsagePoints>
<UsagePoint>https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407607/UsagePoint/1455265</UsagePoint>
</UsagePoints>
</ServiceLocation>
</content>
</entry>
Loading