Skip to content

Commit

Permalink
Merge branch 'release/1.27.0' into defect/309
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesMBligh authored Oct 9, 2023
2 parents 34b062d + d2fa8ab commit e70d497
Show file tree
Hide file tree
Showing 39 changed files with 413 additions and 286 deletions.
6 changes: 6 additions & 0 deletions slate/source/includes/_admin.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ This provides an overview of CDS Administration Endpoints. Please note this API

```diff
Changed to a non-breaking space between the indent chevron and property name in all schema Properties tables to prevent line wrapping

Resolved documentation rendering bug causing incorrect indent level to be displayed for some properties

Added statement to clarify that aggregate performance metrics exclude Secondary Data Holder performance

Corrected the requirement for the authorisations property of Get Metrics v4 and v5 to be mandatory
```

<%= partial "includes/cds_admin.md" %>
6 changes: 6 additions & 0 deletions slate/source/includes/_banking_apis.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,13 @@ This specification defines the APIs for Data Holders exposing Banking endpoints.
<tr><td><a href='./includes/swagger/cds_banking.yaml'>Banking OpenAPI Specification (YAML)</a></td></tr>
</table>

```diff
Added MetaPaginatedTransaction schema to 'Get Transactions For Account' to include the isQueryParamUnsupported property
```

```diff
Removed duplicate '400 - Invalid Version' error codes
```

<%= partial "includes/cds_banking.md" %>
<%= partial "includes/banking/_product_categories.md" %>
Expand Down
6 changes: 6 additions & 0 deletions slate/source/includes/_dcr_apis.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ This specification defines the APIs for Data Holders exposing Dynamic Client Reg
<tr><td><a href='./includes/swagger/cds_dcr.yaml'>DCR OpenAPI Specification (YAML)</a></td></tr>
</table>

```diff
Updated 'Non-normative Examples' to include JWT Body parameter for POST and PUT
```

```diff
Corrected typo in the description of the software_roles field
```

<%= partial "includes/cds_dcr.md" %>
8 changes: 8 additions & 0 deletions slate/source/includes/_energy_apis.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,12 @@ This specification defines the APIs for Data Holders exposing Energy endpoints.



```diff
Corrected descriptions mentioning electricity in the EnergyInvoiceGasUsageCharges schema
```

```diff
Added missing '400 - Invalid Date' error codes that MUST be supported by endpoints with date parameters
```

<%= partial "includes/cds_energy.md" %>
4 changes: 4 additions & 0 deletions slate/source/includes/_energy_apis_sdh.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,8 @@ This specification defines the APIs for Data Holders exposing Energy Secondary D



```diff
Added missing '400 - Invalid Date' error codes that MUST be supported by endpoints with date parameters
```

<%= partial "includes/cds_energy_sdh.md" %>
8 changes: 7 additions & 1 deletion slate/source/includes/_register.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,19 @@ These endpoints are exposed by the Register and consumed by Data Holders and Dat
</aside>


``` diff
Corrected typo in description of registeredCountry property

Changed the x-v header from optional to mandatory and removed the default x-v in 'Get Data Holder Brands', 'Get Software Statement Assertion', 'Get Software Products Statues', 'Get Data Recipients Statues', 'Get Data Recipients'.
Updated the x-v and x-min-v descriptions to align to other endpoints.
```

<br>
<table>
<tr><td><a href='./includes/swagger/cds_register.json'>Register OpenAPI Specification (JSON)</a></td></tr>
<tr><td><a href='./includes/swagger/cds_register.yaml'>Register OpenAPI Specification (YAML)</a></td></tr>
</table>


|API|Caller|Description|MTLS|TLS|Bearer Token|
|---|---|---|---|---|---|
| Get Register OpenId Provider Config | Data Recipient Brand or Software Product | Discovery of CDR Register OpenID Configuration | | <i class="icon-check"></i> | |
Expand Down
4 changes: 4 additions & 0 deletions slate/source/includes/additional/candidates/telco.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,7 @@ search: true
---

# Telco APIs

```diff
Removed references to 'Other Versions' in 'Get Telco Accounts' and 'Get Telco Account Detail'
```
6 changes: 5 additions & 1 deletion slate/source/includes/changelog.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# Change Log

``` diff
Updated release notes for version 1.25.0 to include references to three maintenance issues that were part of the release but not previously noted
```

The following table lists the changes made to these standards in reverse date order (most recent change is at the top).

|Change Date|Version|Description|Detail Of change|
|-----------|-------|-----------|----------------|
|TBC | 1.27.0 | Changes TBC | See [release notes](includes/releasenotes/releasenotes.1.27.0.html) and [Decision XXX](https://github.com/ConsumerDataStandardsAustralia/standards/issues/XXX) for details. |
|05/10/2023| 1.27.0 | Changes arising from Decision 313 (Maintenance Iteration 16) | See [release notes](includes/releasenotes/releasenotes.1.27.0.html) and [Decision 313](https://github.com/ConsumerDataStandardsAustralia/standards/issues/313) for details. |
|24/08/2023| 1.26.0 | Changes to obligations for the implementation of Get Metrics | See [release notes](includes/releasenotes/releasenotes.1.26.0.html) and [Decision 322](https://github.com/ConsumerDataStandardsAustralia/standards/issues/322) for details. |
|08/07/2023| 1.25.0 | Changes arising from Decision 303 (Maintenance iteration 15) and Decision 288 (Metrics and NFRs) | See [release notes](includes/releasenotes/releasenotes.1.25.0.html), [Decision 303](https://github.com/ConsumerDataStandardsAustralia/standards/issues/303) and [Decision 288](https://github.com/ConsumerDataStandardsAustralia/standards/issues/288) for details. |
|07/05/2023| 1.24.0 | Changes arising from Decision 281 (Maintenance iteration 14) | See [release notes](includes/releasenotes/releasenotes.1.24.0.html) and [Decision 281](https://github.com/ConsumerDataStandardsAustralia/standards/issues/281) for details. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@
|----------------------|-------------------------------------------|----------------------------------------------------------|--------|---------|----------------|-----------------|--------------------|---------------------|
| Register APIs | Get OpenId Provider Config | ``/.well-known/openid-configuration`` | <span class="method get">GET</span> | None | 2021-10-29&dagger; | N/A | 2021-10-29, V1.14.0&dagger; | N/A |
| Register APIs | Get JWKS | ``/jwks`` | <span class="method get">GET</span> | None | 2021-10-29&dagger; | N/A | 2021-10-29, V1.14.0&dagger; | N/A |
| Register APIs | Get Data Holder Brands | ``/{industry}/data-holders/brands`` | <span class="method get">GET</span> | V1 | 2021-10-29&dagger; | 2023-04-07 | 2021-10-29, V1.14.0&dagger; | 2021-12-23, V1.15.0 |
| Register APIs | Get Data Holder Brands | ``/{industry}/data-holders/brands`` | <span class="method get">GET</span> | V1 | 2021-10-29&dagger; | 2023-09-21 | 2021-10-29, V1.14.0&dagger; | 2021-12-23, V1.15.0 |
| Register APIs | Get Data Holder Brands | ``/{industry}/data-holders/brands`` | <span class="method get">GET</span> | V2 | 2022-11-15 | N/A | 2021-12-23, V1.15.0* | N/A |
| Register APIs | Get Data Holder Brands Summary | ``/{industry}/data-holders/brands/summary`` | <span class="method get">GET</span> | V1 | 2022-05-12 | N/A | 2022-05-23, V1.17.0 | N/A |
| Register APIs | Get Data Holder Statuses | ``/{industry}/data-holders/status`` | <span class="method get">GET</span> | V1 | 2022-11-15 | N/A | 2021-12-23, V1.15.0 | N/A |
| Register APIs | Get Software Statement Assertion (SSA) | ``/{industry}/data-recipients/``<br/>``brands/{dataRecipientBrandId}/``<br/>``software-products/{softwareProductId}/ssa`` | <span class="method get">GET</span> | V1 | 2021-10-29&dagger; | 2023-04-07 | 2021-10-29, V1.14.0&dagger; | 2021-12-23, V1.15.0 |
| Register APIs | Get Software Statement Assertion (SSA) | ``/{industry}/data-recipients/``<br/>``brands/{dataRecipientBrandId}/``<br/>``software-products/{softwareProductId}/ssa`` | <span class="method get">GET</span> | V2 | 2021-10-29&dagger; | 2023-04-07 | 2021-10-29, V1.14.0&dagger; | 2021-12-23, V1.15.0 |
| Register APIs | Get Software Statement Assertion (SSA) | ``/{industry}/data-recipients/``<br/>``brands/{dataRecipientBrandId}/``<br/>``software-products/{softwareProductId}/ssa`` | <span class="method get">GET</span> | V1 | 2021-10-29&dagger; | 2023-09-21 | 2021-10-29, V1.14.0&dagger; | 2021-12-23, V1.15.0 |
| Register APIs | Get Software Statement Assertion (SSA) | ``/{industry}/data-recipients/``<br/>``brands/{dataRecipientBrandId}/``<br/>``software-products/{softwareProductId}/ssa`` | <span class="method get">GET</span> | V2 | 2021-10-29&dagger; | 2023-09-21 | 2021-10-29, V1.14.0&dagger; | 2021-12-23, V1.15.0 |
| Register APIs | Get Software Statement Assertion (SSA) | ``/{industry}/data-recipients/``<br/>``brands/{dataRecipientBrandId}/``<br/>``software-products/{softwareProductId}/ssa`` | <span class="method get">GET</span> | V3 | 2022-11-15 | N/A | 2021-12-23, V1.15.0 | N/A |
| Register APIs | Get Software Products Statuses | ``/{industry}/data-recipients/``<br/>``brands/software-products/status`` | <span class="method get">GET</span> | V1 | 2021-10-29&dagger; | 2023-04-07 | 2021-10-29, V1.14.0&dagger; | 2021-12-23, V1.15.0 |
| Register APIs | Get Software Products Statuses | ``/{industry}/data-recipients/``<br/>``brands/software-products/status`` | <span class="method get">GET</span> | V1 | 2021-10-29&dagger; | 2023-09-21 | 2021-10-29, V1.14.0&dagger; | 2021-12-23, V1.15.0 |
| Register APIs | Get Software Products Statuses | ``/{industry}/data-recipients/``<br/>``brands/software-products/status`` | <span class="method get">GET</span> | V2 | 2022-11-15 | N/A | 2021-12-23, V1.15.0 | N/A |
| Register APIs | Get Data Recipient Statuses | ``/{industry}/data-recipients/status`` | <span class="method get">GET</span> | V1 | 2021-10-29&dagger; | 2023-04-07 | 2021-10-29, V1.14.0&dagger; | 2021-12-23, V1.15.0 |
| Register APIs | Get Data Recipient Statuses | ``/{industry}/data-recipients/status`` | <span class="method get">GET</span> | V1 | 2021-10-29&dagger; | 2023-09-21 | 2021-10-29, V1.14.0&dagger; | 2021-12-23, V1.15.0 |
| Register APIs | Get Data Recipient Statuses | ``/{industry}/data-recipients/status`` | <span class="method get">GET</span> | V2 | 2022-11-15 | N/A | 2021-12-23, V1.15.0 | N/A |
| Register APIs | Get Data Recipients | ``/{industry}/data-recipients`` | <span class="method get">GET</span> | V2 | 2021-10-29&dagger; | 2023-04-07 | 2021-10-29, V1.14.0&dagger; | 2021-12-23, V1.15.0 |
| Register APIs | Get Data Recipients | ``/{industry}/data-recipients`` | <span class="method get">GET</span> | V2 | 2021-10-29&dagger; | 2023-09-21 | 2021-10-29, V1.14.0&dagger; | 2021-12-23, V1.15.0 |
| Register APIs | Get Data Recipients | ``/{industry}/data-recipients`` | <span class="method get">GET</span> | V3 | 2022-11-15 | N/A | 2021-12-23, V1.15.0 | N/A |

**&dagger;NOTE:** The CDR Register standards were introduced into the Consumer Data Standards in v1.14.0. Prior to this the CDR Register specifications were hosted by the ACCC.
6 changes: 5 additions & 1 deletion slate/source/includes/introduction/_fdo.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,17 @@ The table below highlights these areas of the standards.



```diff
Added clarification for 'Get Energy Account Detail V2' for Data Holders going live on, or after, November 1st 2023
```

|Section|Description|Applicable Date|
|-------|-----------|---------------|
|[Get Account Detail V1](#get-account-detail)|Data holders **MAY** retire version 1 of this end point from February 28th 2023. Data recipients **MUST** upgrade their implementations to use version 2 by this time|February 28th 2023|
|[Get Product Detail V3](#get-product-detail)|Data holders **MAY** retire version 3 of this end point from February 28th 2023. Data recipients **MUST** upgrade their implementations to use version 4 by this time|February 28th 2023|
|[Get Customer Detail V1](#get-customer-detail)|Data holders **MAY** retire version 1 of this end point from February 28th 2023. Data recipients **MUST** upgrade their implementations to use version 2 by this time|February 28th 2023|
|[Get Energy Accounts V2](#get-energy-accounts)|Data Holders **MUST** implement v2 of this endpoint by **April 14th 2023** | April 14th 2023 |
|[Get Energy Account Detail V2](#get-energy-account-detail)|Data Holders **MUST** implement v2 of this endpoint by **April 14th 2023** | April 14th 2023 |
|[Get Energy Account Detail V2](#get-energy-account-detail)|<ul><li>Data Holders **MUST** implement v2 of this endpoint by **April 14th 2023**</li><li>Data Holders going live on, or after, November 1st 2023 are not required to support this version</li><ul> | April 14th 2023 |
|[Information Security profile](#security-profile) | FAPI 1.0 adoption is introduced across four phases.<br/><strong>Phase 3: Support Authorization Code Flow and Hybrid Flow</strong> includes, amongst other changes:<ul><li>Data Holders **MUST** support Authorization Code Flow</li><li>Data Holders **MUST** support Hybrid Flow</li></ul> | April 14th 2023 |
|[Error Codes: Secondary Data Holder flag](#error-codes)|<ul><li>Data Holders **MAY** implement the `isSecondaryDataHolderError` field on **November 15 2022**</li><li>Affected Data Holders **MUST** implement `isSecondaryDataHolderError` field by **May 15 2023**</li></ul> | May 15th 2023 |
|[Information Security profile](#security-profile) | FAPI 1.0 adoption is introduced across four phases.<br/><strong>Phase 4: Retire Hybrid Flow</strong>:<ul><li>Data Holders **MAY** retire Hybrid Flow</li></ul> | July 10th 2023 |
Expand Down
4 changes: 4 additions & 0 deletions slate/source/includes/introduction/_intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ This text is an example of text removed from the standards:
Note: changes to request and response payloads are listed at the beginning of the relevant API section due to the documentation being auto generated from OpenAPI specification files.
```

```diff
Improved line wrapping and removed horizontal scrollbars in the 'Non-normative Examples' and 'Version Delta' tab column.
```

These standards have been developed as part of the Australian Government's introduction of the [Consumer Data Right](https://www.accc.gov.au/focus-areas/consumer-data-right "ACCC Consumer Data Right webpage") legislation to give Australians greater control over their data.

The Consumer Data Right (CDR) is intended to be applied sector by sector across the whole economy, beginning in the banking, energy and telecommunications sectors. These standards have been developed to facilitate the Consumer Data Right by acting as a specific baseline for implementation.
Expand Down
6 changes: 5 additions & 1 deletion slate/source/includes/introduction/_references.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,17 @@

## Informative References

```diff
Changed the link to the CDR website to be HTTPS with www.
```

| **Reference** | **Description** |
|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| <a id="iref-ACCC"></a>**[ACCC]** | The Australian Competition and Consumer Commission is responsible for accrediting data recipients to participate in CDR, building and maintaining the Register of data recipients and data holders, providing support and guidance to participants and promoting compliance with the CDR rules and standards, including taking enforcement action where necessary.<br/><https://www.accc.gov.au/focus-areas/consumer-data-right-cdr-0> |
| <a id="iref-ANZSCO"></a>**[ANZSCO]** | ANZSCO - Australian and New Zealand Standard Classification of Occupations : <http://www.abs.gov.au/ANZSCO> |
| <a id="iref-ANZSIC-2006"></a>**[ANZSIC-2006]** | 1292.0 - Australian and New Zealand Standard Industrial Classification (ANZSIC), 2006 (Revision 2.0) : <http://www.abs.gov.au/anzsic> |
| <a id="iref-BCP195"></a>**[BCP195]** | Recommendations for Secure Use of Transport Layer Security (TLS) and Datagram Transport Layer Security (DTLS): <https://tools.ietf.org/html/bcp195> |
| <a id="iref-CDR"></a>**[CDR]** | Consumer Data Right: <http://cdr.gov.au>|
| <a id="iref-CDR"></a>**[CDR]** | Consumer Data Right: <https://www.cdr.gov.au>|
| <a id="iref-E-164"></a>**[E.164]** | The international public telecommunication numbering plan: <http://www.itu.int/rec/T-REC-E.164-201011-I/en> |
| <a id="iref-FAPI"></a>**[FAPI]** | Financial-Grade API - Home Page <https://openid.net/wg/fapi/>|
| <a id="iref-OAIC"></a>**[OAIC]** | The Office of the Australian Information Commissioner is responsible for regulating privacy and confidentiality under the CDR. The OAIC also handles complaints and notifications of eligible data breaches relating to CDR data.<br/><https://www.oaic.gov.au/consumer-data-right> |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,9 @@ search: false
# Get Billing For Account V1
This page documents version 1 of the Get Billing For Account end point.

* Data Holder **MUST** implement Get Billing For Account v2 by **November 1st 2023**.

This version is to be ceased to be called by data recipients by **September 9th 2024** and can be decommissioned by data holders as of that date.


* Data Holders **MUST** implement Get Billing For Account v2 by **November 1st 2023**.
* This version is to be ceased to be called by data recipients by **September 9th 2024** and can be decommissioned by data holders as of that date.
* Support for this version is not required for Data Holders going live on, or after, **November 1st 2023**.

## Get Billing For Account

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,9 @@ search: false
# Get Billing For Specific Accounts V1
This page documents version 1 of the Get Billing For Specific Accounts end point.

* Data Holder **MUST** implement Get Billing For Specific Accounts v2 by **November 1st 2023**.

This version is to be ceased to be called by data recipients by **September 9th 2024** and can be decommissioned by data holders as of that date.

* Data Holders **MUST** implement Get Billing For Specific Accounts v2 by **November 1st 2023**.
* This version is to be ceased to be called by data recipients by **September 9th 2024** and can be decommissioned by data holders as of that date.
* Support for this version is not required for Data Holders going live on, or after, **November 1st 2023**.

## Get Billing For Specific Accounts

Expand Down
7 changes: 3 additions & 4 deletions slate/source/includes/obsolete/get-bulk-billing-v1.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,9 @@ search: false
# Get Bulk Billing V1
This page documents version 1 of the Get Bulk Billing end point.

* Data Holder **MUST** implement Get Bulk Billing v2 by **November 1st 2023**.

This version is to be ceased to be called by data recipients by **September 9th 2024** and can be decommissioned by data holders as of that date.

* Data Holders **MUST** implement Get Bulk Billing v2 by **November 1st 2023**.
* This version is to be ceased to be called by data recipients by **September 9th 2024** and can be decommissioned by data holders as of that date.
* Support for this version is not required for Data Holders going live on, or after, **November 1st 2023**.

## Get Bulk Billing

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ search: false
This page documents the obsolete **version 1** of the Get Data Holder Brands end point.

<aside class="info">
This version will remain valid until a deprecation schedule is set.
This version was deprecated on 23rd December 2021 and retired on 21st September 2023
</aside>


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ search: false
This page documents the obsolete **version 1** of the Get Data Recipient Statuses end point.

<aside class="info">
This version will remain valid until a deprecation schedule is set.
This version was deprecated on 23rd December 2021 and retired on 21st September 2023
</aside>


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ search: false
This page documents the obsolete **version 2** of the Get Data Recipients end point.

<aside class="info">
This version will remain valid until a deprecation schedule is set.
This version was deprecated on 23rd December 2021 and retired on 21st September 2023
</aside>


Expand Down
Loading

0 comments on commit e70d497

Please sign in to comment.