Merge pull request #111 from hmrc/MTDSA-17334

MTDSA-17334: OAS update for Individual Disclosures API

resources/public/api/conf/1.0/amend.yaml

@@ -24,6 +24,10 @@ description: |
             <td><p>NOT_FOUND</p></td>
             <td><p>Simulates the scenario where no data is found.</p></td>
         </tr>
+        <tr>
+            <td><p>STATEFUL</p></td>
+            <td><p>Performs a stateful create or update.</p></td>
+        </tr>
     </tbody>
   </table>
 

resources/public/api/conf/1.0/delete.yaml

@@ -24,6 +24,10 @@ description: |
             <td><p>NOT_FOUND</p></td>
             <td><p>Simulates the scenario where no data is found.</p></td>
         </tr>
+        <tr>
+            <td><p>STATEFUL</p></td>
+            <td><p>Performs a stateful delete.</p></td>
+        </tr>
     </tbody>
   </table>
 

resources/public/api/conf/1.0/retrieve.yaml

@@ -20,6 +20,19 @@ description: |
             <td><p>NOT_FOUND</p></td>
             <td><p>Simulates the scenario where no data is found.</p></td>
         </tr>
+        <tr>
+            <td><p>STATEFUL</p></td>
+            <td><p>Performs a stateful retrieve.</p></td>
+        </tr>
+        <tr>
+            <td><p>DYNAMIC</p></td>
+            <td><p>The following response values will change to correspond to the values submitted in the request:
+              <ul>
+                  <li>submittedOn</li>
+                  <li>taxYear</li>
+              </ul>
+            </p></td>
+        </tr>
     </tbody>
   </table>
 

resources/public/api/conf/common/testing.md

@@ -4,4 +4,15 @@ It may not be possible to test all scenarios in the sandbox. You can test some s
 
 If you have a specific testing need that is not supported in the sandbox, contact <a href="/developer/support">our support team</a>.
 
-Some APIs may be marked \[test only\]. This means that they are not available for use in production and may change.
+Some APIs may be marked \[test only\]. This means that they are not available for use in production and may change.
+
+### Stateful
+Some endpoints support STATEFUL gov test scenarios. Stateful scenarios work with groups of endpoints that represent particular types of submissions.  For each type you can POST (or PUT) to submit or amend data, GET to retrieve or list data and DELETE to delete data. For example, with a STATEFUL gov test scenario a retrieval will return data based on what you submitted.
+
+The following groups are stateful in the sandbox:
+- Disclosures
+
+### Dynamic
+Some endpoints support DYNAMIC gov test scenarios. The response is dynamic based on the request parameters:
+- Retrieve Disclosures
+