Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
48 changes: 44 additions & 4 deletions openapi/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -117,10 +117,42 @@ tags:
description: >-
Operations for checking the current status of the Data Custodian
Resource Server.
- name: Customer Resources
- name: Customer
description: >-
Operations for accessing customer and billing information resources
(PII-containing). Uses the http://naesb.org/espi/customer namespace.
Operations for accessing Customer resources, which represent organizations
receiving services from a service supplier (PII-containing).
- name: CustomerAccount
description: >-
Operations for accessing Customer Account resources, which contain billing
and payment information (PII-containing).
- name: CustomerAgreement
description: >-
Operations for accessing Customer Agreement resources, which define service
terms at specific locations (PII-containing).
- name: ServiceLocation
description: >-
Operations for accessing Service Location resources, which represent physical
premises where service is provided (PII-containing).
- name: ServiceSupplier
description: >-
Operations for accessing Service Supplier resources, which represent utility
or energy service providers.
- name: EndDevice
description: >-
Operations for accessing End Device resources, which represent metering and
load management devices.
- name: Meter
description: >-
Operations for accessing Meter resources, which represent physical metering
assets at usage points.
- name: Statement
description: >-
Operations for accessing Statement resources, which represent billing
statements for services provided (PII-containing).
- name: ProgramDateIdMappings
description: >-
Operations for accessing Program Date ID Mappings, which contain customer
energy efficiency program enrollments.
x-tagGroups:
- name: OAuth Resources
tags:
Expand All @@ -145,7 +177,15 @@ x-tagGroups:
- ServiceStatus
- name: Customer Data
tags:
- Customer Resources
- Customer
- CustomerAccount
- CustomerAgreement
- ServiceLocation
- ServiceSupplier
- EndDevice
- Meter
- Statement
- ProgramDateIdMappings
servers:
- url: https://sandbox.greenbuttonalliance.org:8443/DataCustodian
description: Green Button Alliance Sandbox Server
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/Customer.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
get:
tags:
- Customer Resources
- Customer
summary: Retrieve all Customers [FB_50]
description: >-
Returns an Atom feed containing all Customer resources within the Data
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/CustomerAccount.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
get:
tags:
- Customer Resources
- CustomerAccount
summary: Retrieve all Customer Accounts [FB_51]
description: >-
Returns an Atom feed containing all CustomerAccount resources within the Data
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/CustomerAccount_{customerAccountId}.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
get:
tags:
- Customer Resources
- CustomerAccount
summary: Retrieve a specific Customer Account [FB_51]
description: >-
Returns an Atom entry containing a single CustomerAccount resource identified by
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/CustomerAgreement.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
get:
tags:
- Customer Resources
- CustomerAgreement
summary: Retrieve all Customer Agreements [FB_52]
description: >-
Returns an Atom feed containing all CustomerAgreement resources within the Data
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/CustomerAgreement_{customerAgreementId}.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
get:
tags:
- Customer Resources
- CustomerAgreement
summary: Retrieve a specific Customer Agreement [FB_52]
description: >-
Returns an Atom entry containing a single CustomerAgreement resource identified by
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/Customer_{customerId}.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
get:
tags:
- Customer Resources
- Customer
summary: Retrieve a specific Customer [FB_50]
description: >-
Returns an Atom entry containing a single Customer resource identified by
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/EndDevice.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
get:
tags:
- Customer Resources
- EndDevice
summary: Retrieve all End Devices [FB_54]
description: >-
Returns an Atom feed containing all EndDevice resources within the Data
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/EndDevice_{endDeviceId}.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
get:
tags:
- Customer Resources
- EndDevice
summary: Retrieve a specific End Device [FB_54]
description: >-
Returns an Atom entry containing a single EndDevice resource identified by
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/Meter.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
get:
tags:
- Customer Resources
- Meter
summary: Retrieve all Meters [FB_55]
description: >-
Returns an Atom feed containing all Meter resources within the Data
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/Meter_{meterId}.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
get:
tags:
- Customer Resources
- Meter
summary: Retrieve a specific Meter [FB_55]
description: >-
Returns an Atom entry containing a single Meter resource identified by
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/ProgramDateIdMappings.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
get:
tags:
- Customer Resources
- ProgramDateIdMappings
summary: Retrieve all Program Date ID Mappings [FB_58]
description: >-
Returns an Atom feed containing all ProgramDateIdMappings resources within the Data
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
get:
tags:
- Customer Resources
- ProgramDateIdMappings
summary: Retrieve specific Program Date ID Mappings [FB_58]
description: >-
Returns an Atom entry containing a single ProgramDateIdMappings resource identified by
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/ServiceLocation.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
get:
tags:
- Customer Resources
- ServiceLocation
summary: Retrieve all Service Locations [FB_53]
description: >-
Returns an Atom feed containing all ServiceLocation resources within the Data
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/ServiceLocation_{serviceLocationId}.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
get:
tags:
- Customer Resources
- ServiceLocation
summary: Retrieve a specific Service Location [FB_53]
description: >-
Returns an Atom entry containing a single ServiceLocation resource identified by
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/ServiceSupplier.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
get:
tags:
- Customer Resources
- ServiceSupplier
summary: Retrieve all Service Suppliers [FB_56]
description: >-
Returns an Atom feed containing all ServiceSupplier resources within the Data
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/ServiceSupplier_{serviceSupplierId}.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
get:
tags:
- Customer Resources
- ServiceSupplier
summary: Retrieve a specific Service Supplier [FB_56]
description: >-
Returns an Atom entry containing a single ServiceSupplier resource identified by
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/Statement.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
get:
tags:
- Customer Resources
- Statement
summary: Retrieve all Statements [FB_57]
description: >-
Returns an Atom feed containing all Statement resources within the Data
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/Statement_{statementId}.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
get:
tags:
- Customer Resources
- Statement
summary: Retrieve a specific Statement [FB_57]
description: >-
Returns an Atom entry containing a single Statement resource identified by
Expand Down