CCM-13554 - APIM Errors not serializing (#300)

* CCM-13554 - APIM Errors not serializing

* CCM-13554 - Update 429 response

* 502 error from api gateway

* revert rate limiting

* remove created yml files

Author: nhsd-david-wass

sandbox/data/examples/errors/responses/bad-gateway.json

@@ -0,0 +1,3 @@
+{
+  "message": "Bad Gateway"
+}

sandbox/data/examples/errors/responses/tooManyRequests.json

@@ -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"
 }

specification/api/components/endpoints/createMI.yml

@@ -15,3 +15,5 @@ responses:
     $ref: "../responses/errors/tooManyRequests.yml"
   '500':
     $ref: "../responses/errors/serverError.yml"
+  '502':
+    $ref: "../responses/errors/badGateway.yml"

specification/api/components/endpoints/getDataId.yml

@@ -13,3 +13,5 @@ responses:
     $ref: "../responses/errors/tooManyRequests.yml"
   "500":
     $ref: "../responses/errors/serverError.yml"
+  "502":
+    $ref: "../responses/errors/badGateway.yml"

specification/api/components/endpoints/getLetterStatus.yml

@@ -11,5 +11,7 @@ responses:
     $ref: "../responses/errors/tooManyRequests.yml"
   "500":
     $ref: "../responses/errors/serverError.yml"
+  "502":
+    $ref: "../responses/errors/badGateway.yml"
 tags:
   - letter

specification/api/components/endpoints/listLetters.yml

@@ -18,3 +18,5 @@ responses:
     $ref: "../responses/errors/tooManyRequests.yml"
   '500':
     $ref: "../responses/errors/serverError.yml"
+  '502':
+    $ref: "../responses/errors/badGateway.yml"

specification/api/components/endpoints/patchLetter.yml

@@ -15,5 +15,7 @@ responses:
     $ref: "../responses/errors/tooManyRequests.yml"
   "500":
     $ref: "../responses/errors/serverError.yml"
+  "502":
+    $ref: "../responses/errors/badGateway.yml"
 tags:
   - letter

specification/api/components/endpoints/postLetters.yml

@@ -15,3 +15,5 @@ responses:
     $ref: "../responses/errors/tooManyRequests.yml"
   '500':
     $ref: "../responses/errors/serverError.yml"
+  '502':
+    $ref: "../responses/errors/badGateway.yml"

specification/api/components/responses/errors/badGateway.yml

@@ -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

specification/api/components/responses/errors/tooManyRequests.yml

@@ -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