NPA-4511: Reworked exmaples

Author: kamran-iqbal4-NHSD

sandbox/api/app.py

@@ -114,7 +114,7 @@ def get_related_persons() -> Union[dict, tuple]:
         raise ValueError("Invalid request")
 
     except Exception as e:
-        logger.error(e)
+        logger.exception("GET related person failed")
         return generate_response_from_example(INTERNAL_SERVER_ERROR_EXAMPLE, 500)
 
 
@@ -129,7 +129,7 @@ def post_questionnaire_response() -> Union[dict, tuple]:
     try:
         return generate_response_from_example(QUESTIONNAIRE_RESPONSE__SUCCESS, 200)
     except Exception as e:
-        logger.error(e)
+        logger.exception("POST questionnaire response failed")
         return generate_response_from_example(INTERNAL_SERVER_ERROR_EXAMPLE, 500)
 
 
@@ -187,8 +187,8 @@ def get_consent() -> Union[dict, tuple]:
             logger.error("Performer identifier does not match examples")
             return generate_response_from_example(INVALIDATED_RESOURCE, 404)
 
-    except Exception as e:
-        logger.error(e)
+    except Exception:
+        logger.exception("GET Consent failed")
         return generate_response_from_example(INTERNAL_SERVER_ERROR_EXAMPLE, 500)
 
 
@@ -238,7 +238,7 @@ def post_consent() -> Union[dict, tuple]:
 
         return response
 
-    except Exception as e:
+    except Exception:
         # Handle any general error
-        logger.error(e)
+        logger.exception("POST Consent failed")
         return generate_response_from_example(INTERNAL_SERVER_ERROR_EXAMPLE, 500)

specification/examples/responses/POST_Consent/errors/business_rule_validation_failed.yaml

@@ -1,5 +1,5 @@
 PostConsentDuplicateRelationshipError:
-  summary: Bad request for proxy role that already exists
+  summary: Duplicate request for proxy role that already exists
   description: 409 error response bundle for a duplicate proxy role
   value:
     issue:

specification/examples/responses/POST_Consent/errors/conflict_with_request_proxy_role.yaml

@@ -1,5 +1,5 @@
 PostConsentInvalidEvidenceError:
-  summary: Bad request missing evidence of responsibility
+  summary: Missing evidence of responsibility
   description: 422 error response bundle for a request without evidence of responsibility
   value:
     issue:

specification/examples/responses/POST_Consent/errors/duplicate_relationship_error.yaml

@@ -1,5 +1,5 @@
 PostConsentInvalidPatientAgeError:
-  summary: Bad request invalid patient age
+  summary: Invalid patient age
   description: 422 error response bundle for a request with an invalid patient age
   value:
     issue:

specification/examples/responses/POST_Consent/errors/invalid_evidence_error.yaml

@@ -483,15 +483,19 @@ paths:
         Use this endpoint to create a new proxy role between a patient and a related person (proxy).
 
         ## Sandbox test scenarios
-        | Scenario                                | Request                                                       | Response                                                  |
-        | --------------------------------------- | ------------------------------------------------------------- | --------------------------------------------------------- |
-        | Successful parent-child proxy creation  | Valid request with a legal basis of parental responsibility   | HTTP Status 201 and OperationOutcome response             |
-        | Successful adult-adult proxy creation   | Valid request with legal basis of consent                     | HTTP Status 201 and OperationOutcome response             |
-        | Invalid performer NHS number            | Request with invalid NHS number format                        | HTTP Status 400 and INVALID_NHS_NUMBER error response     |
-        | Missing required evidence               | Request without evidence of responsibility                    | HTTP Status 422 and MISSING_EVIDENCE error response       |
-        | Invalid access level                    | Request with undefined access level code                      | HTTP Status 400 and INVALID_ACCESS_LEVEL error response   |
-        | Patient age validation failure          | Request for child proxy where child is over 16                | HTTP Status 422 and INVALID_PATIENT_AGE error response    |
-        | Duplicate relationship                  | Request for relationship that already exists                  | HTTP Status 409 and DUPLICATE_RELATIONSHIP error response |
+
+        The sandbox supports a limited number of scenarios, and does not attempt to validate requests.  The expected results is dependant up the `performer.identifier.value`performer.identifier.value
+
+        See the postman collection for the full JSON.
+        | Scenario                                | Request                                                                                                    | Response                                                  |
+        | --------------------------------------- | ---------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
+        | Successful parent-child proxy creation  | Valid request with a legal basis of parental responsibility, with performer identifier value of 9000000009 | HTTP Status 201 and OperationOutcome response             |
+        | Successful adult-adult proxy creation   | Valid request with legal basis of consent, with performer identifier value of 9000000017                   | HTTP Status 201 and OperationOutcome response             |
+        | Invalid performer NHS number            | Request with invalid NHS number format, with performer identifier value of 9000000000                      | HTTP Status 400 and INVALID_NHS_NUMBER error response     |
+        | Invalid access level                    | Request with undefined access level code, with performer identifier value of 9000000025                    | HTTP Status 400 and INVALID_ACCESS_LEVEL error response   |
+        | Missing required evidence               | Request without evidence of responsibility, with performer identifier value of 9000000033                  | HTTP Status 422 and MISSING_EVIDENCE error response       |
+        | Patient age validation failure          | Request for child proxy where child is over 16, with performer identifier value of 9000000041              | HTTP Status 422 and INVALID_PATIENT_AGE error response    |
+        | Duplicate relationship                  | Request for relationship that already exists, with performer identifier value of 9000000049                | HTTP Status 409 and DUPLICATE_RELATIONSHIP error response |
       requestBody:
         required: true
         content: