Skip to content

feat: add ESPI customer resources from customer_4.1.xsd #7

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 4 commits into from
Feb 8, 2026
Merged

feat: add ESPI customer resources from customer_4.1.xsd #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
db19a8f
feat: add customer resource schemas from customer_4.1.xsd
dfcoffin Feb 8, 2026
b0b84d0
feat: add customer resource response definitions
dfcoffin Feb 8, 2026
e899fad
feat: add Data Custodian path definitions for customer resources
dfcoffin Feb 8, 2026
851cf57
feat: integrate customer resources into main OpenAPI spec
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
26 changes: 26 additions & 0 deletions openapi/components/responses/AtomEntry_Customer.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
description: >-
OK - Returns an Atom entry containing a single Customer resource.
content:
application/atom+xml:
schema:
$ref: '../schemas/AtomEntry.yaml'
examples:
CustomerEntry:
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"/>
<title>Customer</title>
<published>2023-10-20T17:32:35.448812Z</published>
<updated>2023-10-20T17:33:23.054424Z</updated>
<content>
<Customer xmlns="http://naesb.org/espi/customer">
<kind>0</kind>
<locale>en_US</locale>
<customerName>John Smith</customerName>
</Customer>
</content>
</entry>
25 changes: 25 additions & 0 deletions openapi/components/responses/AtomEntry_CustomerAccount.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
description: >-
OK - Returns an Atom entry containing a single CustomerAccount resource.
content:
application/atom+xml:
schema:
$ref: '../schemas/AtomEntry.yaml'
examples:
CustomerAccountEntry:
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"/>
<title>CustomerAccount</title>
<published>2023-10-20T17:32:35.448812Z</published>
<updated>2023-10-20T17:33:23.054424Z</updated>
<content>
<CustomerAccount xmlns="http://naesb.org/espi/customer">
<billingCycle>15</billingCycle>
<accountId>ACC-123456</accountId>
</CustomerAccount>
</content>
</entry>
25 changes: 25 additions & 0 deletions openapi/components/responses/AtomEntry_CustomerAgreement.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
description: >-
OK - Returns an Atom entry containing a single CustomerAgreement resource.
content:
application/atom+xml:
schema:
$ref: '../schemas/AtomEntry.yaml'
examples:
CustomerAgreementEntry:
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"/>
<title>CustomerAgreement</title>
<published>2023-10-20T17:32:35.448812Z</published>
<updated>2023-10-20T17:33:23.054424Z</updated>
<content>
<CustomerAgreement xmlns="http://naesb.org/espi/customer">
<currency>840</currency>
<agreementId>AGR-789012</agreementId>
</CustomerAgreement>
</content>
</entry>
24 changes: 24 additions & 0 deletions openapi/components/responses/AtomEntry_EndDevice.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
description: >-
OK - Returns an Atom entry containing a single EndDevice resource.
content:
application/atom+xml:
schema:
$ref: '../schemas/AtomEntry.yaml'
examples:
EndDeviceEntry:
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"/>
<title>EndDevice</title>
<published>2023-10-20T17:32:35.448812Z</published>
<updated>2023-10-20T17:33:23.054424Z</updated>
<content>
<EndDevice xmlns="http://naesb.org/espi/customer">
<isVirtual>false</isVirtual>
<isPan>false</isPan>
</EndDevice>
</content>
</entry>
24 changes: 24 additions & 0 deletions openapi/components/responses/AtomEntry_Meter.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
description: >-
OK - Returns an Atom entry containing a single Meter resource.
content:
application/atom+xml:
schema:
$ref: '../schemas/AtomEntry.yaml'
examples:
MeterEntry:
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"/>
<title>Meter</title>
<published>2023-10-20T17:32:35.448812Z</published>
<updated>2023-10-20T17:33:23.054424Z</updated>
<content>
<Meter xmlns="http://naesb.org/espi/customer">
<formNumber>16S</formNumber>
<intervalLength>900</intervalLength>
</Meter>
</content>
</entry>
22 changes: 22 additions & 0 deletions openapi/components/responses/AtomEntry_ProgramDateIdMappings.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
description: >-
OK - Returns an Atom entry containing a single ProgramDateIdMappings resource.
content:
application/atom+xml:
schema:
$ref: '../schemas/AtomEntry.yaml'
examples:
ProgramDateIdMappingsEntry:
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"/>
<title>ProgramDateIdMappings</title>
<published>2023-10-20T17:32:35.448812Z</published>
<updated>2023-10-20T17:33:23.054424Z</updated>
<content>
<ProgramDateIdMappings xmlns="http://naesb.org/espi/customer">
</ProgramDateIdMappings>
</content>
</entry>
24 changes: 24 additions & 0 deletions openapi/components/responses/AtomEntry_ServiceLocation.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
description: >-
OK - Returns an Atom entry containing a single ServiceLocation resource.
content:
application/atom+xml:
schema:
$ref: '../schemas/AtomEntry.yaml'
examples:
ServiceLocationEntry:
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"/>
<title>ServiceLocation</title>
<published>2023-10-20T17:32:35.448812Z</published>
<updated>2023-10-20T17:33:23.054424Z</updated>
<content>
<ServiceLocation xmlns="http://naesb.org/espi/customer">
<needsInspection>false</needsInspection>
</ServiceLocation>
</content>
</entry>
23 changes: 23 additions & 0 deletions openapi/components/responses/AtomEntry_ServiceSupplier.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
description: >-
OK - Returns an Atom entry containing a single ServiceSupplier resource.
content:
application/atom+xml:
schema:
$ref: '../schemas/AtomEntry.yaml'
examples:
ServiceSupplierEntry:
summary: A single ServiceSupplier entry
value: |
<entry xmlns="http://www.w3.org/2005/Atom">
<id>urn:uuid:c8f9e6d5-7b6a-5e4c-9f2d-8a1c6e5b7a3f</id>
<link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ServiceSupplier/111222" type="cust-entry/ServiceSupplier"/>
<link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ServiceSupplier" type="cust-feed/ServiceSupplier"/>
<title>ServiceSupplier</title>
<published>2023-10-20T17:32:35.448812Z</published>
<updated>2023-10-20T17:33:23.054424Z</updated>
<content>
<ServiceSupplier xmlns="http://naesb.org/espi/customer">
<kind>0</kind>
</ServiceSupplier>
</content>
</entry>
23 changes: 23 additions & 0 deletions openapi/components/responses/AtomEntry_Statement.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
description: >-
OK - Returns an Atom entry containing a single Statement resource.
content:
application/atom+xml:
schema:
$ref: '../schemas/AtomEntry.yaml'
examples:
StatementEntry:
summary: A single Statement entry
value: |
<entry xmlns="http://www.w3.org/2005/Atom">
<id>urn:uuid:e8f9d6c7-6b5a-5e4d-9f2c-7a1d6e5b8c3f</id>
<link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Statement/333444" type="cust-entry/Statement"/>
<link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Statement" type="cust-feed/Statement"/>
<title>Statement</title>
<published>2023-10-20T17:32:35.448812Z</published>
<updated>2023-10-20T17:33:23.054424Z</updated>
<content>
<Statement xmlns="http://naesb.org/espi/customer">
<issueDateTime>1697820000</issueDateTime>
</Statement>
</content>
</entry>
32 changes: 32 additions & 0 deletions openapi/components/responses/AtomFeed_Customer.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
description: >-
OK - Returns an Atom feed containing a collection of Customer entries.
content:
application/atom+xml:
schema:
$ref: '../schemas/AtomFeed.yaml'
examples:
CustomerFeed:
summary: A feed containing Customer resources
value: |
<feed xmlns="http://www.w3.org/2005/Atom">
<id>urn:uuid:b47f3a45-8d21-5c19-a3d2-7f1e4b9c6a08</id>
<link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Customer" type="cust-feed/Customer"/>
<title>Customer</title>
<updated>2023-10-20T17:33:23.054424Z</updated>
<entry>
<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"/>
<title>Customer</title>
<published>2023-10-20T17:32:35.448812Z</published>
<updated>2023-10-20T17:33:23.054424Z</updated>
<content>
<Customer xmlns="http://naesb.org/espi/customer">
<kind>0</kind>
<locale>en_US</locale>
<customerName>John Smith</customerName>
</Customer>
</content>
</entry>
</feed>
31 changes: 31 additions & 0 deletions openapi/components/responses/AtomFeed_CustomerAccount.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
description: >-
OK - Returns an Atom feed containing a collection of CustomerAccount entries.
content:
application/atom+xml:
schema:
$ref: '../schemas/AtomFeed.yaml'
examples:
CustomerAccountFeed:
summary: A feed containing CustomerAccount resources
value: |
<feed xmlns="http://www.w3.org/2005/Atom">
<id>urn:uuid:d5a9c8f2-4e6b-5d7a-8c3e-1f9b6a5d8c2e</id>
<link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/CustomerAccount" type="cust-feed/CustomerAccount"/>
<title>CustomerAccount</title>
<updated>2023-10-20T17:33:23.054424Z</updated>
<entry>
<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"/>
<title>CustomerAccount</title>
<published>2023-10-20T17:32:35.448812Z</published>
<updated>2023-10-20T17:33:23.054424Z</updated>
<content>
<CustomerAccount xmlns="http://naesb.org/espi/customer">
<billingCycle>15</billingCycle>
<accountId>ACC-123456</accountId>
</CustomerAccount>
</content>
</entry>
</feed>
31 changes: 31 additions & 0 deletions openapi/components/responses/AtomFeed_CustomerAgreement.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
description: >-
OK - Returns an Atom feed containing a collection of CustomerAgreement entries.
content:
application/atom+xml:
schema:
$ref: '../schemas/AtomFeed.yaml'
examples:
CustomerAgreementFeed:
summary: A feed containing CustomerAgreement resources
value: |
<feed xmlns="http://www.w3.org/2005/Atom">
<id>urn:uuid:f2d8c9e5-6a7b-5c4d-8e3f-9b1a6c5d8e2f</id>
<link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/CustomerAgreement" type="cust-feed/CustomerAgreement"/>
<title>CustomerAgreement</title>
<updated>2023-10-20T17:33:23.054424Z</updated>
<entry>
<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"/>
<title>CustomerAgreement</title>
<published>2023-10-20T17:32:35.448812Z</published>
<updated>2023-10-20T17:33:23.054424Z</updated>
<content>
<CustomerAgreement xmlns="http://naesb.org/espi/customer">
<currency>840</currency>
<agreementId>AGR-789012</agreementId>
</CustomerAgreement>
</content>
</entry>
</feed>
30 changes: 30 additions & 0 deletions openapi/components/responses/AtomFeed_EndDevice.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
description: >-
OK - Returns an Atom feed containing a collection of EndDevice entries.
content:
application/atom+xml:
schema:
$ref: '../schemas/AtomFeed.yaml'
examples:
EndDeviceFeed:
summary: A feed containing EndDevice resources
value: |
<feed xmlns="http://www.w3.org/2005/Atom">
<id>urn:uuid:d8e9f5c3-7a6b-5e4d-9f2c-8a1d6e5c8b3f</id>
<link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/EndDevice" type="cust-feed/EndDevice"/>
<title>EndDevice</title>
<updated>2023-10-20T17:33:23.054424Z</updated>
<entry>
<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"/>
<title>EndDevice</title>
<published>2023-10-20T17:32:35.448812Z</published>
<updated>2023-10-20T17:33:23.054424Z</updated>
<content>
<EndDevice xmlns="http://naesb.org/espi/customer">
<isVirtual>false</isVirtual>
<isPan>false</isPan>
</EndDevice>
</content>
</entry>
</feed>
30 changes: 30 additions & 0 deletions openapi/components/responses/AtomFeed_Meter.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
description: >-
OK - Returns an Atom feed containing a collection of Meter entries.
content:
application/atom+xml:
schema:
$ref: '../schemas/AtomFeed.yaml'
examples:
MeterFeed:
summary: A feed containing Meter resources
value: |
<feed xmlns="http://www.w3.org/2005/Atom">
<id>urn:uuid:f9e6d4c8-7b6a-5e4d-9f2c-8a1d6e5c7b3f</id>
<link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Meter" type="cust-feed/Meter"/>
<title>Meter</title>
<updated>2023-10-20T17:33:23.054424Z</updated>
<entry>
<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"/>
<title>Meter</title>
<published>2023-10-20T17:32:35.448812Z</published>
<updated>2023-10-20T17:33:23.054424Z</updated>
<content>
<Meter xmlns="http://naesb.org/espi/customer">
<formNumber>16S</formNumber>
<intervalLength>900</intervalLength>
</Meter>
</content>
</entry>
</feed>
Loading