Update eligibility-signposting-api.yaml

Adding specific examples for error conditions to prevent a Postman collection from being generated with additional values in each array.

Author: jhadfield-NHS

specification/eligibility-signposting-api.yaml

@@ -501,6 +501,25 @@ paths:
                           items:
                             type: string
                             example: 'parameters/conditions'
+              examples:
+                example_error_1:
+                  summary: Invalid Input Data Error
+                  value:
+                    resourceType: "OperationOutcome"
+                    id: rrt-2959959087381887325-c-geu2-24001-77777777-1
+                    meta:
+                      lastUpdated: "2025-02-12T16:11:22Z"
+                    issue:
+                      - severity: error
+                        code: value
+                        details:
+                          coding:
+                            - system: https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode
+                              code: VALIDATION_ERROR
+                              display: "The given conditions were not in the expected format."
+                        diagnostics: "FLU&COVID should be a single or comma separated list of condition strings with no other punctuation or special characters"
+                        location:
+                          - "parameters/conditions"
         '404':
           description: Person not found.
           content:
@@ -556,6 +575,25 @@ paths:
                           items:
                             type: string
                             example: 'parameters/patient'
+              examples:
+                example_error_1:
+                  summary: Resource Not Found Error
+                  value:
+                    resourceType: "OperationOutcome"
+                    id: rrt-2959959087381887325-c-geu2-24001-77777777-1
+                    meta:
+                      lastUpdated: "2025-02-12T16:11:22Z"
+                    issue:
+                      - severity: error
+                        code: processing
+                        details:
+                          coding:
+                            - system: https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode
+                              code: RESOURCE_NOT_FOUND
+                              display: "The given NHS number was not found in our datasets.  This could be because the number is incorrect or some other reason we cannot process that number."
+                        diagnostics: "NHS Number 9000000404 was not recognised by the Eligibility Signposting API"
+                        location:
+                          - "parameters/id"
         '422':
           description: 'Unrecognised input data. (Unprocessable Content)'
           content:
@@ -611,6 +649,25 @@ paths:
                           items:
                             type: string
                             example: 'parameters/category'
+              examples:
+                example_error_1:
+                  summary: Unrecognised Input Error
+                  value:
+                    resourceType: "OperationOutcome"
+                    id: rrt-2959959087381887325-c-geu2-24001-77777777-1
+                    meta:
+                      lastUpdated: "2025-02-12T16:11:22Z"
+                    issue:
+                      - severity: error
+                        code: value
+                        details:
+                          coding:
+                            - system: https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode
+                              code: VALIDATION_ERROR
+                              display: "The supplied category was not recognised by the API."
+                        diagnostics: "HEALTHCHECKS is not a category that is supported by the API"
+                        location:
+                          - "parameters/category"
         '500':
           description: Internal server error.
           content:
@@ -666,7 +723,25 @@ paths:
                           items:
                             type: string
                             example: 'parameters/category'
-
+              examples:
+                example_error_1:
+                  summary: Internal Processing Error
+                  value:
+                    resourceType: "OperationOutcome"
+                    id: rrt-2959959087381887325-c-geu2-24001-77777777-1
+                    meta:
+                      lastUpdated: "2025-02-12T16:11:22Z"
+                    issue:
+                      - severity: error
+                        code: processing
+                        details:
+                          coding:
+                            - system: https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode
+                              code: SERVICE_ERROR
+                              display: "An unknown error occurred processing this request. Contact us for assistance diagnosing this issue: https://digital.nhs.uk/developer/help-and-support quoting the id included in this message"
+                        diagnostics: "No diagnostics available"
+                        location:
+                          - "parameters/category"
 ################################################################################
 #                                 Components                                  #
 ################################################################################