Standards Maintenance Issue 494: Fixed documentation in Response Payl…

…oad Structure. Addresses ConsumerDataStandardsAustralia/standards-maintenance#494
ConsumerDataStandardsAustralia · May 25, 2022 · e023da2 · e023da2
1 parent 7b05677
commit e023da2
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/slate/source/includes/releasenotes/releasenotes.1.18.0.html.md b/slate/source/includes/releasenotes/releasenotes.1.18.0.html.md
@@ -18,6 +18,7 @@ Release notes for version v1.18.0 of the [CDR Standards](../../index.html).
 This release addresses the following change requests raised on [Standards Maintenance](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues):
 
 - [Standards Maintenance Issue 511: Iteration 11 Holistic Feedback)](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/511)
+- [Response payload structure description error](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/494)
 
 
 
@@ -32,7 +33,7 @@ This release addresses the following Decision Proposals published on [Standards]
 
 |Change|Description|Link|
 |------|-----------|----|
-| | | |
+| Response Payload Structure | [**Standards Maintenance #494**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/494): Corrected documentation to refer to the API response, not request. | [Payload Conventions](../../#payload-conventions) |
 
 ## API End Points
 

diff --git a/slate/source/includes/standards/_payloads.md b/slate/source/includes/standards/_payloads.md
@@ -61,7 +61,14 @@ The definition of the contents for the `data` object and `meta` object will be d
 }
 ```
 
-Each API request payload MUST have a JSON object at the root level known as the **root object**.
+```diff
+Corrected the description to refer to the paylow response not request
+
+- Each API request payload MUST have a JSON object at the root level known as the root object.
++ Each API response payload MUST have a JSON object at the root level known as the root object.
+
+```
+Each API response payload MUST have a JSON object at the root level known as the **root object**.
 
 The contents of the root object are as follows: