Applied change to Register API in NBL Candidate

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#629 (comment)
ConsumerDataStandardsAustralia · Mar 19, 2024 · 04ad48e · 04ad48e
1 parent 28f3933
commit 04ad48e
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 4 deletions.
diff --git a/...includes/additional/candidates/non-bank-lending/_register_banking_non_bank_lending.md.erb b/...includes/additional/candidates/non-bank-lending/_register_banking_non_bank_lending.md.erb
@@ -9,6 +9,9 @@ These endpoints are exposed by the Register and consumed by Data Holders and Dat
   These statuses are provided authoritatively by the Register to allow participants to determine whether a connecting third-party is permitted to perform registration requests or data sharing requests.
 </aside>
 
+```diff
+Removed ResponseErrorListV2 as the 401 error response schema for 'Get Data Holder Brands'. This endpoint conforms to RFC6750, returning an oAuth error in the WWW-Authenticate response header.
+```
 
 <br>
 <table>

diff --git a/slate/source/includes/releasenotes/releasenotes.1.30.0.html.md b/slate/source/includes/releasenotes/releasenotes.1.30.0.html.md
@@ -77,6 +77,7 @@ This release addresses the following Decision Proposals published on [Standards]
 ## Additional Standards
 |Change|Description|Link|
 |------|-----------|----|
+| Clarified endpoint response | [**Standards Maintenance #629**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/629#issuecomment-1930936447): Removed ResponseErrorListV2 as the 401 error response schema for 'Get Data Holder Brands'. This endpoint conform to RFC6750, returning an oAuth error in the WWW-Authenticate response header. | [Register APIs in the Non-Bank Lending Candidate Standards](../../#candidate-standards)
 
 
 ## Known Issues

diff --git a/swagger-gen/api/cds_register_banking_non_bank_lending.json b/swagger-gen/api/cds_register_banking_non_bank_lending.json
@@ -125,10 +125,12 @@
           },
           "401": {
             "description": "Invalid Bearer Token",
-            "content": {
-              "application/json": {
+            "headers": {
+              "WWW-Authenticate": {
+                "description": "The Response Header Field as per **[[RFC6750]](#nref-RFC6750)**",
                 "schema": {
-                  "$ref": "#/components/schemas/ResponseErrorListV2"
+                  "type": "string",
+                  "x-cds-type": "ExternalRef"
                 }
               }
             }
@@ -676,7 +678,7 @@
           "registeredCountry": {
             "maxLength": 100,
             "type": "string",
-            "description": "Country of registeration (if the company is registered outside Australia)"
+            "description": "Country of registration (if the company is registered outside Australia)"
           },
           "abn": {
             "maxLength": 11,
-Original file line number
+Diff line change
@@ Expand Up @@
       These statuses are provided authoritatively by the Register to allow participants to determine whether a connecting third-party is permitted to perform registration requests or data sharing requests.
     </aside>
+    ```diff
+    Removed ResponseErrorListV2 as the 401 error response schema for 'Get Data Holder Brands'. This endpoint conforms to RFC6750, returning an oAuth error in the WWW-Authenticate response header.
+    ```
     <br>
     <table>
@@ Expand Down @@