From e0dd9c11586bf2d544c6e910dbe04e654f665947 Mon Sep 17 00:00:00 2001 From: Ivan Hosgood Date: Mon, 16 May 2022 14:49:17 +1000 Subject: [PATCH 1/4] Added Register dependency schedule table to differentiate Register delivery from Participant future dated obligations --- slate/source/includes/_intro.md.erb | 1 + .../introduction/_dependencies_schedule.md | 27 +++++++++++++++++++ slate/source/includes/introduction/_fdo.md | 14 ++++------ .../releasenotes/releasenotes.1.17.0.html.md | 1 + 4 files changed, 34 insertions(+), 9 deletions(-) create mode 100644 slate/source/includes/introduction/_dependencies_schedule.md diff --git a/slate/source/includes/_intro.md.erb b/slate/source/includes/_intro.md.erb index 9147ff94..61538389 100644 --- a/slate/source/includes/_intro.md.erb +++ b/slate/source/includes/_intro.md.erb @@ -3,5 +3,6 @@ <%= partial "includes/introduction/intro.md" %> <%= partial "includes/introduction/fdo.md" %> +<%= partial "includes/introduction/dependencies_schedule.md" %> <%= partial "includes/introduction/endpoint_version_schedule.md" %> <%= partial "includes/security/references.md" %> diff --git a/slate/source/includes/introduction/_dependencies_schedule.md b/slate/source/includes/introduction/_dependencies_schedule.md new file mode 100644 index 00000000..6c9c5f5a --- /dev/null +++ b/slate/source/includes/introduction/_dependencies_schedule.md @@ -0,0 +1,27 @@ +## Register Dependency Schedule + +```diff ++ Added Register dependency schedule table to differentiate Register delivery from Participant future dated obligations ++ Added Get Data Holder Brands Summary API to the dependency schedule +``` + +The Register APIs dependency schedule specifies the latest dates the CDR Register can release API versions. Delivery past these dates may impact the ability for data holders and data recipients to meet their future dated obligations. + + + +The table below highlights these dependency dates. + +|Section|Description|Dependency Date| +|-------|-----------|---------------| +|[Get Data Holder Brands V2](#get-data-holder-brands)|CDR Register must introduce version 2 of this end point by November 15th 2022|November 15th 2022| +|[Get Software Statement Assertion (SSA) V3](#get-software-statement-assertion-ssa)|CDR Register must introduce version 3 of this end point by November 15th 2022|November 15th 2022| +|[Get Software Products Statuses V2](#get-software-products-statuses)|CDR Register must introduce version 2 of this end point by November 15th 2022|November 15th 2022| +|[Get Data Recipient Statuses V2](#get-data-recipients-statuses)|CDR Register must introduce version 2 of this end point by November 15th 2022|November 15th 2022| +|[Get Data Recipients V3](#get-data-recipients)|CDR Register must introduce version 3 of this end point by November 15th 2022|November 15th 2022| +|[Get Data Holder Statuses V1](#get-data-holder-statuses)|CDR Register must introduce version 1 of this end point by November 15th 2022|November 15th 2022| +|[Get Data Holder Brands Summary V1](#get-data-holder-brands-summary)|CDR Register must introduce version 1 of this end point by October 01st 2022|October 01st 2022| + + +The actual release dates for the Register APIs are expected to occur prior to these dates and are not defined by the Standards. + +The Register API release schedule will be made available in the future. diff --git a/slate/source/includes/introduction/_fdo.md b/slate/source/includes/introduction/_fdo.md index c1926f3f..c536f7f8 100644 --- a/slate/source/includes/introduction/_fdo.md +++ b/slate/source/includes/introduction/_fdo.md @@ -1,5 +1,10 @@ ## Future Dated Obligations +```diff +- Moved Register FDOs to the Register dependency schedule to differentiate Register delivery from Participant future dated obligations +``` + + The standards, as published from time to time, may include specific statements indicating that a specific section of the standards will not take effect until a future date or may cease to have effect on some future date. The table below highlights these areas of the standards. @@ -23,12 +28,6 @@ The table below highlights these areas of the standards. |[Self-Signed JWT Client Authentication](#self-signed-jwt-client-authentication) | Until July 31st 2022, Data Recipients MUST accept the [Resource Path](#uri-resource-path) for the endpoint and the ```` 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 V1](#get-payees)|Data 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 time|August 31st 2022| |[Get Payee Detail V1](#get-payee-detail)|Data 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 time|August 31st 2022| -|[Get Data Holder Brands V2](#get-data-holder-brands)‡|CDR Register must introduce version 2 of this end point by August 30th 2022†. Data recipients may upgrade their implementations to use this version from this time|August 30th 2022†| -|[Get Software Statement Assertion (SSA) V3](#get-software-statement-assertion-ssa)|CDR Register must introduce version 3 of this end point by August 30th 2022†. Data recipients may upgrade their implementations to use this version from this time|August 30th 2022†| -|[Get Software Products Statuses V2](#get-software-products-statuses)|CDR Register must introduce version 2 of this end point by August 30th 2022†. Data holders may upgrade their implementations to use this version from this time|August 30th 2022†| -|[Get Data Recipient Statuses V2](#get-data-recipients-statuses)|CDR Register must introduce version 2 of this end point by August 30th 2022†. Data holders may upgrade their implementations to use this version from this time|August 30th 2022†| -|[Get Data Recipients V3](#get-data-recipients)|CDR Register must introduce version 3 of this end point by August 30th 2022†. Data holders may upgrade their implementations to use this version from this time|August 30th 2022†| -|[Get Data Holder Statuses V1](#get-data-holder-statuses)|CDR Register must introduce version 3 of this end point by August 30th 2022†|August 30th 2022†| |[Information Security profile](#security-profile) | FAPI 1.0 adoption is introduced across three phases.
Phase 2: FAPI 1.0 Final (Baseline & Advanced) includes, amongst other changes: | September 16th 2022 | |[Get Metrics V3](#get-metrics)|Version 3 of this end point must be made available by affected data holders by October 1st 2022|October 1st 2022| |[Standard Error Codes](#error-codes) | Data Holders MAY retire application-specific error codes in favour of standard error codes from November 1st 2022 | November 1st 2022 | @@ -41,6 +40,3 @@ The table below highlights these areas of the standards. |[Get Customer Detail V1](#get-customer-detail)|Data holders may obsolete 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| |[Information Security profile](#security-profile) | FAPI 1.0 adoption is introduced across three phases.
Phase 3: Retire Hybrid Flow includes, amongst other changes: | April 7th 2023 | -**†NOTE:** Further consultation required with the ACCC to confirm this obligation date - -**‡NOTE:** Get Data Holder Brands V2 definition is still subject to change diff --git a/slate/source/includes/releasenotes/releasenotes.1.17.0.html.md b/slate/source/includes/releasenotes/releasenotes.1.17.0.html.md index 228feba0..9e1c1837 100644 --- a/slate/source/includes/releasenotes/releasenotes.1.17.0.html.md +++ b/slate/source/includes/releasenotes/releasenotes.1.17.0.html.md @@ -38,6 +38,7 @@ This release addresses the following Decision Proposals published on [Standards] | Obligation date highlighting | Highlighting based on a date pickers has been added for the Endpoint versioning schedule to enhance documentation functionality. This feature allows users to select a target date and determine what obligations apply at that date. | [Endpoint versioning schedule](../../includes/endpoint-version-schedule/) | Obligation Dates Table | A series of fixed obligation milestones were agreed in Maintenance Iteration 10. This set of milestones will be used to pin breaking changes to a deterministic series of possible obligation dates. | [Obligation Dates]() | | Scrollable diffs and examples | Added previous and next buttons to support easy scrolling between all diffs and non-normative examples. This feature is context dependent on the tab being viewed | N/A | +| Introduction | [**Standards Maintenance #465**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/465) Moved Register FDOs to the Register dependency schedule to differentiate Register delivery from Participant future dated obligations.
Register API versions now have dependency dates of **15th November 2022**, aligned to Energy | [Register Dependencies Schedule](../../#register-dependencies-schedule) | ## API End Points From 70387b5e37a945c021470ed7f7e639772eef6bba Mon Sep 17 00:00:00 2001 From: Ivan Hosgood Date: Mon, 16 May 2022 16:16:10 +1000 Subject: [PATCH 2/4] Updated endpoint version schedule to 2022-11-15 for register API versions where binding date was subject to ACCC review --- .../includes/_register.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/slate/source/includes/endpoint-version-schedule/includes/_register.md b/slate/source/includes/endpoint-version-schedule/includes/_register.md index 2d0ffc39..04676a53 100644 --- a/slate/source/includes/endpoint-version-schedule/includes/_register.md +++ b/slate/source/includes/endpoint-version-schedule/includes/_register.md @@ -10,19 +10,15 @@ | CDR Register APIs | Get OpenId Provider Config | ``/.well-known/openid-configuration`` | GET | None | 2021-10-29† | N/A | 2021-10-29, V1.14.0† | N/A | | CDR Register APIs | Get JWKS | ``/jwks`` | GET | None | 2021-10-29† | N/A | 2021-10-29, V1.14.0† | N/A | | CDR Register APIs | Get Data Holder Brands | ``/{industry}/data-holders/brands`` | GET | V1 | 2021-10-29† | N/A | 2021-10-29, V1.14.0† | 2021-12-23, V1.15.0 | -| CDR Register APIs | Get Data Holder Brands | ``/{industry}/data-holders/brands`` | GET | V2 | 2022-08-30‡ | N/A | 2021-12-23, V1.15.0* | N/A | +| CDR Register APIs | Get Data Holder Brands | ``/{industry}/data-holders/brands`` | GET | V2 | 2022-11-15 | N/A | 2021-12-23, V1.15.0* | N/A | | CDR Register APIs | Get Software Statement Assertion (SSA) | ``/{industry}/data-recipients/``
``brands/{dataRecipientBrandId}/``
``software-products/{softwareProductId}/ssa`` | GET | V2 | 2021-10-29† | N/A | 2021-10-29, V1.14.0† | 2021-12-23, V1.15.0 | -| CDR Register APIs | Get Software Statement Assertion (SSA) | ``/{industry}/data-recipients/``
``brands/{dataRecipientBrandId}/``
``software-products/{softwareProductId}/ssa`` | GET | V3 | 2022-08-30‡ | N/A | 2021-12-23, V1.15.0 | N/A | +| CDR Register APIs | Get Software Statement Assertion (SSA) | ``/{industry}/data-recipients/``
``brands/{dataRecipientBrandId}/``
``software-products/{softwareProductId}/ssa`` | GET | V3 | 2022-11-15 | N/A | 2021-12-23, V1.15.0 | N/A | | CDR Register APIs | Get Software Products Statuses | ``/{industry}/data-recipients/``
``brands/software-products/status`` | GET | V1 | 2021-10-29† | N/A | 2021-10-29, V1.14.0† | 2021-12-23, V1.15.0 | -| CDR Register APIs | Get Software Products Statuses | ``/{industry}/data-recipients/``
``brands/software-products/status`` | GET | V2 | 2022-08-30‡ | N/A | 2021-12-23, V1.15.0 | N/A | +| CDR Register APIs | Get Software Products Statuses | ``/{industry}/data-recipients/``
``brands/software-products/status`` | GET | V2 | 2022-11-15 | N/A | 2021-12-23, V1.15.0 | N/A | | CDR Register APIs | Get Data Recipient Statuses | ``/{industry}/data-recipients/status`` | GET | V1 | 2021-10-29† | N/A | 2021-10-29, V1.14.0† | 2021-12-23, V1.15.0 | -| CDR Register APIs | Get Data Recipient Statuses | ``/{industry}/data-recipients/status`` | GET | V2 | 2022-08-30‡ | N/A | 2021-12-23, V1.15.0 | N/A | +| CDR Register APIs | Get Data Recipient Statuses | ``/{industry}/data-recipients/status`` | GET | V2 | 2022-11-15 | N/A | 2021-12-23, V1.15.0 | N/A | | CDR Register APIs | Get Data Recipients | ``/{industry}/data-recipients`` | GET | V2 | 2021-10-29† | N/A | 2021-10-29, V1.14.0† | 2021-12-23, V1.15.0 | -| CDR Register APIs | Get Data Recipients | ``/{industry}/data-recipients`` | GET | V3 | 2022-08-30‡ | N/A | 2021-12-23, V1.15.0 | N/A | -| CDR Register APIs | Get Data Holder Statuses | ``/{industry}/data-holders/status`` | GET | V1 | 2022-08-30‡ | N/A | 2021-12-23, V1.15.0 | N/A | +| CDR Register APIs | Get Data Recipients | ``/{industry}/data-recipients`` | GET | V3 | 2022-11-15 | N/A | 2021-12-23, V1.15.0 | N/A | +| CDR Register APIs | Get Data Holder Statuses | ``/{industry}/data-holders/status`` | GET | V1 | 2022-11-15 | N/A | 2021-12-23, V1.15.0 | N/A | **†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. - -**‡NOTE:** This date has been defined to give certainty to Data Recipient and Data Holder participants but it is yet to be confirmed by the ACCC. - -**\*NOTE:** Data Holder Brands V2 definition is still subject to change From deaaf9d84117cfb45348134b4e182a34cdeec5a6 Mon Sep 17 00:00:00 2001 From: Ivan Hosgood Date: Tue, 17 May 2022 11:26:51 +1000 Subject: [PATCH 3/4] Added standards maintenance issue reference to release notes --- slate/source/includes/releasenotes/releasenotes.1.17.0.html.md | 1 + 1 file changed, 1 insertion(+) diff --git a/slate/source/includes/releasenotes/releasenotes.1.17.0.html.md b/slate/source/includes/releasenotes/releasenotes.1.17.0.html.md index 9e1c1837..62a2cab3 100644 --- a/slate/source/includes/releasenotes/releasenotes.1.17.0.html.md +++ b/slate/source/includes/releasenotes/releasenotes.1.17.0.html.md @@ -22,6 +22,7 @@ This release addresses the following change requests raised on [Standards Mainte - [Standards Maintenance Issue 438: Representing adjustment transactions within the Billing Payload for C&I customers](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/438) - [Standards Maintenance Issue 457: Energy - Get Service Point Detail register suffix should be optional](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/457) - [Standards Maintenance Issue 482: JWT signing non-normative examples use unsupported signing algorithm)](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/482) +- [Standards Maintenance Issue 465: Confirm Register API 2022 release dates](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/465) ### Decision Proposals From 04a33b94d50c0dc5a3b576ae778b8a0747c7f56a Mon Sep 17 00:00:00 2001 From: Ivan Hosgood Date: Thu, 19 May 2022 15:10:40 +1000 Subject: [PATCH 4/4] Changed formatting of dependency dates to remove leading zero --- slate/source/includes/introduction/_dependencies_schedule.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/slate/source/includes/introduction/_dependencies_schedule.md b/slate/source/includes/introduction/_dependencies_schedule.md index 6c9c5f5a..1f751d98 100644 --- a/slate/source/includes/introduction/_dependencies_schedule.md +++ b/slate/source/includes/introduction/_dependencies_schedule.md @@ -19,7 +19,7 @@ The table below highlights these dependency dates. |[Get Data Recipient Statuses V2](#get-data-recipients-statuses)|CDR Register must introduce version 2 of this end point by November 15th 2022|November 15th 2022| |[Get Data Recipients V3](#get-data-recipients)|CDR Register must introduce version 3 of this end point by November 15th 2022|November 15th 2022| |[Get Data Holder Statuses V1](#get-data-holder-statuses)|CDR Register must introduce version 1 of this end point by November 15th 2022|November 15th 2022| -|[Get Data Holder Brands Summary V1](#get-data-holder-brands-summary)|CDR Register must introduce version 1 of this end point by October 01st 2022|October 01st 2022| +|[Get Data Holder Brands Summary V1](#get-data-holder-brands-summary)|CDR Register must introduce version 1 of this end point by October 1st 2022|October 1st 2022| The actual release dates for the Register APIs are expected to occur prior to these dates and are not defined by the Standards.