Skip to content

NPA-4913 Add 502 Errors #202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JackPlowman merged 1 commit into from
May 7, 2025
Merged

NPA-4913 Add 502 Errors #202

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 30 additions & 5 deletions specification/validated-relationships-service-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,8 +237,15 @@ paths:
examples:
accessDeniedError:
$ref: "./examples/responses/errors/access-denied.yaml#/AccessDeniedError"
"500":
description: Internal server error
"5XX":
description: |
Errors will be returned for the first error encountered in the request. An error occurred as follows:

| HTTP status | Error code | Description |
| ----------- | -------------------------- | ------------------------------------------------------------ |
| 500 | `SERVER_ERROR` | An unexpected internal server error has occurred. |
| 502 | `GATEWAY_ERROR` | Connection to the backend service failed. |

content:
application/fhir+json:
schema:
Expand Down Expand Up @@ -317,7 +324,14 @@ paths:
referenceCodeNotFound:
$ref: "./examples/responses/GET_QuestionnaireResponse/errors/questionnaire_response_not_found.yaml#/QuestionnaireResponseNotFound"
"5XX":
description: Server error
description: |
Errors will be returned for the first error encountered in the request. An error occurred as follows:

| HTTP status | Error code | Description |
| ----------- | -------------------------- | ------------------------------------------------------------ |
| 500 | `SERVER_ERROR` | An unexpected internal server error has occurred. |
| 502 | `GATEWAY_ERROR` | Connection to the backend service failed. |

content:
application/fhir+json:
schema:
Expand Down Expand Up @@ -420,8 +434,15 @@ paths:
RelatedPersonInvalidIdentifierError:
$ref: "./examples/responses/GET_RelatedPerson/errors/invalid-identifier.yaml#/RelatedPersonInvalidIdentifierError"

"500":
description: Internal server error
"5XX":
description: |
Errors will be returned for the first error encountered in the request. An error occurred as follows:

| HTTP status | Error code | Description |
| ----------- | -------------------------- | ------------------------------------------------------------ |
| 500 | `SERVER_ERROR` | An unexpected internal server error has occurred. |
| 502 | `GATEWAY_ERROR` | Connection to the backend service failed. |

content:
application/fhir+json:
schema:
Expand Down Expand Up @@ -570,6 +591,7 @@ paths:
| HTTP status | Error code | Description |
| ----------- | -------------------------- | ------------------------------------------------------------ |
| 500 | `SERVER_ERROR` | An unexpected internal server error has occurred. |
| 502 | `GATEWAY_ERROR` | Connection to the backend service failed. |
| 503 | `DOWNSTREAM_SERVICE_ERROR` | A downsteam service has failed, request cannot be completed. |

content:
Expand Down Expand Up @@ -689,6 +711,7 @@ paths:
| HTTP status | Error code | Description |
| ----------- | -------------------------- | ------------------------------------------------------------ |
| 500 | `SERVER_ERROR` | An unexpected internal server error has occurred. |
| 502 | `GATEWAY_ERROR` | Connection to the backend service failed. |
| 503 | `DOWNSTREAM_SERVICE_ERROR` | A downsteam service has failed, request cannot be completed. |

content:
Expand Down Expand Up @@ -846,7 +869,9 @@ paths:
| HTTP status | Error code | Description |
| ----------- | -------------------------- | ------------------------------------------------------------ |
| 500 | `SERVER_ERROR` | An unexpected internal server error has occurred. |
| 502 | `GATEWAY_ERROR` | Connection to the backend service failed. |
| 503 | `DOWNSTREAM_SERVICE_ERROR` | A downsteam service has failed, request cannot be completed. |

content:
application/fhir+json:
schema:
Expand Down