diff --git a/docs/includes/additional/additional20230822-12737-11ck0v b/docs/includes/additional/additional20230823-23024-lrwqa8
similarity index 100%
rename from docs/includes/additional/additional20230822-12737-11ck0v
rename to docs/includes/additional/additional20230823-23024-lrwqa8
diff --git a/docs/includes/cds_admin b/docs/includes/cds_admin
index cd1bbd26..10f9dba7 100644
--- a/docs/includes/cds_admin
+++ b/docs/includes/cds_admin
@@ -192,15 +192,15 @@ This operation may only be called by the CDR Register
This end point is not required to be implemented by the Australian Energy Market Operator, the Australian Energy Regulator or the Department of State administered by the Minister of Victoria administering the National Electricity (Victoria) Act 2005 (Vic).
-NOTE: This version must be implemented by June 13th 2024
+NOTE: This version MUST be implemented by May 13th 2024
Obsolete versions: v1 v2 .
Deprecated versions:
-v3
-v4 - This version, or v5, must be implemented by November 1st 2023
+v3 - Implementation not required for Data Holders going live on, or after, 1st November 2023. Other Data Holders MAY retire this version from the earlier of 13th May 2023 or from the time ACCC announce that they no longer call this version
+v4 - This version, or v5, MUST be implemented by November 1st 2023
If the Data Holder supports private_key_jwt client authentication they MUST validate the scope.
diff --git a/docs/includes/endpoint-version-schedule/index.html b/docs/includes/endpoint-version-schedule/index.html
index 5abcdd64..e6b0e876 100644
--- a/docs/includes/endpoint-version-schedule/index.html
+++ b/docs/includes/endpoint-version-schedule/index.html
@@ -1294,9 +1294,9 @@ Admin APIs
GET
V3
2022-10-01
-N/A
+2024-05-13 †
2021-10-06, V1.12.0
-N/A
+2023-07-08, V1.25.0
Admin APIs
@@ -1307,7 +1307,7 @@ Admin APIs
2023-11-01
When v5 Implemented
2023-07-08, V1.25.0
-N/A
+2023-07-08, V1.25.0
Admin APIs
@@ -1315,12 +1315,19 @@ Admin APIs
/admin/metrics
GET
V5
-2024-06-13
+2024-05-13
N/A
2023-07-08, V1.25.0
N/A
+
+†NOTE: the details of the retirement date for Get Metrics v3 is as follows:
+
+
+Implementation of Get Metrics v3 is not required for Data Holders going live on, or after, 1st November 2023
+Other Data Holders MAY retire this version from the earlier of 13th May 2023 or from the time ACCC announce that they no longer call this version
+
Register APIs
These endpoints are not implemented by Data Holders and Data Recipients. They are hosted by the Register for consumption by participants.
diff --git a/docs/includes/obsolete/get-metrics-v3.html b/docs/includes/obsolete/get-metrics-v3.html
index 6b5e0477..c12f1467 100644
--- a/docs/includes/obsolete/get-metrics-v3.html
+++ b/docs/includes/obsolete/get-metrics-v3.html
@@ -282,7 +282,9 @@
Get Metrics V3
This page documents the deprecated version 3 of the Get Metrics end point.
-This version does not yet have an obsolescence date and must continue to be supported by data holders.
+Support for this version is not required for Data Holders going live on, or after, 1st November 2023.
+
+Other Data Holders MAY retire this version from the earlier of 13th May 2023 or from the time ACCC announce that they no longer call this version.
Get Metrics
diff --git a/docs/includes/obsolete/get-metrics-v4.html b/docs/includes/obsolete/get-metrics-v4.html
index eacc5fde..8c205420 100644
--- a/docs/includes/obsolete/get-metrics-v4.html
+++ b/docs/includes/obsolete/get-metrics-v4.html
@@ -285,7 +285,7 @@
Get Metrics V4
This page documents the deprecated version 4 of the Get Metrics end point.
-This version must be implemented by November 1st 2023 and may be obsoleted once v5 has been implemented
+This version MUST be implemented by November 1st 2023 and MAY be retured once v5 has been implemented
Get Metrics
diff --git a/docs/includes/releasenotes/releasenotes.1.26.0.html b/docs/includes/releasenotes/releasenotes.1.26.0.html
index e73bfb1d..c787d76e 100644
--- a/docs/includes/releasenotes/releasenotes.1.26.0.html
+++ b/docs/includes/releasenotes/releasenotes.1.26.0.html
@@ -283,9 +283,12 @@ API End Points
Link
+
+Modified Get Metrics Obligations
+Changes to the obligation dates for Get Metrics v3 as determined in Decision 322
+Admin APIs
+
-
-TBD
No Change
Register Standards
diff --git a/docs/includes/swagger/cds_admin.json b/docs/includes/swagger/cds_admin.json
index d10d2d04..d3b4f529 100644
--- a/docs/includes/swagger/cds_admin.json
+++ b/docs/includes/swagger/cds_admin.json
@@ -103,7 +103,7 @@
},
"/admin/metrics" : {
"get" : {
- "description" : "This end point allows the ACCC to obtain operational statistics from the Data Holder (at the Data Holder Brand level) on the operation of their CDR compliant implementation. The statistics obtainable from this end point are determined by the non-functional requirements for the CDR regime.\n\nThis end point is not required to be implemented by the Australian Energy Market Operator, the Australian Energy Regulator or the Department of State administered by the Minister of Victoria administering the National Electricity (Victoria) Act 2005 (Vic).\n\nNOTE: This version must be implemented by **June 13th 2024**\n\nObsolete versions: [v1](includes/obsolete/get-metrics-v1.html) [v2](includes/obsolete/get-metrics-v2.html).\n\nDeprecated versions:\n\n- [v3](includes/obsolete/get-metrics-v3.html)\n- [v4](includes/obsolete/get-metrics-v4.html) - This version, or v5, must be implemented by **November 1st 2023**\n\nIf the Data Holder supports private_key_jwt client authentication they MUST validate the scope.",
+ "description" : "This end point allows the ACCC to obtain operational statistics from the Data Holder (at the Data Holder Brand level) on the operation of their CDR compliant implementation. The statistics obtainable from this end point are determined by the non-functional requirements for the CDR regime.\n\nThis end point is not required to be implemented by the Australian Energy Market Operator, the Australian Energy Regulator or the Department of State administered by the Minister of Victoria administering the National Electricity (Victoria) Act 2005 (Vic).\n\nNOTE: This version **MUST** be implemented by **May 13th 2024**\n\nObsolete versions: [v1](includes/obsolete/get-metrics-v1.html) [v2](includes/obsolete/get-metrics-v2.html).\n\nDeprecated versions:\n\n- [v3](includes/obsolete/get-metrics-v3.html) - Implementation not required for Data Holders going live on, or after, 1st November 2023. Other Data Holders **MAY** retire this version from the earlier of **13th May 2023** or from the time ACCC announce that they no longer call this version\n- [v4](includes/obsolete/get-metrics-v4.html) - This version, or v5, **MUST** be implemented by **November 1st 2023**\n\nIf the Data Holder supports private_key_jwt client authentication they MUST validate the scope.",
"operationId" : "getMetrics",
"parameters" : [ {
"description" : "The period of metrics to be requested. Values can be CURRENT (meaning metrics for current period, dependent on the metric type), HISTORIC (meaning metrics for previous period, depending on the metric type) or ALL. If absent the default is ALL.",
diff --git a/docs/includes/swagger/cds_admin.yaml b/docs/includes/swagger/cds_admin.yaml
index 6372df99..4d9c5e2b 100644
--- a/docs/includes/swagger/cds_admin.yaml
+++ b/docs/includes/swagger/cds_admin.yaml
@@ -99,14 +99,14 @@ paths:
This end point is not required to be implemented by the Australian Energy Market Operator, the Australian Energy Regulator or the Department of State administered by the Minister of Victoria administering the National Electricity (Victoria) Act 2005 (Vic).
- NOTE: This version must be implemented by **June 13th 2024**
+ NOTE: This version **MUST** be implemented by **May 13th 2024**
Obsolete versions: [v1](includes/obsolete/get-metrics-v1.html) [v2](includes/obsolete/get-metrics-v2.html).
Deprecated versions:
- - [v3](includes/obsolete/get-metrics-v3.html)
- - [v4](includes/obsolete/get-metrics-v4.html) - This version, or v5, must be implemented by **November 1st 2023**
+ - [v3](includes/obsolete/get-metrics-v3.html) - Implementation not required for Data Holders going live on, or after, 1st November 2023. Other Data Holders **MAY** retire this version from the earlier of **13th May 2023** or from the time ACCC announce that they no longer call this version
+ - [v4](includes/obsolete/get-metrics-v4.html) - This version, or v5, **MUST** be implemented by **November 1st 2023**
If the Data Holder supports private_key_jwt client authentication they MUST validate the scope.
operationId: getMetrics
diff --git a/docs/index.html b/docs/index.html
index a7f5ec90..100da1e1 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1443,6 +1443,14 @@ Future Dated Obligations
The table below highlights these areas of the standards.
+Added the retirement details for Get Metrics v3
+
+Corrected the obligation date for Get Metrics v5
+
+Replaced the term `obsolete` with `retire` to clarify the
+intent of these statements
+
+
Section
@@ -1452,17 +1460,17 @@ Future Dated Obligations
Get Account Detail V1
-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
+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
-Data holders MAY obsolete version 3 of this end point from February 28th 2023. Data recipients MUST upgrade their implementations to use version 4 by this time
+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
-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
+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
@@ -1502,32 +1510,32 @@ Future Dated Obligations
Get Generic Plan Detail V2
-Data Holders MUST implement v2 of this endpoint by November 1st 2023 Data Holders MAY obsolete v1 of this endpoint from September 9th 2024
+Data Holders MUST implement v2 of this endpoint by November 1st 2023 Data Holders MAY retire v1 of this endpoint from September 9th 2024
November 1st 2023
Get Energy Account Detail V3
-Data Holders MUST implement v3 of this endpoint by November 1st 2023 Data Holders MAY obsolete v2 of this endpoint from September 9th 2024
+Data Holders MUST implement v3 of this endpoint by November 1st 2023 Data Holders MAY retire v2 of this endpoint from September 9th 2024
November 1st 2023
Get Billing For Account V2
-Data Holders MUST implement v2 of this endpoint by November 1st 2023 Data Holders MAY obsolete v1 of this endpoint from September 9th 2024
+Data Holders MUST implement v2 of this endpoint by November 1st 2023 Data Holders MAY retire v1 of this endpoint from September 9th 2024
November 1st 2023
Get Bulk Billing V2
-Data Holders MUST implement v2 of this endpoint by November 1st 2023 Data Holders MAY obsolete v1 of this endpoint from September 9th 2024
+Data Holders MUST implement v2 of this endpoint by November 1st 2023 Data Holders MAY retire v1 of this endpoint from September 9th 2024
November 1st 2023
Get Billing For Specific Accounts V2
-Data Holders MUST implement v2 of this endpoint by November 1st 2023 Data Holders MAY obsolete v1 of this endpoint from September 9th 2024
+Data Holders MUST implement v2 of this endpoint by November 1st 2023 Data Holders MAY retire v1 of this endpoint from September 9th 2024
November 1st 2023
Get Metrics V4
-Data Holders MUST implement v4 or V5 of this endpoint by November 1st 2023 Data Holders MAY deprecate v4 of this endpoint once V5 is implemented**
+Data Holders MUST implement v4 or V5 of this endpoint by November 1st 2023 Data Holders MAY retire v4 of this endpoint once V5 is implemented
November 1st 2023
@@ -1547,23 +1555,28 @@ Future Dated Obligations
Get Scheduled Payments for Account V2
-Data Holders MUST implement v2 of this endpoint by March 11th 2024 Data Holders MAY obsolete v1 of this endpoint from September 9th 2024
+Data Holders MUST implement v2 of this endpoint by March 11th 2024 Data Holders MAY retire v1 of this endpoint from September 9th 2024
March 11th 2024
Get Scheduled Payments Bulk V2
-Data Holders MUST implement v2 of this endpoint by March 11th 2024 Data Holders MAY obsolete v1 of this endpoint from September 9th 2024
+Data Holders MUST implement v2 of this endpoint by March 11th 2024 Data Holders MAY retire v1 of this endpoint from September 9th 2024
March 11th 2024
Get Scheduled Payments For Specific Accounts V2
-Data Holders MUST implement v2 of this endpoint by March 11th 2024 Data Holders MAY obsolete v1 of this endpoint from September 9th 2024
+Data Holders MUST implement v2 of this endpoint by March 11th 2024 Data Holders MAY retire v1 of this endpoint from September 9th 2024
March 11th 2024
+Get Metrics V3
+Data Holders MAY retire v3 of this endpoint by the earlier of 13th May 2024 or when the ACCC announce that this version is no longer being called Data Holders going live on, or after, 1st November 2023 are not required to support this version
+May 13th 2024
+
+
Get Metrics V5
-Data Holders MUST implement V5 of this endpoint by June 13th 2024 Data Holders MAY deprecate v4 of this endpoint once V5 is implemented**
-June 13th 2024
+Data Holders MUST implement v5 of this endpoint by May 13th 2024 Data Holders MAY deprecate v4 of this endpoint once V5 is implemented
+May 13th 2024
@@ -46058,7 +46071,11 @@ Admin APIs
Admin OpenAPI Specification (JSON)
Admin OpenAPI Specification (YAML)
+Modified the retirement date, and implementation requirements,
+for get Metrics v3
+Corrected the obligation date for Get Metrics v3
+
@@ -46264,15 +46281,15 @@ Get Metrics
This end point is not required to be implemented by the Australian Energy Market Operator, the Australian Energy Regulator or the Department of State administered by the Minister of Victoria administering the National Electricity (Victoria) Act 2005 (Vic).
-NOTE: This version must be implemented by June 13th 2024
+NOTE: This version MUST be implemented by May 13th 2024
Obsolete versions: v1 v2 .
Deprecated versions:
-v3
-v4 - This version, or v5, must be implemented by November 1st 2023
+v3 - Implementation not required for Data Holders going live on, or after, 1st November 2023. Other Data Holders MAY retire this version from the earlier of 13th May 2023 or from the time ACCC announce that they no longer call this version
+v4 - This version, or v5, MUST be implemented by November 1st 2023
If the Data Holder supports private_key_jwt client authentication they MUST validate the scope.
diff --git a/slate/source/includes/_admin.md.erb b/slate/source/includes/_admin.md.erb
index 5b6e6560..96650b37 100644
--- a/slate/source/includes/_admin.md.erb
+++ b/slate/source/includes/_admin.md.erb
@@ -9,4 +9,11 @@ This provides an overview of CDS Administration Endpoints. Please note this API
Admin OpenAPI Specification (YAML)
+```diff
+Modified the retirement date, and implementation requirements,
+for get Metrics v3
+
+Corrected the obligation date for Get Metrics v3
+```
+
<%= partial "includes/cds_admin.md" %>
diff --git a/slate/source/includes/cds_admin.md b/slate/source/includes/cds_admin.md
index eea960a2..adf6ae4a 100644
--- a/slate/source/includes/cds_admin.md
+++ b/slate/source/includes/cds_admin.md
@@ -145,14 +145,14 @@ This end point allows the ACCC to obtain operational statistics from the Data Ho
This end point is not required to be implemented by the Australian Energy Market Operator, the Australian Energy Regulator or the Department of State administered by the Minister of Victoria administering the National Electricity (Victoria) Act 2005 (Vic).
-NOTE: This version must be implemented by **June 13th 2024**
+NOTE: This version **MUST** be implemented by **May 13th 2024**
Obsolete versions: [v1](includes/obsolete/get-metrics-v1.html) [v2](includes/obsolete/get-metrics-v2.html).
Deprecated versions:
-- [v3](includes/obsolete/get-metrics-v3.html)
-- [v4](includes/obsolete/get-metrics-v4.html) - This version, or v5, must be implemented by **November 1st 2023**
+- [v3](includes/obsolete/get-metrics-v3.html) - Implementation not required for Data Holders going live on, or after, 1st November 2023. Other Data Holders **MAY** retire this version from the earlier of **13th May 2023** or from the time ACCC announce that they no longer call this version
+- [v4](includes/obsolete/get-metrics-v4.html) - This version, or v5, **MUST** be implemented by **November 1st 2023**
If the Data Holder supports private_key_jwt client authentication they MUST validate the scope.
diff --git a/slate/source/includes/endpoint-version-schedule/includes/_common-dh.md b/slate/source/includes/endpoint-version-schedule/includes/_common-dh.md
index 97d52cd6..d1bd92ac 100644
--- a/slate/source/includes/endpoint-version-schedule/includes/_common-dh.md
+++ b/slate/source/includes/endpoint-version-schedule/includes/_common-dh.md
@@ -23,6 +23,11 @@
| Admin APIs | Metadata Update | ``/admin/register/metadata`` | POST | V1 | 2020-07-01 | N/A | 2019-09-30, V1.0.0 | N/A |
| Admin APIs | Get Metrics | ``/admin/metrics`` | GET | V1 | 2020-07-01 | 2021-10-31 | 2019-09-30, V1.0.0 | 2021-04-29, V1.9.0 |
| Admin APIs | Get Metrics | ``/admin/metrics`` | GET | V2 | 2021-07-31 | 2022-12-05 | 2020-09-16, V1.5.0 | 2021-10-06, V1.12.0 |
-| Admin APIs | Get Metrics | ``/admin/metrics`` | GET | V3 | 2022-10-01 | N/A | 2021-10-06, V1.12.0 | N/A |
-| Admin APIs | Get Metrics | ``/admin/metrics`` | GET | V4 | 2023-11-01 | When v5 Implemented | 2023-07-08, V1.25.0 | N/A |
-| Admin APIs | Get Metrics | ``/admin/metrics`` | GET | V5 | 2024-06-13 | N/A | 2023-07-08, V1.25.0 | N/A |
+| Admin APIs | Get Metrics | ``/admin/metrics`` | GET | V3 | 2022-10-01 | 2024-05-13 **†** | 2021-10-06, V1.12.0 | 2023-07-08, V1.25.0 |
+| Admin APIs | Get Metrics | ``/admin/metrics`` | GET | V4 | 2023-11-01 | When v5 Implemented | 2023-07-08, V1.25.0 | 2023-07-08, V1.25.0 |
+| Admin APIs | Get Metrics | ``/admin/metrics`` | GET | V5 | 2024-05-13 | N/A | 2023-07-08, V1.25.0 | N/A |
+
+**†NOTE:** the details of the retirement date for Get Metrics v3 is as follows:
+
+* Implementation of Get Metrics v3 is not required for Data Holders going live on, or after, 1st November 2023
+* Other Data Holders **MAY** retire this version from the earlier of **13th May 2023** or from the time ACCC announce that they no longer call this version
diff --git a/slate/source/includes/introduction/_fdo.md b/slate/source/includes/introduction/_fdo.md
index caec1bca..1284e3cd 100644
--- a/slate/source/includes/introduction/_fdo.md
+++ b/slate/source/includes/introduction/_fdo.md
@@ -4,11 +4,20 @@ The standards, as published from time to time, may include specific statements i
The table below highlights these areas of the standards.
+```diff
+Added the retirement details for Get Metrics v3
+
+Corrected the obligation date for Get Metrics v5
+
+Replaced the term `obsolete` with `retire` to clarify the
+intent of these statements
+```
+
|Section|Description|Applicable Date|
|-------|-----------|---------------|
-|[Get Account Detail V1](#get-account-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|
-|[Get Product Detail V3](#get-product-detail)|Data holders **MAY** obsolete 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** 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|
+|[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 |
|[Information Security profile](#security-profile) | FAPI 1.0 adoption is introduced across four phases.Phase 3: Support Authorization Code Flow and Hybrid Flow includes, amongst other changes:Data Holders **MUST** support Authorization Code Flow Data Holders **MUST** support Hybrid Flow | April 14th 2023 |
@@ -16,16 +25,17 @@ The table below highlights these areas of the standards.
|[Information Security profile](#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 |
|[Get Accounts V2](#get-accounts)|Version 2 of this end point **MUST** be made available by affected data holders by July 10th 2023|July 10th 2023|
|[Get Account Detail V3](#get-account-detail)|Version 3 of this end point **MUST** be made available by affected data holders by July 10th 2023|July 10th 2023|
-|[Get Generic Plan Detail V2](#get-generic-plan-detail)|Data Holders **MUST** implement v2 of this endpoint by **November 1st 2023** Data Holders **MAY** obsolete v1 of this endpoint from **September 9th 2024** | November 1st 2023 |
-|[Get Energy Account Detail V3](#get-account-detail)|Data Holders **MUST** implement v3 of this endpoint by **November 1st 2023** Data Holders **MAY** obsolete v2 of this endpoint from **September 9th 2024** | November 1st 2023 |
-|[Get Billing For Account V2](#get-billing-for-account)|Data Holders **MUST** implement v2 of this endpoint by **November 1st 2023** Data Holders **MAY** obsolete v1 of this endpoint from **September 9th 2024** | November 1st 2023 |
-|[Get Bulk Billing V2](#get-bulk-billing)|Data Holders **MUST** implement v2 of this endpoint by **November 1st 2023** Data Holders **MAY** obsolete v1 of this endpoint from **September 9th 2024** | November 1st 2023 |
-|[Get Billing For Specific Accounts V2](#get-billing-for-specific-accounts)|Data Holders **MUST** implement v2 of this endpoint by **November 1st 2023** Data Holders **MAY** obsolete v1 of this endpoint from **September 9th 2024** | November 1st 2023 |
-|[Get Metrics V4](#get-metrics)|Data Holders **MUST** implement v4 or V5 of this endpoint by **November 1st 2023** Data Holders **MAY** deprecate v4 of this endpoint once V5 is implemented** | November 1st 2023 |
+|[Get Generic Plan Detail V2](#get-generic-plan-detail)|Data Holders **MUST** implement v2 of this endpoint by **November 1st 2023** Data Holders **MAY** retire v1 of this endpoint from **September 9th 2024** | November 1st 2023 |
+|[Get Energy Account Detail V3](#get-account-detail)|Data Holders **MUST** implement v3 of this endpoint by **November 1st 2023** Data Holders **MAY** retire v2 of this endpoint from **September 9th 2024** | November 1st 2023 |
+|[Get Billing For Account V2](#get-billing-for-account)|Data Holders **MUST** implement v2 of this endpoint by **November 1st 2023** Data Holders **MAY** retire v1 of this endpoint from **September 9th 2024** | November 1st 2023 |
+|[Get Bulk Billing V2](#get-bulk-billing)|Data Holders **MUST** implement v2 of this endpoint by **November 1st 2023** Data Holders **MAY** retire v1 of this endpoint from **September 9th 2024** | November 1st 2023 |
+|[Get Billing For Specific Accounts V2](#get-billing-for-specific-accounts)|Data Holders **MUST** implement v2 of this endpoint by **November 1st 2023** Data Holders **MAY** retire v1 of this endpoint from **September 9th 2024** | November 1st 2023 |
+|[Get Metrics V4](#get-metrics)|Data Holders **MUST** implement v4 or V5 of this endpoint by **November 1st 2023** Data Holders **MAY** retire v4 of this endpoint once V5 is implemented | November 1st 2023 |
|[Private Key JWT Client Authentication](https://consumerdatastandardsaustralia.github.io/standards/?examples#client-authentication) | Change to support [**[RFC7521]**](#nref-RFC7521) such that, until November 13th 2023, clients authenticating using Private Key JWT are _recommended_ to provide the `client_id`, but no longer required. From November 13th 2023, it is then _optional_ to provide the `client_id`. This applies to ADRs and the CDR Register authenticating with Data Holders and ADRs authenticating with the CDR Register. | November 13th 2023 |
|[Get Accounts V1](#get-account-detail)|Data Holders **MAY** decommission v1 of this end point from March 11th 2024| March 11th 2024 |
|[Get Account Detail V2](#get-account-detail)|Data Holders **MAY** decommission v2 of this end point from March 11th 2024| March 11th 2024 |
-|[Get Scheduled Payments for Account V2](#get-scheduled-payments-for-account)|Data Holders **MUST** implement v2 of this endpoint by **March 11th 2024** Data Holders **MAY** obsolete v1 of this endpoint from **September 9th 2024** | March 11th 2024 |
-|[Get Scheduled Payments Bulk V2](#get-scheduled-payments-bulk)|Data Holders **MUST** implement v2 of this endpoint by **March 11th 2024** Data Holders **MAY** obsolete v1 of this endpoint from **September 9th 2024** | March 11th 2024 |
-|[Get Scheduled Payments For Specific Accounts V2](#get-scheduled-payments-for-specific-accounts)|Data Holders **MUST** implement v2 of this endpoint by **March 11th 2024** Data Holders **MAY** obsolete v1 of this endpoint from **September 9th 2024** | March 11th 2024 |
-|[Get Metrics V5](#get-metrics)|Data Holders **MUST** implement V5 of this endpoint by **June 13th 2024** Data Holders **MAY** deprecate v4 of this endpoint once V5 is implemented** | June 13th 2024 |
+|[Get Scheduled Payments for Account V2](#get-scheduled-payments-for-account)|Data Holders **MUST** implement v2 of this endpoint by **March 11th 2024** Data Holders **MAY** retire v1 of this endpoint from **September 9th 2024** | March 11th 2024 |
+|[Get Scheduled Payments Bulk V2](#get-scheduled-payments-bulk)|Data Holders **MUST** implement v2 of this endpoint by **March 11th 2024** Data Holders **MAY** retire v1 of this endpoint from **September 9th 2024** | March 11th 2024 |
+|[Get Scheduled Payments For Specific Accounts V2](#get-scheduled-payments-for-specific-accounts)|Data Holders **MUST** implement v2 of this endpoint by **March 11th 2024** Data Holders **MAY** retire v1 of this endpoint from **September 9th 2024** | March 11th 2024 |
+|[Get Metrics V3](#get-metrics)|Data Holders **MAY** retire v3 of this endpoint by the earlier of **13th May 2024** or when the ACCC announce that this version is no longer being called Data Holders going live on, or after, 1st November 2023 are not required to support this version | May 13th 2024 |
+|[Get Metrics V5](#get-metrics)|Data Holders **MUST** implement v5 of this endpoint by **May 13th 2024** Data Holders **MAY** deprecate v4 of this endpoint once V5 is implemented | May 13th 2024 |
diff --git a/slate/source/includes/obsolete/get-metrics-v3.html.md b/slate/source/includes/obsolete/get-metrics-v3.html.md
index a91ffa9a..9d799abf 100644
--- a/slate/source/includes/obsolete/get-metrics-v3.html.md
+++ b/slate/source/includes/obsolete/get-metrics-v3.html.md
@@ -13,7 +13,9 @@ search: false
# Get Metrics V3
This page documents the deprecated version 3 of the Get Metrics end point.
-This version does not yet have an obsolescence date and must continue to be supported by data holders.
+Support for this version is not required for Data Holders going live on, or after, 1st November 2023.
+
+Other Data Holders **MAY** retire this version from the earlier of **13th May 2023** or from the time ACCC announce that they no longer call this version.
## Get Metrics
diff --git a/slate/source/includes/obsolete/get-metrics-v4.html.md b/slate/source/includes/obsolete/get-metrics-v4.html.md
index f7cefb26..67b6bd81 100644
--- a/slate/source/includes/obsolete/get-metrics-v4.html.md
+++ b/slate/source/includes/obsolete/get-metrics-v4.html.md
@@ -13,7 +13,7 @@ search: false
# Get Metrics V4
This page documents the deprecated version 4 of the Get Metrics end point.
-This version must be implemented by **November 1st 2023** and may be obsoleted once v5 has been implemented
+This version **MUST** be implemented by **November 1st 2023** and **MAY** be retured once v5 has been implemented
## Get Metrics
diff --git a/slate/source/includes/releasenotes/releasenotes.1.26.0.html.md b/slate/source/includes/releasenotes/releasenotes.1.26.0.html.md
index fc8579a8..10b2b9df 100644
--- a/slate/source/includes/releasenotes/releasenotes.1.26.0.html.md
+++ b/slate/source/includes/releasenotes/releasenotes.1.26.0.html.md
@@ -41,8 +41,7 @@ No Change
|Change|Description|Link|
|------|-----------|----|
-
-TBD
+| Modified Get Metrics Obligations | Changes to the obligation dates for Get Metrics v3 as determined in [Decision 322](https://github.com/ConsumerDataStandardsAustralia/standards/issues/322) | [Admin APIs](../../#admin-apis) |
## Information Security Profile
diff --git a/slate/source/includes/swagger/cds_admin.json b/slate/source/includes/swagger/cds_admin.json
index d10d2d04..d3b4f529 100644
--- a/slate/source/includes/swagger/cds_admin.json
+++ b/slate/source/includes/swagger/cds_admin.json
@@ -103,7 +103,7 @@
},
"/admin/metrics" : {
"get" : {
- "description" : "This end point allows the ACCC to obtain operational statistics from the Data Holder (at the Data Holder Brand level) on the operation of their CDR compliant implementation. The statistics obtainable from this end point are determined by the non-functional requirements for the CDR regime.\n\nThis end point is not required to be implemented by the Australian Energy Market Operator, the Australian Energy Regulator or the Department of State administered by the Minister of Victoria administering the National Electricity (Victoria) Act 2005 (Vic).\n\nNOTE: This version must be implemented by **June 13th 2024**\n\nObsolete versions: [v1](includes/obsolete/get-metrics-v1.html) [v2](includes/obsolete/get-metrics-v2.html).\n\nDeprecated versions:\n\n- [v3](includes/obsolete/get-metrics-v3.html)\n- [v4](includes/obsolete/get-metrics-v4.html) - This version, or v5, must be implemented by **November 1st 2023**\n\nIf the Data Holder supports private_key_jwt client authentication they MUST validate the scope.",
+ "description" : "This end point allows the ACCC to obtain operational statistics from the Data Holder (at the Data Holder Brand level) on the operation of their CDR compliant implementation. The statistics obtainable from this end point are determined by the non-functional requirements for the CDR regime.\n\nThis end point is not required to be implemented by the Australian Energy Market Operator, the Australian Energy Regulator or the Department of State administered by the Minister of Victoria administering the National Electricity (Victoria) Act 2005 (Vic).\n\nNOTE: This version **MUST** be implemented by **May 13th 2024**\n\nObsolete versions: [v1](includes/obsolete/get-metrics-v1.html) [v2](includes/obsolete/get-metrics-v2.html).\n\nDeprecated versions:\n\n- [v3](includes/obsolete/get-metrics-v3.html) - Implementation not required for Data Holders going live on, or after, 1st November 2023. Other Data Holders **MAY** retire this version from the earlier of **13th May 2023** or from the time ACCC announce that they no longer call this version\n- [v4](includes/obsolete/get-metrics-v4.html) - This version, or v5, **MUST** be implemented by **November 1st 2023**\n\nIf the Data Holder supports private_key_jwt client authentication they MUST validate the scope.",
"operationId" : "getMetrics",
"parameters" : [ {
"description" : "The period of metrics to be requested. Values can be CURRENT (meaning metrics for current period, dependent on the metric type), HISTORIC (meaning metrics for previous period, depending on the metric type) or ALL. If absent the default is ALL.",
diff --git a/slate/source/includes/swagger/cds_admin.yaml b/slate/source/includes/swagger/cds_admin.yaml
index 6372df99..4d9c5e2b 100644
--- a/slate/source/includes/swagger/cds_admin.yaml
+++ b/slate/source/includes/swagger/cds_admin.yaml
@@ -99,14 +99,14 @@ paths:
This end point is not required to be implemented by the Australian Energy Market Operator, the Australian Energy Regulator or the Department of State administered by the Minister of Victoria administering the National Electricity (Victoria) Act 2005 (Vic).
- NOTE: This version must be implemented by **June 13th 2024**
+ NOTE: This version **MUST** be implemented by **May 13th 2024**
Obsolete versions: [v1](includes/obsolete/get-metrics-v1.html) [v2](includes/obsolete/get-metrics-v2.html).
Deprecated versions:
- - [v3](includes/obsolete/get-metrics-v3.html)
- - [v4](includes/obsolete/get-metrics-v4.html) - This version, or v5, must be implemented by **November 1st 2023**
+ - [v3](includes/obsolete/get-metrics-v3.html) - Implementation not required for Data Holders going live on, or after, 1st November 2023. Other Data Holders **MAY** retire this version from the earlier of **13th May 2023** or from the time ACCC announce that they no longer call this version
+ - [v4](includes/obsolete/get-metrics-v4.html) - This version, or v5, **MUST** be implemented by **November 1st 2023**
If the Data Holder supports private_key_jwt client authentication they MUST validate the scope.
operationId: getMetrics
diff --git a/swagger-gen/api/cds_admin.json b/swagger-gen/api/cds_admin.json
index bf0a1d0c..1d9caf7f 100644
--- a/swagger-gen/api/cds_admin.json
+++ b/swagger-gen/api/cds_admin.json
@@ -111,7 +111,7 @@
"Metrics"
],
"summary": "Get Metrics",
- "description": "This end point allows the ACCC to obtain operational statistics from the Data Holder (at the Data Holder Brand level) on the operation of their CDR compliant implementation. The statistics obtainable from this end point are determined by the non-functional requirements for the CDR regime.\n\nThis end point is not required to be implemented by the Australian Energy Market Operator, the Australian Energy Regulator or the Department of State administered by the Minister of Victoria administering the National Electricity (Victoria) Act 2005 (Vic).\n\nNOTE: This version must be implemented by **June 13th 2024**\n\nObsolete versions: [v1](includes/obsolete/get-metrics-v1.html) [v2](includes/obsolete/get-metrics-v2.html).\n\nDeprecated versions:\n\n- [v3](includes/obsolete/get-metrics-v3.html)\n- [v4](includes/obsolete/get-metrics-v4.html) - This version, or v5, must be implemented by **November 1st 2023**\n\nIf the Data Holder supports private_key_jwt client authentication they MUST validate the scope.",
+ "description": "This end point allows the ACCC to obtain operational statistics from the Data Holder (at the Data Holder Brand level) on the operation of their CDR compliant implementation. The statistics obtainable from this end point are determined by the non-functional requirements for the CDR regime.\n\nThis end point is not required to be implemented by the Australian Energy Market Operator, the Australian Energy Regulator or the Department of State administered by the Minister of Victoria administering the National Electricity (Victoria) Act 2005 (Vic).\n\nNOTE: This version **MUST** be implemented by **May 13th 2024**\n\nObsolete versions: [v1](includes/obsolete/get-metrics-v1.html) [v2](includes/obsolete/get-metrics-v2.html).\n\nDeprecated versions:\n\n- [v3](includes/obsolete/get-metrics-v3.html) - Implementation not required for Data Holders going live on, or after, 1st November 2023. Other Data Holders **MAY** retire this version from the earlier of **13th May 2023** or from the time ACCC announce that they no longer call this version\n- [v4](includes/obsolete/get-metrics-v4.html) - This version, or v5, **MUST** be implemented by **November 1st 2023**\n\nIf the Data Holder supports private_key_jwt client authentication they MUST validate the scope.",
"operationId": "getMetrics",
"parameters": [
{
diff --git a/swagger-gen/cds_admin.md b/swagger-gen/cds_admin.md
index eea960a2..adf6ae4a 100644
--- a/swagger-gen/cds_admin.md
+++ b/swagger-gen/cds_admin.md
@@ -145,14 +145,14 @@ This end point allows the ACCC to obtain operational statistics from the Data Ho
This end point is not required to be implemented by the Australian Energy Market Operator, the Australian Energy Regulator or the Department of State administered by the Minister of Victoria administering the National Electricity (Victoria) Act 2005 (Vic).
-NOTE: This version must be implemented by **June 13th 2024**
+NOTE: This version **MUST** be implemented by **May 13th 2024**
Obsolete versions: [v1](includes/obsolete/get-metrics-v1.html) [v2](includes/obsolete/get-metrics-v2.html).
Deprecated versions:
-- [v3](includes/obsolete/get-metrics-v3.html)
-- [v4](includes/obsolete/get-metrics-v4.html) - This version, or v5, must be implemented by **November 1st 2023**
+- [v3](includes/obsolete/get-metrics-v3.html) - Implementation not required for Data Holders going live on, or after, 1st November 2023. Other Data Holders **MAY** retire this version from the earlier of **13th May 2023** or from the time ACCC announce that they no longer call this version
+- [v4](includes/obsolete/get-metrics-v4.html) - This version, or v5, **MUST** be implemented by **November 1st 2023**
If the Data Holder supports private_key_jwt client authentication they MUST validate the scope.