From 7880ecdd9e61d1c0371218244ca446a6a9de2492 Mon Sep 17 00:00:00 2001 From: James Bligh Date: Mon, 20 Mar 2023 13:34:11 +1100 Subject: [PATCH] Rebuild --- docs/includes/cds_energy | 20 +- .../endpoint-version-schedule/index.html | 78 ++------ .../releasenotes/releasenotes.1.22.1.html | 47 ++++- docs/includes/swagger/cds_energy.json | 14 +- docs/includes/swagger/cds_energy.yaml | 7 - docs/index.html | 172 ++++++------------ slate/source/includes/_energy_apis.md.erb | 10 + slate/source/includes/cds_energy.md | 20 +- .../releasenotes/releasenotes.1.22.1.html.md | 4 +- slate/source/includes/swagger/cds_energy.json | 14 +- slate/source/includes/swagger/cds_energy.yaml | 7 - swagger-gen/api/cds_energy.json | 21 +-- swagger-gen/cds_energy.md | 20 +- 13 files changed, 167 insertions(+), 267 deletions(-) diff --git a/docs/includes/cds_energy b/docs/includes/cds_energy index f5ddede4..4d1229d7 100644 --- a/docs/includes/cds_energy +++ b/docs/includes/cds_energy @@ -2314,7 +2314,7 @@ x-cds-client-headers: string » meta body Meta -mandatory +optional none @@ -3185,7 +3185,7 @@ x-cds-client-headers: string » meta body Meta -mandatory +optional none @@ -5315,7 +5315,7 @@ x-cds-client-headers: string » meta body Meta -mandatory +optional none @@ -6229,7 +6229,7 @@ x-cds-client-headers: string » meta body Meta -mandatory +optional none @@ -7252,7 +7252,7 @@ x-cds-client-headers: string » meta body Meta -mandatory +optional none @@ -8540,7 +8540,7 @@ To perform this operation, you must be authenticated and authorised with the fol meta Meta -mandatory +optional none @@ -9029,7 +9029,7 @@ To perform this operation, you must be authenticated and authorised with the fol meta Meta -mandatory +optional none @@ -9105,7 +9105,7 @@ To perform this operation, you must be authenticated and authorised with the fol meta Meta -mandatory +optional none @@ -9168,7 +9168,7 @@ To perform this operation, you must be authenticated and authorised with the fol meta Meta -mandatory +optional none @@ -9288,7 +9288,7 @@ To perform this operation, you must be authenticated and authorised with the fol meta Meta -mandatory +optional none diff --git a/docs/includes/endpoint-version-schedule/index.html b/docs/includes/endpoint-version-schedule/index.html index 563e284b..5ded25a2 100644 --- a/docs/includes/endpoint-version-schedule/index.html +++ b/docs/includes/endpoint-version-schedule/index.html @@ -273,73 +273,23 @@

Obligation Dates Schedule

Legacy FDO -01/07/2021 -1 - - -Legacy FDO -31/07/2021 -1 - - -Legacy FDO -31/10/2021 -1 - - -Legacy FDO -01/11/2021 -2 - - -Legacy FDO -01/02/2022 -2 - - -Y22 #1 -31/03/2022 -1 - - -Legacy FDO -01/07/2022 -2 - - -Y22 #2 -04/07/2022 +16/09/2022 1 Legacy FDO -31/07/2022 -4 - - -Legacy FDO -30/07/2022 -6 - - -Y22 #3 -31/08/2022 -2 - - -Legacy FDO -16/09/2022 +01/10/2022 1 Legacy FDO -01/10/2022 +01/11/2022 1 Y22 #4 15/11/2022 -1 +3 Legacy FDO @@ -359,17 +309,17 @@

Obligation Dates Schedule

Y23 #1 14/04/2023 -1 +3 Y23 #2 -08/05/2023 -0 +15/05/2023 +1 Y23 #3 10/07/2023 -1 +3 Y23 #4 @@ -384,7 +334,7 @@

Obligation Dates Schedule

Y24 #1 11/03/2024 -0 +2 Y24 #2 @@ -808,7 +758,7 @@

Energy APIs

2022-11-15 2023-04-14 2021-10-29, V1.14.0 -TBC, V1.19.0 +2022-09-13, V1.19.0 Energy APIs @@ -818,7 +768,7 @@

Energy APIs

V2 2023-04-14 N/A -TBC, V1.19.0 +2022-09-13, V1.19.0 N/A @@ -830,7 +780,7 @@

Energy APIs

2022-11-15 2023-04-14 2021-10-29, V1.14.0 -TBC, V1.19.0 +2022-09-13, V1.19.0 Energy APIs @@ -838,9 +788,9 @@

Energy APIs

/energy/accounts/{accountId} GET V2 -2022-04-14 +2023-04-14 N/A -TBC, V1.19.0 +2022-09-13, V1.19.0 N/A diff --git a/docs/includes/releasenotes/releasenotes.1.22.1.html b/docs/includes/releasenotes/releasenotes.1.22.1.html index a3825581..1906d550 100644 --- a/docs/includes/releasenotes/releasenotes.1.22.1.html +++ b/docs/includes/releasenotes/releasenotes.1.22.1.html @@ -251,16 +251,43 @@

Changes Made

Change Requests<

This release addresses the following minor defects raised on Standards Staging:

Decision Proposals

-

This release addresses the following Decision Proposals published on Standards:

- - +

This release is a patch release and does not include any changes arising from a decision of the Chair

Introduction

-

No changes

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
ChangeDescriptionLink
Binding StatementAdded binding statement to the Introduction sectionIntroduction
Align Obligation DatesCorrections to the future dated obligations tableFDOs
Align Obligation DatesCorrections to the obligation dates tableObligations Table
Fix Binding DateCorrect the binding date for Get Energy Account Detail V2 in the end point scheduleFDOs

High Level Standards

No changes

API End Points

@@ -272,9 +299,9 @@

API End Points

-XXXX -XXXX -XXXX +Meta Objects Optional +Made the meta object in requests and non-list responses optional for energy APIs to align with decisions +Energy APIs

Information Security Profile

diff --git a/docs/includes/swagger/cds_energy.json b/docs/includes/swagger/cds_energy.json index 8d8bcc2c..11c6027a 100644 --- a/docs/includes/swagger/cds_energy.json +++ b/docs/includes/swagger/cds_energy.json @@ -4737,7 +4737,7 @@ "$ref" : "#/components/schemas/Meta" } }, - "required" : [ "data", "meta" ], + "required" : [ "data" ], "type" : "object" } } @@ -4767,7 +4767,7 @@ "$ref" : "#/components/schemas/Meta" } }, - "required" : [ "data", "meta" ], + "required" : [ "data" ], "type" : "object" } } @@ -5285,7 +5285,7 @@ "$ref" : "#/components/schemas/Meta" } }, - "required" : [ "data", "links", "meta" ], + "required" : [ "data", "links" ], "type" : "object" }, "EnergyAccountListResponseV2" : { @@ -5315,7 +5315,7 @@ "$ref" : "#/components/schemas/Meta" } }, - "required" : [ "data", "links", "meta" ], + "required" : [ "data", "links" ], "type" : "object" }, "EnergyPaymentScheduleResponse" : { @@ -5330,7 +5330,7 @@ "$ref" : "#/components/schemas/Meta" } }, - "required" : [ "data", "links", "meta" ], + "required" : [ "data", "links" ], "type" : "object" }, "EnergyConcessionsResponse" : { @@ -5345,7 +5345,7 @@ "$ref" : "#/components/schemas/Meta" } }, - "required" : [ "data", "links", "meta" ], + "required" : [ "data", "links" ], "type" : "object" }, "EnergyBalanceListResponse" : { @@ -5375,7 +5375,7 @@ "$ref" : "#/components/schemas/Meta" } }, - "required" : [ "data", "links", "meta" ], + "required" : [ "data", "links" ], "type" : "object" }, "EnergyInvoiceListResponse" : { diff --git a/docs/includes/swagger/cds_energy.yaml b/docs/includes/swagger/cds_energy.yaml index 3c5ecf50..ec2e46bb 100644 --- a/docs/includes/swagger/cds_energy.yaml +++ b/docs/includes/swagger/cds_energy.yaml @@ -4727,7 +4727,6 @@ components: $ref: '#/components/schemas/Meta' required: - data - - meta type: object description: Request payload containing list of specific Service Points to obtain data for @@ -4751,7 +4750,6 @@ components: $ref: '#/components/schemas/Meta' required: - data - - meta type: object description: Request payload containing list of specific Accounts to obtain data for @@ -5712,7 +5710,6 @@ components: required: - data - links - - meta type: object EnergyAccountListResponseV2: example: @@ -5756,7 +5753,6 @@ components: required: - data - links - - meta type: object EnergyPaymentScheduleResponse: example: @@ -5817,7 +5813,6 @@ components: required: - data - links - - meta type: object EnergyConcessionsResponse: example: @@ -5860,7 +5855,6 @@ components: required: - data - links - - meta type: object EnergyBalanceListResponse: example: @@ -5908,7 +5902,6 @@ components: required: - data - links - - meta type: object EnergyInvoiceListResponse: example: diff --git a/docs/index.html b/docs/index.html index d6b16e1e..ebd3149d 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1776,6 +1776,11 @@

Introduction

  • where the standards are specified as binding standards as required by the Consumer Data Right rules for the purposes of s56FA of the legislation, they apply as under contract between a data holder and an accredited data recipient. The legal effect of binding standards as between data holders and accredited data recipients is fully set out in s56FD and s56FE of the legislation.
    • +
    + Added binding statement in response to legal advice
+
    + +

    Some of these standards will be binding data standards under the Competition and Consumer (Consumer Data Right) Data Standards (No. 1) 2023. See that instrument here. In summary, provisions of these standards (as they exist from time to time) that impose obligations or prohibitions on CDR entities are binding data standards. Provisions included in these standards merely by way of guidance are not binding data standards.

    +

    Version

    These standards represent version 1.22.1 of the high level standards. See the versioning section for more information on how versions are managed in the standard.

    @@ -1790,6 +1795,13 @@

    Future Dated Obligations

    The table below highlights these areas of the standards.

    +
    Removed obligations more than six months in the past
+
+Reordered FDO entries by applicable date
+
+Corrected some typos
+
    + @@ -1798,96 +1810,6 @@

    Future Dated Obligations

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -1903,9 +1825,14 @@

    Future Dated Obligations

    - - - + + + + + + + + @@ -1943,21 +1870,6 @@

    Future Dated Obligations

    - - - - - - - - - - - - - - - @@ -1973,6 +1885,11 @@

    Future Dated Obligations

    + + + + + @@ -2051,8 +1968,15 @@

    Register Dependency Schedule

    The actual release dates for the Register APIs are expected to occur prior to these dates and are not defined by the Standards.

    -

    Endpoint Version Schedule

    +

    Endpoint Version Schedule

    Updated the obligation dates schedule to have correct
+numbers for each date
 
+Removed entries in the obligation dates schedule older
+than six months
+
+Corrected the year of the obligation date for Get
+Energy Account Detail V2
+

    A table-view of all endpoint versioning is available here.

    Normative References

    @@ -25844,7 +25768,15 @@

    Banking Term Deposit Account Types<

    Section
    Standard Error CodesData Recipients and Data Holders MAY implement the standard error codes from July 1st 2021July 1st 2021
    Get Metrics V2Version 2 of this end point MUST be made available by affected data holders by the end of July 2021July 31st 2021
    Get Metrics V1Data holders MAY obsolete version 1 of this end point from October 31st 2021. Data Holders who go live with consumer data sharing from July 1st 2021 MAY go live with only Get Metrics v2 support. The CDR Register MUST upgrade their implementation to use version 2 by this timeOctober 31st 2021
    Amending ConsentData Holders MUST implement the following standards from November 1st 2021 when a CDR consumer is invited to amend a current authorisation as per rule 4.22A and the ADR has supplied a cdr_arrangement_idNovember 1st 2021
    CX Standards: Unavailable AccountsData Holders MAY implement the following data standards effective from 1 November 2021:
    • Unavailable Accounts: No accounts can be shown
    • Unavailable Accounts: Authorisation not permitted
    • Unavailable Accounts: Request sharing rights
    		November 1st 2021
    CX Standards: WithdrawalsData Holders MUST implement the following data standards effective from 1 February 2022:
    • Withdrawal: Secondary User Instruction
    		February 1st 2022
    Standard Error CodesData Recipients and Data Holders MUST implement the standard error codes from February 1st 2022February 1st 2022
    Data Recipient CDR Arrangement EndpointFrom March 31st 2022, Data Recipients MUST support "CDR Arrangement JWT" method and "CDR Arrangement Form Parameter" method.
    Data Recipients SHOULD support the "CDR Arrangement JWT" method before March 31st 2022    		March 31st 2022
    Profile Scope Data LanguageFor new and amended consents and authorisations only, CDR participants SHOULD comply with the following standards from 1 February 2022, but MUST comply by 1 July 2022:
    • Technical Standards: Revised Claims
    • CX Standards: Profile Scope - Data Language Standards
    Note: These standards changes do not apply to existing consents and authorisations unless they are amended on or following the compliance dates.    		July 1st 2022
    CX Standards: Joint AccountsData holders MUST implement the following data standards from 1 July 2022:
    • Notifications: Alternative notification schedules for joint accounts
    • Notifications: Joint account alerts
    • Authorisation: Pending status
    • Withdrawal: Joint accounts
    		July 1st 2022
    Information Security profileFAPI 1.0 adoption is introduced across three phases.
    Phase 1: Voluntary FAPI 1.0 support & hygiene enhancements includes, amongst other changes:
    • Enforces requirements for authorisation code, token and request object use
    • Data Holders MAY support of FAPI 1.0 Final
    • Data Holders MAY support of Authorization Code Flow (including [PKCE] and [JARM]) in conjunction with Hybrid Flow
    		July 4th 2022
    Get Payee Detail V2Version 2 of this end point MUST be made available by affected data holders by July 31st 2022July 31st 2022
    Data Recipient CDR Arrangement EndpointFrom July 31st 2022, Data Holders MUST revoke consent using "CDR Arrangement JWT" method.
    Data Holders SHOULD use the "CDR Arrangement JWT" method from March 31st 2022    		July 31st 2022
    Get Payees V2Version 2 of this end point MUST be made available by affected data holders by July 31st 2022July 31st 2022
    Self-Signed JWT Client AuthenticationUntil July 31st 2022, Data Recipients MUST accept the Resource Path for the endpoint and the <RecipientBaseURI> as a valid audience value. From July 31st 2022, Data Holders MUST use an audience value matching the Resource Path for the endpoint and the Data Recipient MUST verify the audience matches the Resource Path for the endpoint.July 31st 2022
    Get Payees V1Data holders MAY obsolete version 1 of this end point from August 31st 2022. Data recipients MUST upgrade their implementations to use version 2 by this timeAugust 31st 2022
    Get Payee Detail V1Data holders MAY obsolete version 1 of this end point from August 31st 2022. Data recipients MUST upgrade their implementations to use version 2 by this timeAugust 31st 2022
    Information Security profileFAPI 1.0 adoption is introduced across three phases.
    Phase 2: FAPI 1.0 Final (Baseline & Advanced) includes, amongst other changes:
    • Enforces additional requirements for authorisation code, token and request object use
    • Enforces PAR-only authorisation request data submission
    • Refresh token cycling is not permitted
    • Data Holders and Data Recipients MUST support FAPI 1.0 Final including [RFC9126], [RFC7636] and [JARM]
    • Data Holders SHOULD support of Authorization Code Flow in conjunction with Hybrid Flow
    		September 16th 2022
    Get Metrics V3 Version 3 of this end point MUST be made available by affected data holders by October 1st 2022 October 1st 2022 November 15th 2022
    Registration ValidationData Holders MUST ignore unsupported authorisation scopes presented in the SSA for the creation and update of client registrations from August 31st 2022August 31st 2022Get Energy Accounts V1
    • Data Holders MAY go-live on November 15 2022 with v1 of this end point
    • Data Holders MAY decommission v1 of this end point as soon v2 is supported
    		November 15th 2022
    Get Energy Account Detail V1
    • Data Holders MAY go-live on November 15 2022 with v1 of this end point
    • Data Holders MAY decommission v1 of this end point as soon v2 is supported
    		November 15th 2022
    Get Account Detail V2 February 28th 2023
    Get Energy Accounts V1
    • Data Holders MAY go-live on November 15 2022 with v1 of this endopint
    • Data Holders MAY decommission v1 of this endopint as soon v2 is supported
    		November 15th 2022
    Get Energy Account Detail V1
    • Data Holders MAY go-live on November 15 2022 with v1 of this endopint
    • Data Holders MAY decommission v1 of this endopint as soon v2 is supported
    		November 15th 2022
    Error Codes: Secondary Data Holder flag
    • Data Holders MAY implement the isSecondaryDataHolderError field on November 15 2022
    • Affected Data Holders MUST implement isSecondaryDataHolderError field by May 15 2023
    		May 15th 2023
    Get Energy Accounts V2 Data Holder MUST implement v2 of this endpoint by April 14th 2023 April 14th 2023 April 14th 2023
    Error Codes: Secondary Data Holder flag
    • Data Holders MAY implement the isSecondaryDataHolderError field on November 15 2022
    • Affected Data Holders MUST implement isSecondaryDataHolderError field by May 15 2023
    		May 15th 2023
    Information Security profile FAPI 1.0 adoption is introduced across four phases.
    Phase 4: Retire Hybrid Flow:
    • Data Holders MAY retire Hybrid Flow
    		 July 10th 2023 NA
    -

    Energy APIs

    +

    Energy APIs

    Correction to make the meta object optional for:
+  Get DER for Service Point
+  Get Energy Account Detail
+  Get Agreed Payment Schedule
+  Get Concessions
+  Get Balance for Energy Account
+
+Correction to make the meta object optional in requests
+

    This specification defines the APIs for Data Holders exposing Energy endpoints.

    @@ -28238,7 +28170,7 @@

    Parameters

    - +
    » meta body Metamandatoryoptional none
    @@ -29137,7 +29069,7 @@

    Parameters

    » meta body Meta -mandatory +optional none @@ -31337,7 +31269,7 @@

    Parameters

    » meta body Meta -mandatory +optional none @@ -32279,7 +32211,7 @@

    Parameters

    » meta body Meta -mandatory +optional none @@ -33330,7 +33262,7 @@

    Parameters

    » meta body Meta -mandatory +optional none @@ -34622,7 +34554,7 @@

    EnergyDerDetailResponse< meta Meta -mandatory +optional none @@ -35111,7 +35043,7 @@

    EnergyAccountDetai meta Meta -mandatory +optional none @@ -35187,7 +35119,7 @@

    EnergyPaymentSched meta Meta -mandatory +optional none @@ -35250,7 +35182,7 @@

    EnergyConcessionsRespo meta Meta -mandatory +optional none @@ -35370,7 +35302,7 @@

    EnergyBalanceResponse

    meta Meta -mandatory +optional none diff --git a/slate/source/includes/_energy_apis.md.erb b/slate/source/includes/_energy_apis.md.erb index 8c8f2e92..5a7b4fa1 100644 --- a/slate/source/includes/_energy_apis.md.erb +++ b/slate/source/includes/_energy_apis.md.erb @@ -1,6 +1,16 @@ # Energy APIs +```diff +Correction to make the meta object optional for: + Get DER for Service Point + Get Energy Account Detail + Get Agreed Payment Schedule + Get Concessions + Get Balance for Energy Account + +Correction to make the meta object optional in requests +``` This specification defines the APIs for Data Holders exposing Energy endpoints. diff --git a/slate/source/includes/cds_energy.md b/slate/source/includes/cds_energy.md index 8efb8fa9..036c2ca7 100644 --- a/slate/source/includes/cds_energy.md +++ b/slate/source/includes/cds_energy.md @@ -1461,7 +1461,7 @@ Obtain the electricity usage data for a specific set of service points |body|body|[servicePointIdList](#schemacdr-energy-apiservicepointidlist)|mandatory|Request payload containing list of specific Service Points to obtain data for| |» data|body|object|mandatory|none| |»» servicePointIds|body|[string]|mandatory|Array of specific servicePointIds to obtain data for| -|» meta|body|[Meta](#schemacdr-energy-apimeta)|mandatory|none| +|» meta|body|[Meta](#schemacdr-energy-apimeta)|optional|none| #### Enumerated Values @@ -1961,7 +1961,7 @@ Obtain DER data for a specific set of service points |body|body|[servicePointIdList](#schemacdr-energy-apiservicepointidlist)|mandatory|Request payload containing list of specific Service Points to obtain data for| |» data|body|object|mandatory|none| |»» servicePointIds|body|[string]|mandatory|Array of specific servicePointIds to obtain data for| -|» meta|body|[Meta](#schemacdr-energy-apimeta)|mandatory|none| +|» meta|body|[Meta](#schemacdr-energy-apimeta)|optional|none| > Example responses @@ -3276,7 +3276,7 @@ Obtain the current balance for a specified set of accounts |body|body|[accountIdList](#schemacdr-energy-apiaccountidlist)|mandatory|Request payload containing list of specific Accounts to obtain data for| |» data|body|object|mandatory|none| |»» accountIds|body|[string]|mandatory|Array of specific accountIds to obtain data for| -|» meta|body|[Meta](#schemacdr-energy-apimeta)|mandatory|none| +|» meta|body|[Meta](#schemacdr-energy-apimeta)|optional|none| > Example responses @@ -3772,7 +3772,7 @@ Obtain invoices for a specified set of accounts |body|body|[accountIdList](#schemacdr-energy-apiaccountidlist)|mandatory|Request payload containing list of specific Accounts to obtain data for| |» data|body|object|mandatory|none| |»» accountIds|body|[string]|mandatory|Array of specific accountIds to obtain data for| -|» meta|body|[Meta](#schemacdr-energy-apimeta)|mandatory|none| +|» meta|body|[Meta](#schemacdr-energy-apimeta)|optional|none| > Example responses @@ -4377,7 +4377,7 @@ Obtain billing for a specified set of accounts |body|body|[accountIdList](#schemacdr-energy-apiaccountidlist)|mandatory|Request payload containing list of specific Accounts to obtain data for| |» data|body|object|mandatory|none| |»» accountIds|body|[string]|mandatory|Array of specific accountIds to obtain data for| -|» meta|body|[Meta](#schemacdr-energy-apimeta)|mandatory|none| +|» meta|body|[Meta](#schemacdr-energy-apimeta)|optional|none| > Example responses @@ -5468,7 +5468,7 @@ To perform this operation, you must be authenticated and authorised with the fol |---|---|---|---| |data|[EnergyDerRecord](#schemacdr-energy-apienergyderrecord)|mandatory|none| |links|[Links](#schemacdr-energy-apilinks)|mandatory|none| -|meta|[Meta](#schemacdr-energy-apimeta)|mandatory|none| +|meta|[Meta](#schemacdr-energy-apimeta)|optional|none|

    EnergyAccountListResponseV2

    @@ -5918,7 +5918,7 @@ To perform this operation, you must be authenticated and authorised with the fol |---|---|---|---| |data|[EnergyAccountDetailV2](#schemacdr-energy-apienergyaccountdetailv2)|mandatory|none| |links|[Links](#schemacdr-energy-apilinks)|mandatory|none| -|meta|[Meta](#schemacdr-energy-apimeta)|mandatory|none| +|meta|[Meta](#schemacdr-energy-apimeta)|optional|none|

    EnergyPaymentScheduleResponse

    @@ -5972,7 +5972,7 @@ To perform this operation, you must be authenticated and authorised with the fol |data|object|mandatory|none| |» paymentSchedules|[[EnergyPaymentSchedule](#schemacdr-energy-apienergypaymentschedule)]|mandatory|Array may be empty if no payment schedule exist| |links|[Links](#schemacdr-energy-apilinks)|mandatory|none| -|meta|[Meta](#schemacdr-energy-apimeta)|mandatory|none| +|meta|[Meta](#schemacdr-energy-apimeta)|optional|none|

    EnergyConcessionsResponse

    @@ -6013,7 +6013,7 @@ To perform this operation, you must be authenticated and authorised with the fol |data|object|mandatory|none| |» concessions|[[EnergyConcession](#schemacdr-energy-apienergyconcession)]|mandatory|Array may be empty if no concessions exist| |links|[Links](#schemacdr-energy-apilinks)|mandatory|none| -|meta|[Meta](#schemacdr-energy-apimeta)|mandatory|none| +|meta|[Meta](#schemacdr-energy-apimeta)|optional|none|

    EnergyBalanceListResponse

    @@ -6079,7 +6079,7 @@ To perform this operation, you must be authenticated and authorised with the fol |data|object|mandatory|none| |» balance|[AmountString](#common-field-types)|mandatory|The current balance of the account. A positive value indicates that amount is owing to be paid. A negative value indicates that the account is in credit| |links|[Links](#schemacdr-energy-apilinks)|mandatory|none| -|meta|[Meta](#schemacdr-energy-apimeta)|mandatory|none| +|meta|[Meta](#schemacdr-energy-apimeta)|optional|none|

    EnergyInvoiceListResponse

    diff --git a/slate/source/includes/releasenotes/releasenotes.1.22.1.html.md b/slate/source/includes/releasenotes/releasenotes.1.22.1.html.md index 85921262..8d514d62 100644 --- a/slate/source/includes/releasenotes/releasenotes.1.22.1.html.md +++ b/slate/source/includes/releasenotes/releasenotes.1.22.1.html.md @@ -20,6 +20,8 @@ This release addresses the following minor defects raised on [Standards Staging] - Issue [257](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/257): Notice for the Binding Data Standard - Issue [255](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/255): Maintenance of obligation date tables - Issue [254](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/254): Get Energy Account Detail V2 - Fix binding date +- Issue [245](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/254): Get Energy APIs: meta object should not be mandatory +- Issue [152](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/152): Get Meta objects to be optional in energy requests ### Decision Proposals @@ -44,7 +46,7 @@ No changes |Change|Description|Link| |------|-----------|----| -| XXXX | XXXX | XXXX | +| Meta Objects Optional | Made the meta object in requests and non-list responses optional for energy APIs to align with decisions | [Energy APIs](../../#energy-apis) | ## Information Security Profile diff --git a/slate/source/includes/swagger/cds_energy.json b/slate/source/includes/swagger/cds_energy.json index 8d8bcc2c..11c6027a 100644 --- a/slate/source/includes/swagger/cds_energy.json +++ b/slate/source/includes/swagger/cds_energy.json @@ -4737,7 +4737,7 @@ "$ref" : "#/components/schemas/Meta" } }, - "required" : [ "data", "meta" ], + "required" : [ "data" ], "type" : "object" } } @@ -4767,7 +4767,7 @@ "$ref" : "#/components/schemas/Meta" } }, - "required" : [ "data", "meta" ], + "required" : [ "data" ], "type" : "object" } } @@ -5285,7 +5285,7 @@ "$ref" : "#/components/schemas/Meta" } }, - "required" : [ "data", "links", "meta" ], + "required" : [ "data", "links" ], "type" : "object" }, "EnergyAccountListResponseV2" : { @@ -5315,7 +5315,7 @@ "$ref" : "#/components/schemas/Meta" } }, - "required" : [ "data", "links", "meta" ], + "required" : [ "data", "links" ], "type" : "object" }, "EnergyPaymentScheduleResponse" : { @@ -5330,7 +5330,7 @@ "$ref" : "#/components/schemas/Meta" } }, - "required" : [ "data", "links", "meta" ], + "required" : [ "data", "links" ], "type" : "object" }, "EnergyConcessionsResponse" : { @@ -5345,7 +5345,7 @@ "$ref" : "#/components/schemas/Meta" } }, - "required" : [ "data", "links", "meta" ], + "required" : [ "data", "links" ], "type" : "object" }, "EnergyBalanceListResponse" : { @@ -5375,7 +5375,7 @@ "$ref" : "#/components/schemas/Meta" } }, - "required" : [ "data", "links", "meta" ], + "required" : [ "data", "links" ], "type" : "object" }, "EnergyInvoiceListResponse" : { diff --git a/slate/source/includes/swagger/cds_energy.yaml b/slate/source/includes/swagger/cds_energy.yaml index 3c5ecf50..ec2e46bb 100644 --- a/slate/source/includes/swagger/cds_energy.yaml +++ b/slate/source/includes/swagger/cds_energy.yaml @@ -4727,7 +4727,6 @@ components: $ref: '#/components/schemas/Meta' required: - data - - meta type: object description: Request payload containing list of specific Service Points to obtain data for @@ -4751,7 +4750,6 @@ components: $ref: '#/components/schemas/Meta' required: - data - - meta type: object description: Request payload containing list of specific Accounts to obtain data for @@ -5712,7 +5710,6 @@ components: required: - data - links - - meta type: object EnergyAccountListResponseV2: example: @@ -5756,7 +5753,6 @@ components: required: - data - links - - meta type: object EnergyPaymentScheduleResponse: example: @@ -5817,7 +5813,6 @@ components: required: - data - links - - meta type: object EnergyConcessionsResponse: example: @@ -5860,7 +5855,6 @@ components: required: - data - links - - meta type: object EnergyBalanceListResponse: example: @@ -5908,7 +5902,6 @@ components: required: - data - links - - meta type: object EnergyInvoiceListResponse: example: diff --git a/swagger-gen/api/cds_energy.json b/swagger-gen/api/cds_energy.json index 7086e064..40e98f21 100644 --- a/swagger-gen/api/cds_energy.json +++ b/swagger-gen/api/cds_energy.json @@ -170,8 +170,7 @@ "type": "object", "required": [ "data", - "links", - "meta" + "links" ], "properties": { "data": { @@ -220,8 +219,7 @@ "type": "object", "required": [ "data", - "links", - "meta" + "links" ], "properties": { "data": { @@ -239,8 +237,7 @@ "type": "object", "required": [ "data", - "links", - "meta" + "links" ], "properties": { "data": { @@ -270,8 +267,7 @@ "type": "object", "required": [ "data", - "links", - "meta" + "links" ], "properties": { "data": { @@ -347,8 +343,7 @@ "type": "object", "required": [ "data", - "links", - "meta" + "links" ], "properties": { "data": { @@ -4194,8 +4189,7 @@ "schema": { "type": "object", "required": [ - "data", - "meta" + "data" ], "properties": { "data": { @@ -4229,8 +4223,7 @@ "schema": { "type": "object", "required": [ - "data", - "meta" + "data" ], "properties": { "data": { diff --git a/swagger-gen/cds_energy.md b/swagger-gen/cds_energy.md index 8efb8fa9..036c2ca7 100644 --- a/swagger-gen/cds_energy.md +++ b/swagger-gen/cds_energy.md @@ -1461,7 +1461,7 @@ Obtain the electricity usage data for a specific set of service points |body|body|[servicePointIdList](#schemacdr-energy-apiservicepointidlist)|mandatory|Request payload containing list of specific Service Points to obtain data for| |» data|body|object|mandatory|none| |»» servicePointIds|body|[string]|mandatory|Array of specific servicePointIds to obtain data for| -|» meta|body|[Meta](#schemacdr-energy-apimeta)|mandatory|none| +|» meta|body|[Meta](#schemacdr-energy-apimeta)|optional|none| #### Enumerated Values @@ -1961,7 +1961,7 @@ Obtain DER data for a specific set of service points |body|body|[servicePointIdList](#schemacdr-energy-apiservicepointidlist)|mandatory|Request payload containing list of specific Service Points to obtain data for| |» data|body|object|mandatory|none| |»» servicePointIds|body|[string]|mandatory|Array of specific servicePointIds to obtain data for| -|» meta|body|[Meta](#schemacdr-energy-apimeta)|mandatory|none| +|» meta|body|[Meta](#schemacdr-energy-apimeta)|optional|none| > Example responses @@ -3276,7 +3276,7 @@ Obtain the current balance for a specified set of accounts |body|body|[accountIdList](#schemacdr-energy-apiaccountidlist)|mandatory|Request payload containing list of specific Accounts to obtain data for| |» data|body|object|mandatory|none| |»» accountIds|body|[string]|mandatory|Array of specific accountIds to obtain data for| -|» meta|body|[Meta](#schemacdr-energy-apimeta)|mandatory|none| +|» meta|body|[Meta](#schemacdr-energy-apimeta)|optional|none| > Example responses @@ -3772,7 +3772,7 @@ Obtain invoices for a specified set of accounts |body|body|[accountIdList](#schemacdr-energy-apiaccountidlist)|mandatory|Request payload containing list of specific Accounts to obtain data for| |» data|body|object|mandatory|none| |»» accountIds|body|[string]|mandatory|Array of specific accountIds to obtain data for| -|» meta|body|[Meta](#schemacdr-energy-apimeta)|mandatory|none| +|» meta|body|[Meta](#schemacdr-energy-apimeta)|optional|none| > Example responses @@ -4377,7 +4377,7 @@ Obtain billing for a specified set of accounts |body|body|[accountIdList](#schemacdr-energy-apiaccountidlist)|mandatory|Request payload containing list of specific Accounts to obtain data for| |» data|body|object|mandatory|none| |»» accountIds|body|[string]|mandatory|Array of specific accountIds to obtain data for| -|» meta|body|[Meta](#schemacdr-energy-apimeta)|mandatory|none| +|» meta|body|[Meta](#schemacdr-energy-apimeta)|optional|none| > Example responses @@ -5468,7 +5468,7 @@ To perform this operation, you must be authenticated and authorised with the fol |---|---|---|---| |data|[EnergyDerRecord](#schemacdr-energy-apienergyderrecord)|mandatory|none| |links|[Links](#schemacdr-energy-apilinks)|mandatory|none| -|meta|[Meta](#schemacdr-energy-apimeta)|mandatory|none| +|meta|[Meta](#schemacdr-energy-apimeta)|optional|none|

    EnergyAccountListResponseV2

    @@ -5918,7 +5918,7 @@ To perform this operation, you must be authenticated and authorised with the fol |---|---|---|---| |data|[EnergyAccountDetailV2](#schemacdr-energy-apienergyaccountdetailv2)|mandatory|none| |links|[Links](#schemacdr-energy-apilinks)|mandatory|none| -|meta|[Meta](#schemacdr-energy-apimeta)|mandatory|none| +|meta|[Meta](#schemacdr-energy-apimeta)|optional|none|

    EnergyPaymentScheduleResponse

    @@ -5972,7 +5972,7 @@ To perform this operation, you must be authenticated and authorised with the fol |data|object|mandatory|none| |» paymentSchedules|[[EnergyPaymentSchedule](#schemacdr-energy-apienergypaymentschedule)]|mandatory|Array may be empty if no payment schedule exist| |links|[Links](#schemacdr-energy-apilinks)|mandatory|none| -|meta|[Meta](#schemacdr-energy-apimeta)|mandatory|none| +|meta|[Meta](#schemacdr-energy-apimeta)|optional|none|

    EnergyConcessionsResponse

    @@ -6013,7 +6013,7 @@ To perform this operation, you must be authenticated and authorised with the fol |data|object|mandatory|none| |» concessions|[[EnergyConcession](#schemacdr-energy-apienergyconcession)]|mandatory|Array may be empty if no concessions exist| |links|[Links](#schemacdr-energy-apilinks)|mandatory|none| -|meta|[Meta](#schemacdr-energy-apimeta)|mandatory|none| +|meta|[Meta](#schemacdr-energy-apimeta)|optional|none|

    EnergyBalanceListResponse

    @@ -6079,7 +6079,7 @@ To perform this operation, you must be authenticated and authorised with the fol |data|object|mandatory|none| |» balance|[AmountString](#common-field-types)|mandatory|The current balance of the account. A positive value indicates that amount is owing to be paid. A negative value indicates that the account is in credit| |links|[Links](#schemacdr-energy-apilinks)|mandatory|none| -|meta|[Meta](#schemacdr-energy-apimeta)|mandatory|none| +|meta|[Meta](#schemacdr-energy-apimeta)|optional|none|

    EnergyInvoiceListResponse