Release notes

Add details of DP322

docs/includes/cds_admin

@@ -192,15 +192,15 @@ This operation may only be called by the CDR Register
 
 <p>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).</p>
 
-<p>NOTE: This version must be implemented by <strong>June 13th 2024</strong></p>
+<p>NOTE: This version <strong>MUST</strong> be implemented by <strong>May 13th 2024</strong></p>
 
 <p>Obsolete versions: <a href="includes/obsolete/get-metrics-v1.html">v1</a> <a href="includes/obsolete/get-metrics-v2.html">v2</a>.</p>
 
 <p>Deprecated versions:</p>
 
 <ul>
-<li><a href="includes/obsolete/get-metrics-v3.html">v3</a></li>
-<li><a href="includes/obsolete/get-metrics-v4.html">v4</a> - This version, or v5, must be implemented by <strong>November 1st 2023</strong></li>
+<li><a href="includes/obsolete/get-metrics-v3.html">v3</a> - Implementation not required for Data Holders going live on, or after, 1st November 2023.  Other Data Holders <strong>MAY</strong> retire this version from the earlier of <strong>13th May 2023</strong> or from the time ACCC announce that they no longer call this version</li>
+<li><a href="includes/obsolete/get-metrics-v4.html">v4</a> - This version, or v5, <strong>MUST</strong> be implemented by <strong>November 1st 2023</strong></li>
 </ul>
 
 <p>If the Data Holder supports private_key_jwt client authentication they MUST validate the scope.</p>

docs/includes/endpoint-version-schedule/index.html

@@ -1294,9 +1294,9 @@ <h2 id='admin-apis'>Admin APIs</h2>
 <td><span class="method get">GET</span></td>
 <td>V3</td>
 <td>2022-10-01</td>
-<td>N/A</td>
+<td>2024-05-13 <strong>&dagger;</strong></td>
 <td>2021-10-06, V1.12.0</td>
-<td>N/A</td>
+<td>2023-07-08, V1.25.0</td>
 </tr>
 <tr>
 <td>Admin APIs</td>
@@ -1307,20 +1307,27 @@ <h2 id='admin-apis'>Admin APIs</h2>
 <td>2023-11-01</td>
 <td>When v5 Implemented</td>
 <td>2023-07-08, V1.25.0</td>
-<td>N/A</td>
+<td>2023-07-08, V1.25.0</td>
 </tr>
 <tr>
 <td>Admin APIs</td>
 <td>Get Metrics</td>
 <td><code>/admin/metrics</code></td>
 <td><span class="method get">GET</span></td>
 <td>V5</td>
-<td>2024-06-13</td>
+<td>2024-05-13</td>
 <td>N/A</td>
 <td>2023-07-08, V1.25.0</td>
 <td>N/A</td>
 </tr>
 </tbody></table>
+
+<p><strong>&dagger;NOTE:</strong> the details of the retirement date for Get Metrics v3 is as follows:</p>
+
+<ul>
+<li>Implementation of Get Metrics v3 is not required for Data Holders going live on, or after, 1st November 2023</li>
+<li>Other Data Holders <strong>MAY</strong> retire this version from the earlier of <strong>13th May 2023</strong> or from the time ACCC announce that they no longer call this version</li>
+</ul>
 <h1 id='register-apis'>Register APIs</h1>
 <aside class="warning">
   These endpoints are not implemented by Data Holders and Data Recipients. They are hosted by the Register for consumption by participants.

docs/includes/obsolete/get-metrics-v3.html

@@ -282,7 +282,9 @@
         <h1 id='get-metrics-v3'>Get Metrics V3</h1>
 <p>This page documents the deprecated version 3 of the Get Metrics end point.</p>
 
-<p>This version does not yet have an obsolescence date and must continue to be supported by data holders.</p>
+<p>Support for this version is not required for Data Holders going live on, or after, 1st November 2023.</p>
+
+<p>Other Data Holders <strong>MAY</strong> retire this version from the earlier of <strong>13th May 2023</strong> or from the time ACCC announce that they no longer call this version.</p>
 <h2 id='get-metrics'>Get Metrics</h2>
 <p><a id="opIdgetMetrics"></a></p>
 

docs/includes/obsolete/get-metrics-v4.html

@@ -285,7 +285,7 @@
         <h1 id='get-metrics-v4'>Get Metrics V4</h1>
 <p>This page documents the deprecated version 4 of the Get Metrics end point.</p>
 
-<p>This version must be implemented by <strong>November 1st 2023</strong> and may be obsoleted once v5 has been implemented</p>
+<p>This version <strong>MUST</strong> be implemented by <strong>November 1st 2023</strong> and <strong>MAY</strong> be retured once v5 has been implemented</p>
 <h2 id='get-metrics'>Get Metrics</h2>
 <p><a id="opIdgetMetrics"></a></p>
 

docs/includes/releasenotes/releasenotes.1.26.0.html

@@ -283,9 +283,12 @@ <h2 id='api-end-points'>API End Points</h2>
 <th>Link</th>
 </tr>
 </thead><tbody>
+<tr>
+<td>Modified Get Metrics Obligations</td>
+<td>Changes to the obligation dates for Get Metrics v3 as determined in <a href="https://github.com/ConsumerDataStandardsAustralia/standards/issues/322">Decision 322</a></td>
+<td><a href="../../#admin-apis">Admin APIs</a></td>
+</tr>
 </tbody></table>
-
-<p>TBD</p>
 <h2 id='information-security-profile'>Information Security Profile</h2>
 <p>No Change</p>
 <h2 id='register-standards'>Register Standards</h2>

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.",

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

docs/index.html

@@ -1443,6 +1443,14 @@ <h2 id='future-dated-obligations'>Future Dated Obligations</h2>
 
 <p>The table below highlights these areas of the standards.</p>
 
+<pre class="highlight diff tab-diff"><code>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
+</code></pre>
+
 <table><thead>
 <tr>
 <th>Section</th>
@@ -1452,17 +1460,17 @@ <h2 id='future-dated-obligations'>Future Dated Obligations</h2>
 </thead><tbody>
 <tr>
 <td><a href="#get-account-detail">Get Account Detail V1</a></td>
-<td>Data holders <strong>MAY</strong> obsolete version 1 of this end point from February 28th 2023.  Data recipients <strong>MUST</strong> upgrade their implementations to use version 2 by this time</td>
+<td>Data holders <strong>MAY</strong> retire version 1 of this end point from February 28th 2023.  Data recipients <strong>MUST</strong> upgrade their implementations to use version 2 by this time</td>
 <td>February 28th 2023</td>
 </tr>
 <tr>
 <td><a href="#get-product-detail">Get Product Detail V3</a></td>
-<td>Data holders <strong>MAY</strong> obsolete version 3 of this end point from February 28th 2023.  Data recipients <strong>MUST</strong> upgrade their implementations to use version 4 by this time</td>
+<td>Data holders <strong>MAY</strong> retire version 3 of this end point from February 28th 2023.  Data recipients <strong>MUST</strong> upgrade their implementations to use version 4 by this time</td>
 <td>February 28th 2023</td>
 </tr>
 <tr>
 <td><a href="#get-customer-detail">Get Customer Detail V1</a></td>
-<td>Data holders <strong>MAY</strong> obsolete version 1 of this end point from February 28th 2023.  Data recipients <strong>MUST</strong> upgrade their implementations to use version 2 by this time</td>
+<td>Data holders <strong>MAY</strong> retire version 1 of this end point from February 28th 2023.  Data recipients <strong>MUST</strong> upgrade their implementations to use version 2 by this time</td>
 <td>February 28th 2023</td>
 </tr>
 <tr>
@@ -1502,32 +1510,32 @@ <h2 id='future-dated-obligations'>Future Dated Obligations</h2>
 </tr>
 <tr>
 <td><a href="#get-generic-plan-detail">Get Generic Plan Detail V2</a></td>
-<td><ul><li>Data Holders <strong>MUST</strong> implement v2 of this endpoint by <strong>November 1st 2023</strong></li><li>Data Holders <strong>MAY</strong> obsolete v1 of this endpoint from <strong>September 9th 2024</strong></li></ul></td>
+<td><ul><li>Data Holders <strong>MUST</strong> implement v2 of this endpoint by <strong>November 1st 2023</strong></li><li>Data Holders <strong>MAY</strong> retire v1 of this endpoint from <strong>September 9th 2024</strong></li></ul></td>
 <td>November 1st 2023</td>
 </tr>
 <tr>
 <td><a href="#get-account-detail">Get Energy Account Detail V3</a></td>
-<td><ul><li>Data Holders <strong>MUST</strong> implement v3 of this endpoint by <strong>November 1st 2023</strong></li><li>Data Holders <strong>MAY</strong> obsolete v2 of this endpoint from <strong>September 9th 2024</strong></li></ul></td>
+<td><ul><li>Data Holders <strong>MUST</strong> implement v3 of this endpoint by <strong>November 1st 2023</strong></li><li>Data Holders <strong>MAY</strong> retire v2 of this endpoint from <strong>September 9th 2024</strong></li></ul></td>
 <td>November 1st 2023</td>
 </tr>
 <tr>
 <td><a href="#get-billing-for-account">Get Billing For Account V2</a></td>
-<td><ul><li>Data Holders <strong>MUST</strong> implement v2 of this endpoint by <strong>November 1st 2023</strong></li><li>Data Holders <strong>MAY</strong> obsolete v1 of this endpoint from <strong>September 9th 2024</strong></li></ul></td>
+<td><ul><li>Data Holders <strong>MUST</strong> implement v2 of this endpoint by <strong>November 1st 2023</strong></li><li>Data Holders <strong>MAY</strong> retire v1 of this endpoint from <strong>September 9th 2024</strong></li></ul></td>
 <td>November 1st 2023</td>
 </tr>
 <tr>
 <td><a href="#get-bulk-billing">Get Bulk Billing V2</a></td>
-<td><ul><li>Data Holders <strong>MUST</strong> implement v2 of this endpoint by <strong>November 1st 2023</strong></li><li>Data Holders <strong>MAY</strong> obsolete v1 of this endpoint from <strong>September 9th 2024</strong></li></ul></td>
+<td><ul><li>Data Holders <strong>MUST</strong> implement v2 of this endpoint by <strong>November 1st 2023</strong></li><li>Data Holders <strong>MAY</strong> retire v1 of this endpoint from <strong>September 9th 2024</strong></li></ul></td>
 <td>November 1st 2023</td>
 </tr>
 <tr>
 <td><a href="#get-billing-for-specific-accounts">Get Billing For Specific Accounts V2</a></td>
-<td><ul><li>Data Holders <strong>MUST</strong> implement v2 of this endpoint by <strong>November 1st 2023</strong></li><li>Data Holders <strong>MAY</strong> obsolete v1 of this endpoint from <strong>September 9th 2024</strong></li></ul></td>
+<td><ul><li>Data Holders <strong>MUST</strong> implement v2 of this endpoint by <strong>November 1st 2023</strong></li><li>Data Holders <strong>MAY</strong> retire v1 of this endpoint from <strong>September 9th 2024</strong></li></ul></td>
 <td>November 1st 2023</td>
 </tr>
 <tr>
 <td><a href="#get-metrics">Get Metrics V4</a></td>
-<td><ul><li>Data Holders <strong>MUST</strong> implement v4 or V5 of this endpoint by <strong>November 1st 2023</strong></li><li>Data Holders <strong>MAY</strong> deprecate v4 of this endpoint once V5 is implemented**</li></ul></td>
+<td><ul><li>Data Holders <strong>MUST</strong> implement v4 or V5 of this endpoint by <strong>November 1st 2023</strong></li><li>Data Holders <strong>MAY</strong> retire v4 of this endpoint once V5 is implemented</li></ul></td>
 <td>November 1st 2023</td>
 </tr>
 <tr>
@@ -1547,23 +1555,28 @@ <h2 id='future-dated-obligations'>Future Dated Obligations</h2>
 </tr>
 <tr>
 <td><a href="#get-scheduled-payments-for-account">Get Scheduled Payments for Account V2</a></td>
-<td><ul><li>Data Holders <strong>MUST</strong> implement v2 of this endpoint by <strong>March 11th 2024</strong></li><li>Data Holders <strong>MAY</strong> obsolete v1 of this endpoint from <strong>September 9th 2024</strong></li></ul></td>
+<td><ul><li>Data Holders <strong>MUST</strong> implement v2 of this endpoint by <strong>March 11th 2024</strong></li><li>Data Holders <strong>MAY</strong> retire v1 of this endpoint from <strong>September 9th 2024</strong></li></ul></td>
 <td>March 11th 2024</td>
 </tr>
 <tr>
 <td><a href="#get-scheduled-payments-bulk">Get Scheduled Payments Bulk V2</a></td>
-<td><ul><li>Data Holders <strong>MUST</strong> implement v2 of this endpoint by <strong>March 11th 2024</strong></li><li>Data Holders <strong>MAY</strong> obsolete v1 of this endpoint from <strong>September 9th 2024</strong></li></ul></td>
+<td><ul><li>Data Holders <strong>MUST</strong> implement v2 of this endpoint by <strong>March 11th 2024</strong></li><li>Data Holders <strong>MAY</strong> retire v1 of this endpoint from <strong>September 9th 2024</strong></li></ul></td>
 <td>March 11th 2024</td>
 </tr>
 <tr>
 <td><a href="#get-scheduled-payments-for-specific-accounts">Get Scheduled Payments For Specific Accounts V2</a></td>
-<td><ul><li>Data Holders <strong>MUST</strong> implement v2 of this endpoint by <strong>March 11th 2024</strong></li><li>Data Holders <strong>MAY</strong> obsolete v1 of this endpoint from <strong>September 9th 2024</strong></li></ul></td>
+<td><ul><li>Data Holders <strong>MUST</strong> implement v2 of this endpoint by <strong>March 11th 2024</strong></li><li>Data Holders <strong>MAY</strong> retire v1 of this endpoint from <strong>September 9th 2024</strong></li></ul></td>
 <td>March 11th 2024</td>
 </tr>
 <tr>
+<td><a href="#get-metrics">Get Metrics V3</a></td>
+<td><ul><li>Data Holders <strong>MAY</strong> retire v3 of this endpoint by the earlier of <strong>13th May 2024</strong> or when the ACCC announce that this version is no longer being called</li><li>Data Holders going live on, or after, 1st November 2023 are not required to support this version</li></ul></td>
+<td>May 13th 2024</td>
+</tr>
+<tr>
 <td><a href="#get-metrics">Get Metrics V5</a></td>
-<td><ul><li>Data Holders <strong>MUST</strong> implement V5 of this endpoint by <strong>June 13th 2024</strong></li><li>Data Holders <strong>MAY</strong> deprecate v4 of this endpoint once V5 is implemented**</li></ul></td>
-<td>June 13th 2024</td>
+<td><ul><li>Data Holders <strong>MUST</strong> implement v5 of this endpoint by <strong>May 13th 2024</strong></li><li>Data Holders <strong>MAY</strong> deprecate v4 of this endpoint once V5 is implemented</li></ul></td>
+<td>May 13th 2024</td>
 </tr>
 </tbody></table>
 
@@ -46058,7 +46071,11 @@ <h1 id='admin-apis'>Admin APIs</h1>
 <tr><td><a href='./includes/swagger/cds_admin.json'>Admin OpenAPI Specification (JSON)</a></td></tr>
 <tr><td><a href='./includes/swagger/cds_admin.yaml'>Admin OpenAPI Specification (YAML)</a></td></tr>
 </table></p>
+<pre class="highlight diff tab-diff"><code>Modified the retirement date, and implementation requirements,
+for get Metrics v3
 
+Corrected the obligation date for Get Metrics v3
+</code></pre>
 <h2 id='metadata-update'>Metadata Update</h2>
 
 <p><a id="opIdmetadataUpdate"></a></p>
@@ -46264,15 +46281,15 @@ <h2 id='get-metrics'>Get Metrics</h2>
 
 <p>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).</p>
 
-<p>NOTE: This version must be implemented by <strong>June 13th 2024</strong></p>
+<p>NOTE: This version <strong>MUST</strong> be implemented by <strong>May 13th 2024</strong></p>
 
 <p>Obsolete versions: <a href="includes/obsolete/get-metrics-v1.html">v1</a> <a href="includes/obsolete/get-metrics-v2.html">v2</a>.</p>
 
 <p>Deprecated versions:</p>
 
 <ul>
-<li><a href="includes/obsolete/get-metrics-v3.html">v3</a></li>
-<li><a href="includes/obsolete/get-metrics-v4.html">v4</a> - This version, or v5, must be implemented by <strong>November 1st 2023</strong></li>
+<li><a href="includes/obsolete/get-metrics-v3.html">v3</a> - Implementation not required for Data Holders going live on, or after, 1st November 2023.  Other Data Holders <strong>MAY</strong> retire this version from the earlier of <strong>13th May 2023</strong> or from the time ACCC announce that they no longer call this version</li>
+<li><a href="includes/obsolete/get-metrics-v4.html">v4</a> - This version, or v5, <strong>MUST</strong> be implemented by <strong>November 1st 2023</strong></li>
 </ul>
 
 <p>If the Data Holder supports private_key_jwt client authentication they MUST validate the scope.</p>

slate/source/includes/_admin.md.erb

@@ -9,4 +9,11 @@ This provides an overview of CDS Administration Endpoints. Please note this API
 <tr><td><a href='./includes/swagger/cds_admin.yaml'>Admin OpenAPI Specification (YAML)</a></td></tr>
 </table>
 
+```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" %>