Marry errors with OAS

Author: francisco-videira-nhs

lambdas/api-handler/src/contracts/errors.ts

@@ -26,7 +26,7 @@ export enum ApiErrorStatus {
 }
 
 export enum ApiErrorDetail {
-  NotFoundLetterId = 'The provided letter ID does not exist for the supplier',
+  NotFoundLetterId = 'No resource found with that ID',
   InvalidRequestMissingSupplierId = 'The supplier ID is missing from the request',
   InvalidRequestMissingBody = 'The request is missing the body',
   InvalidRequestMissingLetterIdPathParameter = 'The request is missing the letter id path parameter',

lambdas/api-handler/src/mappers/__tests__/error-mapper.test.ts

@@ -35,7 +35,7 @@ describe("mapErrorToResponse", () => {
       "errors": [
         {
           "code": "NOTIFY_LETTER_NOT_FOUND",
-          "detail": "The provided letter ID does not exist for the supplier",
+          "detail": "No resource found with that ID",
           "id": expect.any(String),
           "links": {
             "about": "https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier"

lambdas/api-handler/src/services/__tests__/letter-operations.test.ts

@@ -87,7 +87,7 @@ describe('patchLetterStatus function', () => {
       updateLetterStatus: jest.fn().mockRejectedValue(new Error('Letter with id l1 not found for supplier s1'))
     };
 
-    await expect(patchLetterStatus(letterResource, 'letter1', 'supplier1', mockRepo as any)).rejects.toThrow("The provided letter ID does not exist");
+    await expect(patchLetterStatus(letterResource, 'letter1', 'supplier1', mockRepo as any)).rejects.toThrow("No resource found with that ID");
   });
 
   it('should throw unexpected error', async () => {

specification/api/components/endpoints/patchLetter.yml

@@ -7,7 +7,7 @@ responses:
   "200":
     $ref: "../responses/patchLetter200.yml"
   "400":
-    $ref: "../responses/errors/badRequest.yml"
+    $ref: "../responses/errors/patchLetter/patchLetterBadRequest.yml"
   "404":
     $ref: "../responses/errors/resourceNotFound.yml"
   "429":

specification/api/components/examples/errors/responses/patchLetter/invalidBody.json

@@ -0,0 +1,14 @@
+{
+  "errors": [
+    {
+      "code": "NOTIFY_INVALID_REQUEST",
+      "detail": "The request body is invalid",
+      "id": "rrt-1931948104716186917-c-geu2-10664-3111479-3.0",
+      "links": {
+        "about": "https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier"
+      },
+      "status": "400",
+      "title": "Invalid request"
+    }
+  ]
+}

specification/api/components/responses/errors/patchLetter/patchLetterBadRequest.yml

@@ -0,0 +1,9 @@
+description: "Bad request, invalid input data"
+content:
+  application/vnd.api+json:
+    schema:
+      $ref: "../../../schemas/errorResponse.yml"
+    examples:
+      error-bad-request-invalid-request-body:
+        value:
+          $ref: ../../../examples/errors/responses/patchLetter/invalidBody.json