CCM-11580: OAS syntax fixes

m-houston · m-houston · commit 5937fa42bc32 · 2025-09-03T12:54:23.000+01:00
Remove 'requestedProductionStatus' from letter-related JSON schemas and update examples to singular form
diff --git a/lambdas/api-handler/src/handlers/hello-world.ts b/lambdas/api-handler/src/handlers/hello-world.ts
diff --git a/specification/api/components/examples/createMI/requests/createMIRequest.json b/specification/api/components/examples/createMI/requests/createMIRequest.json
diff --git a/specification/api/components/examples/createMI/responses/createMIResponse.json b/specification/api/components/examples/createMI/responses/createMIResponse.json
diff --git a/specification/api/components/examples/getLetter/responses/getLetter.json b/specification/api/components/examples/getLetter/responses/getLetter.json
@@ -3,7 +3,6 @@
     "attributes": {
       "reasonCode": 100,
       "reasonText": "failed validation",
-      "requestedProductionStatus": "ACTIVE",
       "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
       "status": "REJECTED"
     },
diff --git a/specification/api/components/examples/getLetters/responses/getLetters.json b/specification/api/components/examples/getLetters/responses/getLetters.json
@@ -2,7 +2,6 @@
   "data": [
     {
       "attributes": {
-        "requestedProductionStatus": "ACTIVE",
         "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
         "status": "PENDING"
       },
diff --git a/specification/api/components/examples/patchLetter/requests/patchLetter.json b/specification/api/components/examples/patchLetter/requests/patchLetter.json
@@ -3,7 +3,6 @@
     "attributes": {
       "reasonCode": 100,
       "reasonText": "failed validation",
-      "requestedProductionStatus": "ACTIVE",
       "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
       "status": "REJECTED"
     },
diff --git a/specification/api/components/examples/patchLetter/responses/patchLetter.json b/specification/api/components/examples/patchLetter/responses/patchLetter.json
@@ -3,7 +3,6 @@
     "attributes": {
       "reasonCode": 100,
       "reasonText": "failed validation",
-      "requestedProductionStatus": "ACTIVE",
       "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
       "status": "REJECTED"
     },
diff --git a/specification/api/components/examples/postLetter/requests/postLetter.json b/specification/api/components/examples/postLetter/requests/postLetter.json
@@ -4,7 +4,6 @@
       "attributes": {
         "reasonCode": 100,
         "reasonText": "failed validation",
-        "requestedProductionStatus": "ACTIVE",
         "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
         "status": "REJECTED"
       },
diff --git a/specification/api/components/examples/postLetter/responses/postLetter.json b/specification/api/components/examples/postLetter/responses/postLetter.json
@@ -4,7 +4,6 @@
       "attributes": {
         "reasonCode": 100,
         "reasonText": "failed validation",
-        "requestedProductionStatus": "ACTIVE",
         "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
         "status": "REJECTED"
       },
diff --git a/specification/api/components/parameters/correlationId.yml b/specification/api/components/parameters/correlationId.yml
@@ -6,5 +6,4 @@ description: |-
 required: false
 schema:
   type: string
-  examples:
-    - 11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA
+  example: 11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA
diff --git a/specification/api/components/parameters/requestId.yml b/specification/api/components/parameters/requestId.yml
@@ -4,5 +4,4 @@ description: 'Unique request identifier, in the format of a GUID'
 required: true
 schema:
   type: string
-  examples:
-    - dcb9c8dc-c2f4-4d5f-8674-a2e913e040b2
+  example: dcb9c8dc-c2f4-4d5f-8674-a2e913e040b2
diff --git a/specification/api/components/requests/patchLetterRequest.yml b/specification/api/components/requests/patchLetterRequest.yml
@@ -8,5 +8,4 @@ content:
           $ref: ../schemas/letterUpdateItem.yml
     examples:
       patch-letter-request:
-        value:
-          $ref: ../examples/patchLetter/requests/patchLetter.json
+        $ref: ../examples/patchLetter/requests/patchLetter.json
diff --git a/specification/api/components/requests/postLetterRequest.yml b/specification/api/components/requests/postLetterRequest.yml
@@ -10,5 +10,4 @@ content:
             $ref: ../schemas/letterUpdateItem.yml
     examples:
       post-letter-request:
-        value:
-          $ref: ../examples/postLetter/requests/postLetter.json
+        $ref: ../examples/postLetter/requests/postLetter.json
diff --git a/specification/api/components/requests/postMIRequest.yml b/specification/api/components/requests/postMIRequest.yml
@@ -4,6 +4,5 @@ content:
     schema:
       $ref: ../schemas/miData.yml
     examples:
-      create-mi:
-        value:
-          $ref: "../examples/createMI/requests/createMI.json"
+      create-mi-request:
+        $ref: "../examples/createMI/requests/createMIRequest.json"
diff --git a/specification/api/components/responses/errors/badRequest.yml b/specification/api/components/responses/errors/badRequest.yml
@@ -5,5 +5,4 @@ content:
       $ref: "../../schemas/errorResponse.yml"
     examples:
       error-bad-request:
-        value:
-          $ref: ../../examples/errors/responses/badRequest.json
+        $ref: ../../examples/errors/responses/badRequest.json
diff --git a/specification/api/components/responses/errors/resourceNotFound.yml b/specification/api/components/responses/errors/resourceNotFound.yml
@@ -5,5 +5,4 @@ content:
       $ref: "../../schemas/errorResponse.yml"
     examples:
       error-not-found:
-        value:
-          $ref: ../../examples/errors/responses/resourceNotFound.json
+        $ref: ../../examples/errors/responses/resourceNotFound.json
diff --git a/specification/api/components/responses/errors/serverError.yml b/specification/api/components/responses/errors/serverError.yml
@@ -5,5 +5,4 @@ content:
       $ref: "../../schemas/errorResponse.yml"
     examples:
       error-server-error:
-        value:
-          $ref: ../../examples/errors/responses/serverError.json
+        $ref: ../../examples/errors/responses/serverError.json
diff --git a/specification/api/components/responses/errors/tooManyRequests.yml b/specification/api/components/responses/errors/tooManyRequests.yml
@@ -5,5 +5,4 @@ content:
       $ref: "../../schemas/errorResponse.yml"
     examples:
       error-too-many-requests:
-        value:
-          $ref: ../../examples/errors/responses/tooManyRequests.json
+        $ref: ../../examples/errors/responses/tooManyRequests.json
diff --git a/specification/api/components/responses/getLetter200.yml b/specification/api/components/responses/getLetter200.yml
@@ -5,5 +5,4 @@ content:
       $ref: "../schemas/letterStatusData.yml"
     examples:
       get-letters:
-        value:
-          $ref: ../examples/getLetter/responses/getLetter.json
+        $ref: ../examples/getLetter/responses/getLetter.json
diff --git a/specification/api/components/responses/getLetters200.yml b/specification/api/components/responses/getLetters200.yml
@@ -5,5 +5,4 @@ content:
       $ref: "../schemas/lettersListResponse.yml"
     examples:
       get-letters:
-        value:
-          $ref: ../examples/getLetters/responses/getLetters.json
+        $ref: ../examples/getLetters/responses/getLetters.json
diff --git a/specification/api/components/responses/getMI200.yml b/specification/api/components/responses/getMI200.yml
@@ -5,5 +5,4 @@ content:
       $ref: "../schemas/miResponse.yml"
     examples:
       get-mi:
-        value:
-          $ref: ../examples/getMI/responses/getMI.json
+        $ref: ../examples/getMI/responses/getMI.json
diff --git a/specification/api/components/responses/getMIList200.yml b/specification/api/components/responses/getMIList200.yml
@@ -5,5 +5,4 @@ content:
       $ref: "../schemas/miListResponse.yml"
     examples:
       list-mi:
-        value:
-          $ref: "../examples/listMI/responses/listMI.json"
+        $ref: "../examples/listMI/responses/listMI.json"
diff --git a/specification/api/components/responses/patchLetter200.yml b/specification/api/components/responses/patchLetter200.yml
@@ -5,5 +5,4 @@ content:
       $ref: "../schemas/letterStatusData.yml"
     examples:
       patch_letter-response:
-        value:
-          $ref: ../examples/patchLetter/responses/patchLetter.json
+        $ref: ../examples/patchLetter/responses/patchLetter.json
diff --git a/specification/api/components/responses/postLetters200.yml b/specification/api/components/responses/postLetters200.yml
@@ -5,5 +5,4 @@ content:
       $ref: "../schemas/postLetterResponse.yml"
     examples:
       post-letters-responses:
-        value:
-          $ref: "../examples/postLetter/responses/postLetter.json"
+        $ref: "../examples/postLetter/responses/postLetter.json"
diff --git a/specification/api/components/responses/postMI201.yml b/specification/api/components/responses/postMI201.yml
@@ -4,6 +4,5 @@ content:
     schema:
       $ref: "../schemas/miItem.yml"
     examples:
-      create-mi:
-        value:
-          $ref: "../examples/createMI/responses/createMI.json"
+      create-mi-response:
+        $ref: "../examples/createMI/responses/createMIResponse.json"
diff --git a/specification/api/components/schemas/dataItem.yml b/specification/api/components/schemas/dataItem.yml
@@ -2,11 +2,10 @@ type: object
 properties:
   type:
     type: string
-    const: Data
+    enum: [Data]
   id:
     type: string
-    examples:
-      - 2WL5eYSWGzCHlGmzNxuqVusPxDg
+    example: 2WL5eYSWGzCHlGmzNxuqVusPxDg
   attributes:
     type: object
     properties:
diff --git a/specification/api/components/schemas/letterItem.yml b/specification/api/components/schemas/letterItem.yml
@@ -2,11 +2,10 @@ type: object
 properties:
   type:
     type: string
-    const: Letter
+    enum: [Letter]
   id:
     type: string
-    examples:
-      - 2WL5eYSWGzCHlGmzNxuqVusPxDg
+    example: 2WL5eYSWGzCHlGmzNxuqVusPxDg
   attributes:
     type: object
     required:
@@ -15,19 +14,14 @@ properties:
     properties:
       specificationId:
         type: string
-        examples:
-          - 2WL5eYSWGzCHlGmzNxuqVusPxDg
+        example: 2WL5eYSWGzCHlGmzNxuqVusPxDg
       status:
         $ref: "./letterStatus.yml"
-      requestedProductionStatus:
-        $ref: "./productionStatus.yml"
       reasonCode:
         type: number
         description: Reason code for the given status
-        examples:
-          - 100
+        example: 100
       reasonText:
         type: string
         description: Reason text for the given status
-        examples:
-          - failed validation
+        example: failed validation
diff --git a/specification/api/components/schemas/letterStatus.yml b/specification/api/components/schemas/letterStatus.yml
@@ -13,6 +13,5 @@ enum:
   - DESTROYED
   - FORWARDED
 description: The supplier status of an individual letter
-examples:
-  - PENDING
+example: PENDING
 default: PENDING
diff --git a/specification/api/components/schemas/letterUpdateItem.yml b/specification/api/components/schemas/letterUpdateItem.yml
@@ -2,32 +2,23 @@ type: object
 properties:
   type:
     type: string
-    const: Letter
+    enum: [Letter]
   id:
     type: string
-    examples:
-      - 2WL5eYSWGzCHlGmzNxuqVusPxDg
+    example: 2WL5eYSWGzCHlGmzNxuqVusPxDg
   attributes:
     type: object
     properties:
       specificationId:
         type: string
-        examples:
-          - 2WL5eYSWGzCHlGmzNxuqVusPxDg
+        example: 2WL5eYSWGzCHlGmzNxuqVusPxDg
       status:
         $ref: "./letterStatus.yml"
-      requestedProductionStatus:
-        $ref: "./productionStatus.yml"
-        description: |-
-          The requested production status for this letter.
-          May only be set by NHS Notify.
       reasonCode:
         type: number
         description: Reason code for the given status
-        examples:
-          - 100
+        example: 100
       reasonText:
         type: string
         description: Reason text for the given status
-        examples:
-          - failed validation
+        example: failed validation
diff --git a/specification/api/components/schemas/miData.yml b/specification/api/components/schemas/miData.yml
@@ -5,7 +5,7 @@ properties:
     properties:
       type:
         type: string
-        const: ManagementInformation
+        enum: [ManagementInformation]
       attributes:
         type: object
         properties:
diff --git a/specification/api/components/schemas/miItem.yml b/specification/api/components/schemas/miItem.yml
@@ -2,7 +2,7 @@ type: object
 properties:
   type:
     type: string
-    const: ManagementInformation
+    enum: [ManagementInformation]
   id:
     type: string
     example: 2WL5eYSWGzCHlGmzNxuqVusPxDg
diff --git a/specification/api/components/schemas/productionStatus.yml b/specification/api/components/schemas/productionStatus.yml
@@ -4,6 +4,5 @@ enum:
   - HOLD
   - CANCEL
 description: A requested status for the production of a letter
-examples:
-  - ACTIVE
+example: ACTIVE
 title: ProductionStatus

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,6 @@`
`2`	`2`	`"data": [`
`3`	`3`	`{`
`4`	`4`	`"attributes": {`
`5`		`- "requestedProductionStatus": "ACTIVE",`
`6`	`5`	`"specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",`
`7`	`6`	`"status": "PENDING"`
`8`	`7`	`},`