Skip to content

CCM-13554 - APIM Errors not serializing #300

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
nhsd-david-wass merged 5 commits into from
Dec 19, 2025
Merged

CCM-13554 - APIM Errors not serializing #300

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8c997f5
CCM-13554 - APIM Errors not serializing
nhsd-david-wass Dec 10, 2025
48bae48
CCM-13554 - Update 429 response
nhsd-david-wass Dec 10, 2025
56c7b55
502 error from api gateway
nhsd-david-wass Dec 17, 2025
83e26aa
revert rate limiting
nhsd-david-wass Dec 18, 2025
81d2e55
remove created yml files
nhsd-david-wass Dec 18, 2025
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
3 changes: 3 additions & 0 deletions sandbox/data/examples/errors/responses/bad-gateway.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"message": "Bad Gateway"
}
20 changes: 8 additions & 12 deletions sandbox/data/examples/errors/responses/tooManyRequests.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
{
"errors": [
{
"code": "NOTIFY_QUOTA",
"detail": "You have made too many requests. Please try again later.",
"id": "rrt-1931948104716186917-c-geu2-10664-3111479-3.0",
"links": {
"about": "https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier"
},
"status": "429",
"title": "Too many requests"
}
]
"interval": 1,
"limit": 1,
"message": "Your application, Notify-Supplier-App-Restricted - Internal Dev 2, has exceeded its quota of 1 requests every 1 minute(s) and is being rate limited.",
"message_id": "rrt-4773181658036170775-c-geu2-321623-73628915-2",
"policy": "quota",
"ratelimiting_expiry_time_ms": 1765372560000,
"scope": "application",
"timeunit": "minute"
}
2 changes: 2 additions & 0 deletions specification/api/components/endpoints/createMI.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,5 @@ responses:
$ref: "../responses/errors/tooManyRequests.yml"
'500':
$ref: "../responses/errors/serverError.yml"
'502':
$ref: "../responses/errors/badGateway.yml"
2 changes: 2 additions & 0 deletions specification/api/components/endpoints/getDataId.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,5 @@ responses:
$ref: "../responses/errors/tooManyRequests.yml"
"500":
$ref: "../responses/errors/serverError.yml"
"502":
$ref: "../responses/errors/badGateway.yml"
2 changes: 2 additions & 0 deletions specification/api/components/endpoints/getLetterStatus.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,7 @@ responses:
$ref: "../responses/errors/tooManyRequests.yml"
"500":
$ref: "../responses/errors/serverError.yml"
"502":
$ref: "../responses/errors/badGateway.yml"
tags:
- letter
2 changes: 2 additions & 0 deletions specification/api/components/endpoints/listLetters.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,5 @@ responses:
$ref: "../responses/errors/tooManyRequests.yml"
'500':
$ref: "../responses/errors/serverError.yml"
'502':
$ref: "../responses/errors/badGateway.yml"
2 changes: 2 additions & 0 deletions specification/api/components/endpoints/patchLetter.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,7 @@ responses:
$ref: "../responses/errors/tooManyRequests.yml"
"500":
$ref: "../responses/errors/serverError.yml"
"502":
$ref: "../responses/errors/badGateway.yml"
tags:
- letter
2 changes: 2 additions & 0 deletions specification/api/components/endpoints/postLetters.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,5 @@ responses:
$ref: "../responses/errors/tooManyRequests.yml"
'500':
$ref: "../responses/errors/serverError.yml"
'502':
$ref: "../responses/errors/badGateway.yml"
8 changes: 8 additions & 0 deletions specification/api/components/responses/errors/badGateway.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
description: "Bad gateway"
content:
application/vnd.api+json:
schema:
$ref: "../../schemas/apiGatewayError.yml"
examples:
error-bad-request:
$ref: ../../examples/errors/responses/bad-gateway.json
29 changes: 27 additions & 2 deletions specification/api/components/responses/errors/tooManyRequests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,33 @@
description: Too many requests
content:
application/vnd.api+json:
application/json:
schema:
$ref: "../../schemas/errorResponse.yml"
type: object
properties:
message:
type: string
example: "Your application has exceeded its quota"
scope:
type: string
example: "application"
policy:
type: string
example: "quota"
limit:
type: integer
example: 300
interval:
type: integer
example: 1
timeunit:
type: string
example: "minute"
ratelimiting_expiry_time_ms:
type: integer
example: 1625498765123
message_id:
type: string
example: "rrt-4773181658036170775-c-geu2-321623-73628915-2"
examples:
error-too-many-requests:
$ref: ../../examples/errors/responses/tooManyRequests.json
9 changes: 9 additions & 0 deletions specification/api/components/schemas/apiGatewayError.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
description: API gateway error response
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: "Bad Gateway"
Loading