Skip to content

Commit

Permalink
Merge pull request #295 from ConsumerDataStandardsAustralia/dp/322
Browse files Browse the repository at this point in the history
Dp/322
  • Loading branch information
JamesMBligh authored Aug 23, 2023
2 parents e519832 + 27f860f commit d67fe0e
Show file tree
Hide file tree
Showing 87 changed files with 625 additions and 626 deletions.
20 changes: 0 additions & 20 deletions docs/includes/additional/additional20230710-41538-1hep9lq

This file was deleted.

20 changes: 0 additions & 20 deletions docs/includes/additional/additional20230717-92036-rywnu1

This file was deleted.

20 changes: 0 additions & 20 deletions docs/includes/additional/additional20230721-17819-179l1ax

This file was deleted.

10 changes: 1 addition & 9 deletions docs/includes/additional/candidates/telco.html
Original file line number Diff line number Diff line change
Expand Up @@ -609,15 +609,7 @@ <h1 id='telco-apis'>Telco APIs</h1><aside class="notice">
<tr><td><a href='../../../includes/swagger/cds_telco.json'>Telco OpenAPI Specification (JSON)</a></td></tr>
<tr><td><a href='../../../includes/swagger/cds_telco.yaml'>Telco OpenAPI Specification (YAML)</a></td></tr>
</table>
<pre class="highlight diff tab-diff"><code>Updated description of TelcoPaymentScheduleDigitalWallet.name field
from:
<span class="gd">- The name assigned to the digital wallet by the owner of the wallet, else the display name provided by the digital wallet provider
</span>to:
<span class="gi">+ The display name of the wallet as given by the customer, else a default value defined by the data holder
</span>
Replaced FAPI draft references with FAPI 1.0 Final references.
References pertain to the x-fapi-auth-date header.
</code></pre><h2 id='get-telco-products'>Get Telco Products</h2>
<h2 id='get-telco-products'>Get Telco Products</h2>
<p><a id="opIdlistProducts"></a></p>

<blockquote>
Expand Down
9 changes: 0 additions & 9 deletions docs/includes/additional/candidates/telco_apis
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,3 @@
<tr><td><a href='../../../includes/swagger/cds_telco.json'>Telco OpenAPI Specification (JSON)</a></td></tr>
<tr><td><a href='../../../includes/swagger/cds_telco.yaml'>Telco OpenAPI Specification (YAML)</a></td></tr>
</table>
<pre class="highlight diff tab-diff"><code>Updated description of TelcoPaymentScheduleDigitalWallet.name field
from:
<span class="gd">- The name assigned to the digital wallet by the owner of the wallet, else the display name provided by the digital wallet provider
</span>to:
<span class="gi">+ The display name of the wallet as given by the customer, else a default value defined by the data holder
</span>
Replaced FAPI draft references with FAPI 1.0 Final references.
References pertain to the x-fapi-auth-date header.
</code></pre>
5 changes: 5 additions & 0 deletions docs/includes/archives
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@
</tr>
</thead><tbody>
<tr>
<td><a href='https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.25.0/'>08/07/2023</a></td>
<td>1.25.0</td>
<td><a href='https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.25.0/'>Changes arising from Decision 303 (Maintenance iteration 15) and Decision 288 (Metrics and NFRs)</a></td>
</tr>
<tr>
<td><a href='https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.24.0/'>07/05/2023</a></td>
<td>1.24.0</td>
<td><a href='https://consumerdatastandardsaustralia.github.io/standards-archives/standards-1.24.0/'>Changes arising from Decision 281 (Maintenance iteration 14)</a></td>
Expand Down
6 changes: 3 additions & 3 deletions docs/includes/cds_admin
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
6 changes: 6 additions & 0 deletions docs/includes/changelog
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@
</tr>
</thead><tbody>
<tr>
<td>23/08/2023</td>
<td>1.26.0</td>
<td>Changes to obligations for the implementation of Get Metrics</td>
<td>See <a href="includes/releasenotes/releasenotes.1.26.0.html">release notes</a> and <a href="https://github.com/ConsumerDataStandardsAustralia/standards/issues/322">Decision 322</a> for details.</td>
</tr>
<tr>
<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>
Expand Down
15 changes: 11 additions & 4 deletions docs/includes/endpoint-version-schedule/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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.
Expand Down
8 changes: 3 additions & 5 deletions docs/includes/known-issues
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
<h1 id='known-issues'>Known Issues</h1>
<p>There are certain aspects of the standards that are actively under review. These known issues are articulated in the following table.</p>

<pre class="highlight diff tab-diff"><code>The known issue related to the incorrect obligation date for
Get Metrics v5 has been removed as it has been resolved
</code></pre>
<table><thead>
<tr>
<th style="text-align: left">Issue</th>
<th style="text-align: left">Description</th>
</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>
Expand Down
11 changes: 3 additions & 8 deletions docs/includes/nfrs
Original file line number Diff line number Diff line change
Expand Up @@ -141,11 +141,6 @@

<p>For Unattended traffic during high traffic periods only best effort support is required.</p>

<pre class="highlight diff tab-diff"><code>Updated the static site wide TPS thresholds with a graduated set of
thresholds depending on the number of active authorisations established
with the data holder
</code></pre>

<p>For secure traffic (both Customer Present and Unattended) the following traffic thresholds will apply:</p>

<ul>
Expand Down Expand Up @@ -177,9 +172,9 @@ with the data holder
<li>Unattended calls should be managed to avoid short term bursts of traffic</li>
</ul>

<p><pre class="highlight diff tab-diff"><code><span class="gi">+ Added the Low Velocity Data Sets section
</span></code></pre><h3 id='low-velocity-data-sets'>Low Velocity Data Sets</h3>
<p>For endpoints that provide access to data that is low velocity (ie. the data does not change frequently) the Data Recipient Software Product is expected to cache the results of any data they receive and not request the same resource again until the data may reasonably have changed.</p></p>
<h3 id='low-velocity-data-sets'>Low Velocity Data Sets</h3>

<p>For endpoints that provide access to data that is low velocity (ie. the data does not change frequently) the Data Recipient Software Product is expected to cache the results of any data they receive and not request the same resource again until the data may reasonably have changed.</p>

<p>For low velocity data sets, if the same data is requested repeatedly a Data Holder may reject subsequent requests for the same data during a specified period.</p>

Expand Down
4 changes: 3 additions & 1 deletion docs/includes/obsolete/get-metrics-v3.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down
2 changes: 1 addition & 1 deletion docs/includes/obsolete/get-metrics-v4.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down
Loading

0 comments on commit d67fe0e

Please sign in to comment.