Addition of known issue entry for Get Metrics v5

docs/includes/additional/additional20230708-23756-1rgimks → docs/includes/additional/additional20230721-17819-179l1ax

@@ -1,10 +1,13 @@
 <h1 id='additional-standards'>Additional Standards</h1>
 <p>The Consumer Data Standards also incorporate other non-binding standards that are developed to facilitate consultation and feedback or to facilitate voluntary extension of CDR implementations.</p>
 
-<p>These standards fall into three categories:
-1. <code>Candidate</code> standards that are non-binding and stable
-2. <code>Draft</code> standards that are non-binding but volatile as they are under development
-3. <code>Experimental</code> standards that are transient and created to test concepts</p>
+<p>These standards fall into three categories:</p>
+
+<ol>
+<li><code>Candidate</code> standards that are non-binding and stable</li>
+<li><code>Draft</code> standards that are non-binding but volatile as they are under development</li>
+<li><code>Experimental</code> standards that are transient and created to test concepts</li>
+</ol>
 <h2 id='candidate-standards'>Candidate Standards</h2>
 <p>The Consumer Data Standards currently include the following candidate standards:</p>
 

docs/includes/cds_admin

@@ -689,7 +689,7 @@ This operation may only be called by the CDR Register
         </span><span class="p">]</span><span class="w">
       </span><span class="p">},</span><span class="w">
       </span><span class="s2">"abandonmentsByStage"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
-        </span><span class="s2">"abandonedConsentFlowCount"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
+        </span><span class="s2">"preIdentification"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
           </span><span class="s2">"currentDay"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
           </span><span class="s2">"previousDays"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
             </span><span class="mi">0</span><span class="w">
@@ -1263,7 +1263,7 @@ This operation may only be called by the CDR Register
         </span><span class="p">]</span><span class="w">
       </span><span class="p">},</span><span class="w">
       </span><span class="s2">"abandonmentsByStage"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
-        </span><span class="s2">"abandonedConsentFlowCount"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
+        </span><span class="s2">"preIdentification"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
           </span><span class="s2">"currentDay"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
           </span><span class="s2">"previousDays"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
             </span><span class="mi">0</span><span class="w">
@@ -1375,7 +1375,7 @@ This operation may only be called by the CDR Register
 <td>» errors</td>
 <td><a href="#schemacdr-admin-apierrormetricsv2">ErrorMetricsV2</a></td>
 <td>mandatory</td>
-<td>Peak transactions per second over time</td>
+<td>Number of calls resulting in error due to server execution over time</td>
 </tr>
 <tr>
 <td>» rejections</td>
@@ -2519,7 +2519,7 @@ This operation may only be called by the CDR Register
 </span><span class="p">}</span><span class="w">
 
 </span></code></pre>
-<p><em>Peak transactions per second over time</em></p>
+<p><em>Number of calls resulting in error due to server execution over time</em></p>
 <h3 id='properties-10'>Properties</h3>
 <table><thead>
 <tr>
@@ -2842,7 +2842,7 @@ This operation may only be called by the CDR Register
     </span><span class="p">]</span><span class="w">
   </span><span class="p">},</span><span class="w">
   </span><span class="s2">"abandonmentsByStage"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
-    </span><span class="s2">"abandonedConsentFlowCount"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
+    </span><span class="s2">"preIdentification"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
       </span><span class="s2">"currentDay"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
       </span><span class="s2">"previousDays"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
         </span><span class="mi">0</span><span class="w">
@@ -3151,7 +3151,7 @@ This operation may only be called by the CDR Register
 <td>Customer abandonment count per stage of the consent flow.  Note that the aggregated abandonment count for all stages for a period should equal the count in <code>abandonedConsentFlowCount</code> for the same period (ie. each abandoned consent should assigned to one, and only one, stage)</td>
 </tr>
 <tr>
-<td>»»»»»»» abandonedConsentFlowCount</td>
+<td>»»»»»»» preIdentification</td>
 <td>object</td>
 <td>mandatory</td>
 <td>The number of authorisations that commenced with the data holder but the customer did not successfully identify their profile or user ID</td>

docs/includes/changelog

@@ -10,7 +10,7 @@
 </tr>
 </thead><tbody>
 <tr>
-<td>08/06/2023</td>
+<td>08/07/2023</td>
 <td>1.25.0</td>
 <td>Changes arising from Decision 303 (Maintenance iteration 15) and Decision 288 (Metrics and NFRs)</td>
 <td>See <a href="includes/releasenotes/releasenotes.1.25.0.html">release notes</a>, <a href="https://github.com/ConsumerDataStandardsAustralia/standards/issues/303">Decision 303</a> and <a href="https://github.com/ConsumerDataStandardsAustralia/standards/issues/288">Decision 288</a> for details.</td>

docs/includes/cx_standards/authorisation

@@ -1,6 +1,4 @@
-<h2 id='authorisation-standards'>Authorisation Standards</h2><pre class="highlight diff tab-diff"><code>Added new Authorisation CX Standard:
-<span class="gi">+ Authorisation: Account selection functionality
-</span></code></pre>
+<h2 id='authorisation-standards'>Authorisation Standards</h2>
 <table><thead>
 <tr>
 <th>Area</th>

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

@@ -619,7 +619,7 @@ <h2 id='banking-apis'>Banking APIs</h2>
 <td>2020-11-01</td>
 <td>2024-09-09</td>
 <td>2019-09-30, V1.0.0</td>
-<td>TBC, V1.25.0</td>
+<td>2023-07-08, V1.25.0</td>
 </tr>
 <tr>
 <td>Banking APIs</td>
@@ -629,7 +629,7 @@ <h2 id='banking-apis'>Banking APIs</h2>
 <td>V2</td>
 <td>2024-03-11</td>
 <td>N/A</td>
-<td>TBC, V1.25.0</td>
+<td>2023-07-08, V1.25.0</td>
 <td>N/A</td>
 </tr>
 <tr>
@@ -641,7 +641,7 @@ <h2 id='banking-apis'>Banking APIs</h2>
 <td>2020-11-01</td>
 <td>2024-09-09</td>
 <td>2019-09-30, V1.0.0</td>
-<td>TBC, V1.25.0</td>
+<td>2023-07-08, V1.25.0</td>
 </tr>
 <tr>
 <td>Banking APIs</td>
@@ -651,7 +651,7 @@ <h2 id='banking-apis'>Banking APIs</h2>
 <td>V2</td>
 <td>2024-03-11</td>
 <td>N/A</td>
-<td>TBC, V1.25.0</td>
+<td>2023-07-08, V1.25.0</td>
 <td>N/A</td>
 </tr>
 <tr>
@@ -663,7 +663,7 @@ <h2 id='banking-apis'>Banking APIs</h2>
 <td>2020-11-01</td>
 <td>2024-09-09</td>
 <td>2019-09-30, V1.0.0</td>
-<td>TBC, V1.25.0</td>
+<td>2023-07-08, V1.25.0</td>
 </tr>
 <tr>
 <td>Banking APIs</td>
@@ -673,7 +673,7 @@ <h2 id='banking-apis'>Banking APIs</h2>
 <td>V2</td>
 <td>2024-03-11</td>
 <td>N/A</td>
-<td>TBC, V1.25.0</td>
+<td>2023-07-08, V1.25.0</td>
 <td>N/A</td>
 </tr>
 <tr>
@@ -920,7 +920,7 @@ <h2 id='energy-apis'>Energy APIs</h2>
 <td>2022-11-15</td>
 <td>2024-09-09</td>
 <td>2021-10-29, V1.14.0</td>
-<td>TBC, V1.25.0</td>
+<td>2023-07-08, V1.25.0</td>
 </tr>
 <tr>
 <td>Energy APIs</td>
@@ -930,7 +930,7 @@ <h2 id='energy-apis'>Energy APIs</h2>
 <td>V2</td>
 <td>2023-11-01</td>
 <td>N/A</td>
-<td>TBC, V1.25.0</td>
+<td>2023-07-08, V1.25.0</td>
 <td>N/A</td>
 </tr>
 <tr>
@@ -942,7 +942,7 @@ <h2 id='energy-apis'>Energy APIs</h2>
 <td>2022-11-15</td>
 <td>2024-09-09</td>
 <td>2021-10-29, V1.14.0</td>
-<td>TBC, V1.25.0</td>
+<td>2023-07-08, V1.25.0</td>
 </tr>
 <tr>
 <td>Energy APIs</td>
@@ -952,7 +952,7 @@ <h2 id='energy-apis'>Energy APIs</h2>
 <td>V2</td>
 <td>2023-11-01</td>
 <td>N/A</td>
-<td>TBC, V1.25.0</td>
+<td>2023-07-08, V1.25.0</td>
 <td>N/A</td>
 </tr>
 <tr>
@@ -964,7 +964,7 @@ <h2 id='energy-apis'>Energy APIs</h2>
 <td>2022-11-15</td>
 <td>2024-09-09</td>
 <td>2021-10-29, V1.14.0</td>
-<td>TBC, V1.25.0</td>
+<td>2023-07-08, V1.25.0</td>
 </tr>
 <tr>
 <td>Energy APIs</td>
@@ -974,7 +974,7 @@ <h2 id='energy-apis'>Energy APIs</h2>
 <td>V2</td>
 <td>2023-11-01</td>
 <td>N/A</td>
-<td>TBC, V1.25.0</td>
+<td>2023-07-08, V1.25.0</td>
 <td>N/A</td>
 </tr>
 </tbody></table>

docs/includes/known-issues

@@ -8,6 +8,10 @@
 </tr>
 </thead><tbody>
 <tr>
+<td style="text-align: left">Incorrect obligation date for Get Metrics v5</td>
+<td style="text-align: left">The future dated obligation date has been incorrectly documented in the standards as June 13th 2024.  This was a documentation error when v1.25.0 of the standards were published.  According to the decision of the Data Standards Chair (Decision 288) the obligation date for the implementation of Get Metrics v5 is <strong>May 13th 2024</strong>.  This will be corrected in the next release of the standards.</td>
+</tr>
+<tr>
 <td style="text-align: left">Register APIs use local version of common definitions</td>
 <td style="text-align: left">The Register APIs use a locally defined version of common schema definitions such as <code>ResponseErrorList</code> for error responses. These need to be updated to reference common swagger specifications inherited by the Common Swagger spec.</td>
 </tr>

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 data holders by 1st November 2023.</p>
+<p>This version must be implemented by <strong>November 1st 2023</strong> and may be obsoleted once v5 has been implemented</p>
 <h2 id='get-metrics'>Get Metrics</h2>
 <p><a id="opIdgetMetrics"></a></p>
 
@@ -322,15 +322,12 @@ <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>Obsolete versions: <a href="includes/obsolete/get-metrics-v1.html">v1</a> <a href="includes/obsolete/get-metrics-v2.html">v2</a>.</p>
+<p>Obsolete versions: <a href="get-metrics-v1.html">v1</a> <a href="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 must be implemented by <strong>November 1st 2023</strong></li>
+<li><a href="get-metrics-v3.html">v3</a></li>
 </ul>
 
 <p>If the Data Holder supports private_key_jwt client authentication they MUST validate the scope.</p>
@@ -1186,7 +1183,7 @@ <h3 class="schema-toc" id="tocSresponsemetricslistv4">ResponseMetricsListV4</h3>
 <td>» errors</td>
 <td><a href="#schemacdr-admin-apierrormetricsv2">ErrorMetricsV2</a></td>
 <td>mandatory</td>
-<td>Peak transactions per second over time</td>
+<td>Number of calls resulting in error due to server execution over time</td>
 </tr>
 <tr>
 <td>» rejections</td>
@@ -2054,7 +2051,7 @@ <h3 class="schema-toc" id="tocSerrormetricsv2">ErrorMetricsV2</h3>
 </span><span class="p">}</span><span class="w">
 
 </span></code></pre>
-<p><em>Peak transactions per second over time</em></p>
+<p><em>Number of calls resulting in error due to server execution over time</em></p>
 <h3 id='properties-9'>Properties</h3>
 <table><thead>
 <tr>

docs/includes/releasenotes/releasenotes.1.25.0.html

@@ -294,22 +294,22 @@ <h2 id='introduction'>Introduction</h2>
 </tr>
 <tr>
 <td>Added Data Holder Brands Summary API to endpoint schedule</td>
-<td><strong>Standards Maintenance #586</strong>](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/586): Included the Get Data Holder Brands Summary API into the endpoint version schedule. Addresses this issue <a href="https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/586#issuecomment-1552304480">comment</a>)</td>
+<td><a href="https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/586"><strong>Standards Maintenance #586</strong></a>: Included the Get Data Holder Brands Summary API into the endpoint version schedule. Addresses this issue <a href="https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/586#issuecomment-1552304480">comment</a></td>
 <td><a href="../../includes/endpoint-version-schedule/#endpoint-version-schedule">Endpoint Version Schedule</a></td>
 </tr>
 <tr>
 <td>Typo correction in the endpoint schedule</td>
-<td><strong>Standards Maintenance #586</strong>](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/586): Corrected typos in the endpoint version schedule. Addresses this issue <a href="https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/586#issuecomment-1552317244">comment</a>)</td>
+<td><a href="https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/586"><strong>Standards Maintenance #586</strong></a>: Corrected typos in the endpoint version schedule. Addresses this issue <a href="https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/586#issuecomment-1552317244">comment</a></td>
 <td><a href="../../includes/endpoint-version-schedule/#endpoint-version-schedule">Endpoint Version Schedule</a></td>
 </tr>
 <tr>
 <td>Heading changes</td>
-<td><strong>Standards Maintenance #586</strong>](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/586): Renamed InfoSec Profile to Security Profile and CDR Register APIs to Register APIs in the endpoint version schedule. Addresses this issue <a href="https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/586#issuecomment-1552523783">comment</a></td>
+<td><a href="https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/586"><strong>Standards Maintenance #586</strong></a>: Renamed InfoSec Profile to Security Profile and CDR Register APIs to Register APIs in the endpoint version schedule. Addresses this issue <a href="https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/586#issuecomment-1552523783">comment</a></td>
 <td><a href="../../includes/endpoint-version-schedule/#endpoint-version-schedule">Endpoint Version Schedule</a></td>
 </tr>
 <tr>
 <td>Spelling mistake</td>
-<td><strong>Standards Maintenance #586</strong>](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/586): Fixed misspelling of &quot;Register&quot;. Addresses this issue <a href="https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/586#issuecomment-1569508043">comment</a></td>
+<td><a href="https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/586"><strong>Standards Maintenance #586</strong></a>: Fixed misspelling of &quot;Register&quot;. Addresses this issue <a href="https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/586#issuecomment-1569508043">comment</a></td>
 <td><a href="../../#future-dated-obligations">Future Dated Obligations</a></td>
 </tr>
 </tbody></table>

docs/includes/swagger/cds_admin.json

@@ -400,7 +400,7 @@
         "type" : "object"
       },
       "ErrorMetricsV2" : {
-        "description" : "Peak transactions per second over time",
+        "description" : "Number of calls resulting in error due to server execution over time",
         "properties" : {
           "aggregate" : {
             "$ref" : "#/components/schemas/ErrorMetricsV2_aggregate"
@@ -1759,7 +1759,7 @@
         "type" : "object",
         "x-conditional" : [ "currentDay", "previousDays" ]
       },
-      "AuthorisationMetricsV2_abandonmentsByStage_abandonedConsentFlowCount" : {
+      "AuthorisationMetricsV2_abandonmentsByStage_preIdentification" : {
         "description" : "The number of authorisations that commenced with the data holder but the customer did not successfully identify their profile or user ID",
         "properties" : {
           "currentDay" : {
@@ -1882,8 +1882,8 @@
       "AuthorisationMetricsV2_abandonmentsByStage" : {
         "description" : "Customer abandonment count per stage of the consent flow.  Note that the aggregated abandonment count for all stages for a period should equal the count in `abandonedConsentFlowCount` for the same period (ie. each abandoned consent should assigned to one, and only one, stage)",
         "properties" : {
-          "abandonedConsentFlowCount" : {
-            "$ref" : "#/components/schemas/AuthorisationMetricsV2_abandonmentsByStage_abandonedConsentFlowCount"
+          "preIdentification" : {
+            "$ref" : "#/components/schemas/AuthorisationMetricsV2_abandonmentsByStage_preIdentification"
           },
           "preAuthentication" : {
             "$ref" : "#/components/schemas/AuthorisationMetricsV2_abandonmentsByStage_preAuthentication"
@@ -1901,7 +1901,7 @@
             "$ref" : "#/components/schemas/AuthorisationMetricsV2_abandonmentsByStage_failedTokenExchange"
           }
         },
-        "required" : [ "abandonedConsentFlowCount", "failedTokenExchange", "preAccountSelection", "preAuthentication", "preAuthorisation", "rejected" ],
+        "required" : [ "failedTokenExchange", "preAccountSelection", "preAuthentication", "preAuthorisation", "preIdentification", "rejected" ],
         "type" : "object"
       },
       "ResponseErrorListV2_errors" : {
@@ -1927,4 +1927,4 @@
       }
     }
   }
-}
+}