From ea30ea4adad64a447ac902040f7cc0c2cf9ec7b4 Mon Sep 17 00:00:00 2001 From: Nils Berge <60594671+nils-work@users.noreply.github.com> Date: Wed, 28 Aug 2024 19:50:52 +1000 Subject: [PATCH] Staging #426 - Corrected OAS, moved files Addresses: https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/426 --- slate/source/includes/additional.md | 8 +++++--- .../additional/candidates/{ => telco}/telco.html.md | 4 ++-- .../includes/additional/candidates/telco/telco_apis.md | 10 ++++++++++ .../includes/additional/candidates/telco_apis.md | 8 -------- .../includes/releasenotes/releasenotes.1.32.0.html.md | 3 ++- swagger-gen/api/cds_telco.json | 4 ++-- 6 files changed, 21 insertions(+), 16 deletions(-) rename slate/source/includes/additional/candidates/{ => telco}/telco.html.md (68%) create mode 100644 slate/source/includes/additional/candidates/telco/telco_apis.md delete mode 100644 slate/source/includes/additional/candidates/telco_apis.md diff --git a/slate/source/includes/additional.md b/slate/source/includes/additional.md index 9e661f85..3d59bc53 100644 --- 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/slate/source/includes/additional/candidates/telco.html.md b/slate/source/includes/additional/candidates/telco/telco.html.md similarity index 68% rename from slate/source/includes/additional/candidates/telco.html.md rename to slate/source/includes/additional/candidates/telco/telco.html.md index 93103bd6..2c35371f 100644 --- a/slate/source/includes/additional/candidates/telco.html.md +++ b/slate/source/includes/additional/candidates/telco/telco.html.md @@ -6,11 +6,11 @@ language_tabs: - diff: Version Delta toc_footers: - - Consumer Data Standards + - Consumer Data Standards 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 new file mode 100644 index 00000000..715980c7 --- /dev/null +++ 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 +``` + + + + +
Telco OpenAPI Specification (JSON)
Telco OpenAPI Specification (YAML)
diff --git a/slate/source/includes/additional/candidates/telco_apis.md b/slate/source/includes/additional/candidates/telco_apis.md deleted file mode 100644 index deea765d..00000000 --- a/slate/source/includes/additional/candidates/telco_apis.md +++ /dev/null @@ -1,8 +0,0 @@ -This specification defines the APIs for Data Holders exposing Telecommunications endpoints. - - - - - - -
Telco OpenAPI Specification (JSON)
Telco OpenAPI Specification (YAML)
diff --git a/slate/source/includes/releasenotes/releasenotes.1.32.0.html.md b/slate/source/includes/releasenotes/releasenotes.1.32.0.html.md index 3ef0a75c..fd78700d 100644 --- a/slate/source/includes/releasenotes/releasenotes.1.32.0.html.md +++ b/slate/source/includes/releasenotes/releasenotes.1.32.0.html.md @@ -17,7 +17,7 @@ Release notes for version v1.32.0 of the [CDR Standards](../../index.html). This release addresses the following minor defects raised on [Standards Staging](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues): -- [Standards Staging #XXX - Title](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/XXX) +- [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): @@ -76,6 +76,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 index f9df51ff..9366f29f 100644 --- 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" } }