NPA-5088: Made use of ConsentID parameter component in patch endpoint and updated sandbox

Author: ellie-bound1-NHSD

sandbox/api/patch_consent.py

@@ -17,11 +17,11 @@
 logger = getLogger(__name__)
 
 
-def patch_consent_response(identifier: str) -> Union[dict, tuple]:
+def patch_consent_response(id: str) -> Union[dict, tuple]:
     """Sandbox API for PATCH /Consent
 
     Args:
-        identifier (str): Consent identifier to be patched
+        id (str): Consent id to be patched
 
     Returns:
         Union[dict, tuple]: Response for PATCH /Consent
@@ -31,35 +31,35 @@ def patch_consent_response(identifier: str) -> Union[dict, tuple]:
         # Validate body - validation is beyond the scope of the sandbox.
         # Assume all requests are valid
 
-        if identifier == "c512b0db-6702-43ee-8c21-bbded2552da9":
+        if id == "c512b0db-6702-43ee-8c21-bbded2552da9":
             # Successful status update
             return generate_response_from_example(PATCH_CONSENT__SUCCESS, 200)
 
-        elif identifier == "6b71ac92-baa3-4b76-b0f5-a601257e2722":
+        elif id == "6b71ac92-baa3-4b76-b0f5-a601257e2722":
             # Successful end date for a role
             return generate_response_from_example(PATCH_CONSENT__SUCCESS, 200)
 
-        elif identifier == "43003db8-ffcd-4bd6-ab2f-b49b9656f9e5":
+        elif id == "43003db8-ffcd-4bd6-ab2f-b49b9656f9e5":
             # Multiple valid changes
             return generate_response_from_example(PATCH_CONSENT__SUCCESS, 200)
 
-        elif identifier == "849ea584-2318-471b-a24c-cee1b5ad0137":
+        elif id == "849ea584-2318-471b-a24c-cee1b5ad0137":
             # Invalid patch format
             return generate_response_from_example(PATCH_CONSENT__INVALID_PATCH_FORMAT, 400)
 
-        elif identifier == "01abb0c5-b1ac-499d-9655-9cd0b8d3588f":
+        elif id == "01abb0c5-b1ac-499d-9655-9cd0b8d3588f":
             # Invalid path
             return generate_response_from_example(PATCH_CONSENT__INVALID_PATH, 400)
 
-        elif identifier == "78c35330-fa2f-4934-a5dd-fff847f38de5":
+        elif id == "78c35330-fa2f-4934-a5dd-fff847f38de5":
             # Invalid status code
             return generate_response_from_example(PATCH_CONSENT__INVALID_STATUS_CODE, 422)
 
-        elif identifier == "51fb4df5-815a-45cd-8427-04d6558336b7":
+        elif id == "51fb4df5-815a-45cd-8427-04d6558336b7":
             # Invalid status reason
             return generate_response_from_example(PATCH_CONSENT__INVALID_STATUS_REASON, 422)
 
-        elif identifier == "7b7f47b8-96e5-43eb-b733-283bf1449f2c":
+        elif id == "7b7f47b8-96e5-43eb-b733-283bf1449f2c":
             # Invalid state transition
             return generate_response_from_example(PATCH_CONSENT__INVALID_STATE_TRANSITION, 422)
 

specification/validated-relationships-service-api.yaml

@@ -853,24 +853,7 @@ paths:
         | Resource not found              | Patch for non-existent Consent, request with an id not listed here                              | HTTP Status 404 and RESOURCE_NOT_FOUND error response         |
         | Invalid state transition        | Patch attempting invalid status change, request with id '7b7f47b8-96e5-43eb-b733-283bf1449f2c'  | HTTP Status 422 and INVALID_STATE_TRANSITION error response   |
       parameters:
-        # Change id parameter to Component ConsentID when NPA-5088 is complete
-        - name: id
-          in: path
-          required: true
-          description: The UUID of the Consent resource to update
-          schema:
-            type: string
-            format: uuid
-          examples:
-            statusUpdate:
-              value: c512b0db-6702-43ee-8c21-bbded2552da9
-              summary: Update consent status
-            updateProvision:
-              value: 6b71ac92-baa3-4b76-b0f5-a601257e2722
-              summary: Set an end date for a role
-            multipleUpdates:
-              value: 43003db8-ffcd-4bd6-ab2f-b49b9656f9e5
-              summary: Set status to active with an end date
+        - $ref: "#/components/parameters/ConsentID"
       requestBody:
         required: true
         content: