Skip to content

Commit

Permalink
NPA-2676: Added missing headers and 500 responses
Browse files Browse the repository at this point in the history
  • Loading branch information
chris-young-12-nhs authored May 16, 2024
1 parent 83c9e09 commit 8eab0ab
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions specification/validated-relationships-service-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,10 @@ paths:
For the most part demographics information doesn't need to be provided in the access request since it can be pulled from PDS.
operationId: new-access-request
parameters:
- $ref: "#/components/parameters/BearerAuthorization"
- $ref: "#/components/parameters/RequestID"
- $ref: "#/components/parameters/CorrelationID"
requestBody:
description: FHIR QuestionnaireResponse
required: true
Expand All @@ -179,6 +183,15 @@ paths:
application:fhir+/json:
schema:
$ref: '#/components/schemas/OperationOutcome'
"500":
description: Internal server error
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/OperationOutcome'
examples:
internalServerError:
$ref: '#/components/examples/InternalServerError'

/RelatedPerson:
get:
Expand Down Expand Up @@ -224,10 +237,20 @@ paths:
| 401 | `ACCESS_DENIED` | Missing or invalid OAuth 2.0 bearer token in request. |
| 408 | `TIMEOUT` | Request timed out. |
| 429 | `THROTTLED` | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/OperationOutcome'
"500":
description: Internal server error
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/OperationOutcome'
examples:
internalServerError:
$ref: '#/components/examples/InternalServerError'
components:
schemas:
QuestionnaireResponse:
Expand Down Expand Up @@ -907,3 +930,18 @@ components:
format: uuid
pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
example: 11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA

examples:
InternalServerError:
value:
resourceType: "OperationOutcome"
issue:
- severity: error
code: invalid
diagnostics: "Internal Server Error - Failed to generate response is present in the response"
details:
coding:
- system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
version: "1"
code: "SERVER_ERROR"
display: "Failed to generate response"

0 comments on commit 8eab0ab

Please sign in to comment.