Merge pull request #427 from ConsumerDataStandardsAustralia/defect/426

Staging #426 - Corrected OAS, moved files
ConsumerDataStandardsAustralia · Oct 21, 2024 · 0d376b5 · 0d376b5
2 parents 2819ce4 + 5180387
commit 0d376b5
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 15 deletions.
diff --git a/slate/source/includes/additional.md b/slate/source/includes/additional.md
@@ -1,7 +1,5 @@
 # Additional Standards
 
-
-
 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.
 
 These standards fall into three categories:
@@ -12,9 +10,13 @@ These standards fall into three categories:
 
 ## Candidate Standards
 
+```diff
+Updated Telco specification to ensure response header details are displayed correctly
+```
+
 The Consumer Data Standards currently include the following Candidate Standards:
 
-- [Candidate Standards for the Telecommunications sector](./includes/additional/candidates/telco.html)
+- [Candidate Standards for the Telecommunications sector](./includes/additional/candidates/telco/telco.html)
 - [Candidate Standards for Banking Decision Proposal 306](./includes/additional/candidates/dp306/banking-dp306.html)
 - [Candidate Standards for the Banking and Non-Bank Lending sector](./includes/additional/candidates/non-bank-lending/banking-non-bank-lending.html)
 

diff --git a/...ludes/additional/candidates/telco.html.md → ...additional/candidates/telco/telco.html.md b/...ludes/additional/candidates/telco.html.md → ...additional/candidates/telco/telco.html.md
@@ -6,11 +6,11 @@ language_tabs:
   - diff: Version Delta
 
 toc_footers:
-  - <a href='../../../index.html'>Consumer Data Standards</a>
+  - <a href='../../../../index.html'>Consumer Data Standards</a>
 
 includes:
   - additional/candidates/candidate_header
-  - additional/candidates/telco_apis
+  - additional/candidates/telco/telco_apis
   - cds_telco
 
 search: true

diff --git a/slate/source/includes/additional/candidates/telco/telco_apis.md b/slate/source/includes/additional/candidates/telco/telco_apis.md
@@ -0,0 +1,10 @@
+This specification defines the APIs for Data Holders exposing Telecommunications endpoints.
+
+```diff
+Updated Telco specification to ensure response header details are displayed correctly
+```
+
+<table>
+<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>
diff --git a/slate/source/includes/additional/candidates/telco_apis.md b/slate/source/includes/additional/candidates/telco_apis.md
diff --git a/slate/source/includes/releasenotes/releasenotes.1.32.0.html.md b/slate/source/includes/releasenotes/releasenotes.1.32.0.html.md
@@ -22,6 +22,7 @@ This release addresses the following minor defects raised on [Standards Staging]
 - [Standards Staging #417 - Non-existent property "amount" listed as required](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/417)
 - [Standards Staging #418 - Add a link to CX Guidelines to the left menu pane of the Standards](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/418)
 - [Standards Staging #419 - Field name styling](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/419)
+- [Standards Staging #426 - Error in Telco OAS components](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/426)
 
 This release addresses the following change requests raised on [Standards Maintenance](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues):
 
@@ -85,6 +86,7 @@ This release addresses the following Decision Proposals published on [Standards]
 ## Additional Standards
 |Change|Description|Link|
 |------|-----------|----|
+| Correction to Telco specification | [**Standards Staging #426**](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/426): Corrected error in specification of response headers | [Candidate Standards](../../#candidate-standards)
 
 
 ## Known Issues

diff --git a/swagger-gen/api/cds_telco.json b/swagger-gen/api/cds_telco.json
@@ -1761,14 +1761,14 @@
   "components": {
     "headers": {
       "x-v": {
+        "description": "The [version](#response-headers) of the API end point that the data holder has responded with.",
         "schema": {
-          "description": "The [version](#response-headers) of the API end point that the data holder has responded with.",
           "type": "string"
         }
       },
       "x-fapi-interaction-id": {
+        "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
         "schema": {
-          "description": "An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
           "type": "string"
         }
       }