Skip to content

Commit

Permalink
Release/1.22.0 hotfix (#286)
Browse files Browse the repository at this point in the history
* Standards Maintenance Issue 546: Updated DCR and Register swagger specifications to use Common Field Types

* Added diff and release notes

* Fixed redirect_uris array use of URIString in relation to maintenance comment: ConsumerDataStandardsAustralia/standards-maintenance#546 (comment)

* Updated code formatting and indenting

* Added Enum common type usage

* Updated DCR and Register specs based on community feedback to the Common Field Types implementation

* Updated swaggers to remove format fields

* Updated diff for the Register API changes

* Fixed formatting

* Updated Register APIs based on ACCC feedback

* Base branch for v1.22.0

* Draft updates 1 DP 275

* Retain v1.21.0 delta statements

* Rebuild

* Fixed open-status reversal

* Rebuild

* Create release notes
Add archive entry
Add change log entry

* Release notes

* Add archived API versions

* Add new field to the swagger
Add FDO
Update endpoint schedule

* Add diff statements

* Fix missing obselete link in Get Accounts

* Fix obselete message bug

* Fixed Issue with AccontDetail

* Rebuild
Add in Telco diff statement
Add Telco release notes

* Merge of 1.22.0

* Remove external refs on client IDs

* Remove common string references

* Review updates

* Release notes

* Rebuild
Diff statement

* Updates to x-v headers

* reverted account scope

* Updated other account scopes

* Update extended security documentation

* Rebuild

* Engage Festive

* Rebuild with FESTIVE ENGAGED

* Fix additional TDIF links

* Fix ACCC fonts

* Fix minor defects picked up after publish
Rebuild

Co-authored-by: Mark Verstege <[email protected]>
Co-authored-by: Kirkycdr <[email protected]>
  • Loading branch information
3 people authored Dec 22, 2022
1 parent 9c3a5f9 commit 386dd36
Show file tree
Hide file tree
Showing 11 changed files with 39 additions and 177 deletions.
59 changes: 16 additions & 43 deletions docs/includes/cds_telco
Original file line number Diff line number Diff line change
Expand Up @@ -1873,13 +1873,6 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the Account List end point. In accordance with <a href="#id-permanence">CDR ID permanence</a> requirements</td>
</tr>
<tr>
<td>open-status</td>
<td>query</td>
<td>string</td>
<td>optional</td>
<td>Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed</td>
</tr>
<tr>
<td>x-v</td>
<td>header</td>
<td>string</td>
Expand Down Expand Up @@ -1922,26 +1915,6 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>The customer&#39;s original standard http headers <a href="#common-field-types">Base64</a> encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-3'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Parameter</th>
<th>Value</th>
</tr>
</thead><tbody>
<tr>
<td>open-status</td>
<td>ALL</td>
</tr>
<tr>
<td>open-status</td>
<td>CLOSED</td>
</tr>
<tr>
<td>open-status</td>
<td>OPEN</td>
</tr>
</tbody></table>

<blockquote>
<p>Example responses</p>
Expand Down Expand Up @@ -6842,7 +6815,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>Object that contains links to additional information on specific topics</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-4'>Enumerated Values</h4>
<h4 id='enumerated-values-3'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -7208,7 +7181,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>Open or closed status for the account. If not present then OPEN is assumed</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-5'>Enumerated Values</h4>
<h4 id='enumerated-values-4'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -7367,7 +7340,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>Represents a manual payment schedule where the customer pays in response to a delivered statement. Mandatory if paymentScheduleUType is set to manualPayment</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-6'>Enumerated Values</h4>
<h4 id='enumerated-values-5'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -7480,7 +7453,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>Array of ENUM&#39;s to specify what the concession applies to. Multiple ENUM values can be provided. If absent, USAGE is assumed</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-7'>Enumerated Values</h4>
<h4 id='enumerated-values-6'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -7677,7 +7650,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>Indicator of the payment status for the invoice</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-8'>Enumerated Values</h4>
<h4 id='enumerated-values-7'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -7941,7 +7914,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>none</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-9'>Enumerated Values</h4>
<h4 id='enumerated-values-8'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -8159,7 +8132,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>Optional array of adjustments arising for this transaction</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-10'>Enumerated Values</h4>
<h4 id='enumerated-values-9'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -8218,7 +8191,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>The method of payment</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-11'>Enumerated Values</h4>
<h4 id='enumerated-values-10'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -8480,7 +8453,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>Plan type for this feature. METERED: A plan is charged by usage for the feature. UNMETERED: A plan with no limits for a feature. LIMITED: Where plan limit inclusions apply. UNSUPPORTED: Feature is not supported</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-12'>Enumerated Values</h4>
<h4 id='enumerated-values-11'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -8574,7 +8547,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>Australian address formatted according to the file format defined by the <a href="https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf">PAF file format</a>. Required if addressUType is set to paf</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-13'>Enumerated Values</h4>
<h4 id='enumerated-values-12'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -9855,7 +9828,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>The type of the feature</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-14'>Enumerated Values</h4>
<h4 id='enumerated-values-13'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -10477,7 +10450,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>Mandatory if openStatus is OPEN</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-15'>Enumerated Values</h4>
<h4 id='enumerated-values-14'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -10815,7 +10788,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>The mechanism by which the payment amount is calculated. Explanation of values are as follows:<br/><ul><li><strong>STATIC</strong> - Indicates a consistent, static amount, per payment</li><li><strong>BALANCE</strong> - Indicates that the outstanding balance for the account is paid per period</li><li><strong>CALCULATED</strong> - Indicates that the payment amount is variable and calculated using a pre-defined algorithm</li></ul></td>
</tr>
</tbody></table>
<h4 id='enumerated-values-16'>Enumerated Values</h4>
<h4 id='enumerated-values-15'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -10913,7 +10886,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>The mechanism by which the payment amount is calculated. Explanation of values are as follows:<br/><ul><li><strong>STATIC</strong> - Indicates a consistent, static amount, per payment</li><li><strong>BALANCE</strong> - Indicates that the outstanding balance for the account is paid per period</li><li><strong>CALCULATED</strong> - Indicates that the payment amount is variable and calculated using a pre-defined algorithm</li></ul></td>
</tr>
</tbody></table>
<h4 id='enumerated-values-17'>Enumerated Values</h4>
<h4 id='enumerated-values-16'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -10994,7 +10967,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>The mechanism by which the payment amount is calculated. Explanation of values are as follows:<br/><ul><li><strong>STATIC</strong> - Indicates a consistent, static amount, per payment</li><li><strong>BALANCE</strong> - Indicates that the outstanding balance for the account is paid per period</li><li><strong>CALCULATED</strong> - Indicates that the payment amount is variable and calculated using a pre-defined algorithm</li></ul></td>
</tr>
</tbody></table>
<h4 id='enumerated-values-18'>Enumerated Values</h4>
<h4 id='enumerated-values-17'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down Expand Up @@ -11572,7 +11545,7 @@ To perform this operation, you must be authenticated and authorised with the fol
<td>A free text description of the charge</td>
</tr>
</tbody></table>
<h4 id='enumerated-values-19'>Enumerated Values</h4>
<h4 id='enumerated-values-18'>Enumerated Values</h4>
<table><thead>
<tr>
<th>Property</th>
Expand Down
6 changes: 3 additions & 3 deletions docs/includes/releasenotes/releasenotes.1.22.0.html
Original file line number Diff line number Diff line change
Expand Up @@ -251,8 +251,8 @@ <h2 id='changes-made'>Changes Made</h2><h3 id='change-requests'>Change Requests<
<p>This release addresses the following minor defects raised on <a href="https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues">Standards Staging</a>:</p>

<ul>
<li><a href="ConsumerDataStandardsAustralia/standards-staging#235">Fix for a missing font in styles</a></li>
<li><a href="ConsumerDataStandardsAustralia/standards-staging#234">Broken links in Register API section</a></li>
<li><a href="https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/235">Fix for a missing font in styles</a></li>
<li><a href="https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/234">Broken links in Register API section</a></li>
</ul>

<p>This release addresses the following change requests raised on <a href="https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues">Standards Maintenance</a>:</p>
Expand Down Expand Up @@ -309,7 +309,7 @@ <h2 id='api-end-points'>API End Points</h2>
</tr>
<tr>
<td>Holistic Feedback</td>
<td>Minor fixes arising from the feedback provided in the <a href="https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/551">Holistic Thress for Maintenance Iteration 13</a></td>
<td>Minor fixes arising from the feedback provided in the <a href="https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/551">Holistic Thread for Maintenance Iteration 13</a></td>
<td>Various</td>
</tr>
</tbody></table>
Expand Down
12 changes: 0 additions & 12 deletions docs/includes/swagger/cds_telco.json
Original file line number Diff line number Diff line change
Expand Up @@ -1198,18 +1198,6 @@
"type" : "string"
},
"style" : "simple"
}, {
"description" : "Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed",
"explode" : true,
"in" : "query",
"name" : "open-status",
"required" : false,
"schema" : {
"default" : "ALL",
"enum" : [ "ALL", "CLOSED", "OPEN" ],
"type" : "string"
},
"style" : "form"
}, {
"description" : "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)",
"explode" : false,
Expand Down
14 changes: 0 additions & 14 deletions docs/includes/swagger/cds_telco.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1192,20 +1192,6 @@ paths:
schema:
type: string
style: simple
- description: Used to filter results according to open/closed status. Values
can be OPEN, CLOSED or ALL. If absent then ALL is assumed
explode: true
in: query
name: open-status
required: false
schema:
default: ALL
enum:
- ALL
- CLOSED
- OPEN
type: string
style: form
- description: Version of the API end point requested by the client. Must be
set to a positive integer. The data holder should respond with the highest
supported version between [x-min-v](#request-headers) and [x-v](#request-headers).
Expand Down
Loading

0 comments on commit 386dd36

Please sign in to comment.