CCM-13152 - Upgrade redocly and fix example files (#252)

nhsd-david-wass · web-flow · commit 22df63edb47f · 2025-11-20T14:58:59.000Z
* CCM-13152 - Upgrade redocly and fix example files * moved copy examples to script
diff --git a/Makefile b/Makefile
@@ -94,7 +94,7 @@ serve-swagger:
 	npm run serve-swagger-docs
 
 copy-examples:
-	cp -r ./sandbox/data/examples/. ./specification/api/components/examples
+	@scripts/build/copy-examples.sh
 
 config:: _install-dependencies version # Configure development environment (main) @Configuration
 	npm install
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -10,7 +10,7 @@
   },
   "devDependencies": {
     "@openapitools/openapi-generator-cli": "^2.21.4",
-    "@redocly/cli": "^1.34.5",
+    "@redocly/cli": "^2.11.1",
     "@tsconfig/node22": "^22.0.2",
     "@types/jest": "^30.0.0",
     "@types/js-yaml": "^4.0.9",
diff --git a/sandbox/data/examples/createMI/requests/createMI_request_INVALID.json b/sandbox/data/examples/createMI/requests/createMI_request_INVALID.json
diff --git a/sandbox/data/examples/createMI/requests/createMI_request_NOTFOUND.json b/sandbox/data/examples/createMI/requests/createMI_request_NOTFOUND.json
diff --git a/sandbox/data/examples/createMI/requests/createMI_request_SUCCESS.json b/sandbox/data/examples/createMI/requests/createMI_request_SUCCESS.json
diff --git a/sandbox/data/examples/createMI/responses/createMI_response_SUCCESS.json b/sandbox/data/examples/createMI/responses/createMI_response_SUCCESS.json
diff --git a/sandbox/utils/ResponseProvider.js b/sandbox/utils/ResponseProvider.js
@@ -101,9 +101,9 @@ async function postLettersResponse(request) {
 
 async function postMIResponse(request) {
   const postMIFileMap = {
-    'data/examples/createMI/requests/createMI_SUCCESS.json': {responsePath: 'data/examples/createMI/responses/createMI_SUCCESS.json', responseCode: 200},
-    'data/examples/createMI/requests/createMI_INVALID.json': {responsePath:'data/examples/errors/responses/badRequest.json',responseCode: 400},
-    'data/examples/createMI/requests/createMI_NOTFOUND.json': {responsePath:'data/examples/errors/responses/resourceNotFound.json',responseCode: 404},
+    'data/examples/createMI/requests/createMI_request_SUCCESS.json': {responsePath: 'data/examples/createMI/responses/createMI_response_SUCCESS.json', responseCode: 200},
+    'data/examples/createMI/requests/createMI_request_INVALID.json': {responsePath:'data/examples/errors/responses/badRequest.json',responseCode: 400},
+    'data/examples/createMI/requests/createMI_request_NOTFOUND.json': {responsePath:'data/examples/errors/responses/resourceNotFound.json',responseCode: 404},
   };
   return await mapExampleResponse(request, postMIFileMap);
 }
diff --git a/scripts/build/copy-examples.sh b/scripts/build/copy-examples.sh
@@ -0,0 +1,6 @@
+find ./sandbox/data/examples -type f -name '*.json' \
+  | while read f; do \
+    out=./specification/api/components/examples/${f#./sandbox/data/examples/}; \
+    mkdir -p $(dirname $out); \
+    jq '{ value: . }' "$f" > "$out"; \
+  done
diff --git a/specification/api/components/requests/patchLetterRequest.yml b/specification/api/components/requests/patchLetterRequest.yml
@@ -10,53 +10,40 @@ content:
     examples:
       patch-letter-request-default:
         summary: Request for default (PENDING) update
-        value:
-          $ref: ../examples/patchLetter/requests/patchLetter_DEFAULT.json
+        $ref: ../examples/patchLetter/requests/patchLetter_DEFAULT.json
       patch-letter-request-pending:
         summary: Request for PENDING update
-        value:
-          $ref: ../examples/patchLetter/requests/patchLetter_PENDING.json
+        $ref: ../examples/patchLetter/requests/patchLetter_PENDING.json
       patch-letter-request-accepted:
         summary: Request for ACCEPTED update
-        value:
-          $ref: ../examples/patchLetter/requests/patchLetter_ACCEPTED.json
+        $ref: ../examples/patchLetter/requests/patchLetter_ACCEPTED.json
       patch-letter-request-rejected:
         summary: Request for REJECTED update
-        value:
-          $ref: ../examples/patchLetter/requests/patchLetter_REJECTED.json
+        $ref: ../examples/patchLetter/requests/patchLetter_REJECTED.json
       patch-letter-request-printed:
         summary: Request for PRINTED update
-        value:
-          $ref: ../examples/patchLetter/requests/patchLetter_PRINTED.json
+        $ref: ../examples/patchLetter/requests/patchLetter_PRINTED.json
       patch-letter-request-enclosed:
         summary: Request for ENCLOSED update
-        value:
-          $ref: ../examples/patchLetter/requests/patchLetter_ENCLOSED.json
+        $ref: ../examples/patchLetter/requests/patchLetter_ENCLOSED.json
       patch-letter-request-cancelled:
         summary: Request for CANCELLED update
-        value:
-          $ref: ../examples/patchLetter/requests/patchLetter_CANCELLED.json
+        $ref: ../examples/patchLetter/requests/patchLetter_CANCELLED.json
       patch-letter-request-dispatched:
         summary: Request for DISPATCHED update
-        value:
-          $ref: ../examples/patchLetter/requests/patchLetter_DISPATCHED.json
+        $ref: ../examples/patchLetter/requests/patchLetter_DISPATCHED.json
       patch-letter-request-delivered:
         summary: Request for DELIVERED update
-        value:
-          $ref: ../examples/patchLetter/requests/patchLetter_DELIVERED.json
+        $ref: ../examples/patchLetter/requests/patchLetter_DELIVERED.json
       patch-letter-request-failed:
         summary: Request for FAILED update
-        value:
-          $ref: ../examples/patchLetter/requests/patchLetter_FAILED.json
+        $ref: ../examples/patchLetter/requests/patchLetter_FAILED.json
       patch-letter-request-returned:
         summary: Request for RETURNED update
-        value:
-          $ref: ../examples/patchLetter/requests/patchLetter_RETURNED.json
+        $ref: ../examples/patchLetter/requests/patchLetter_RETURNED.json
       patch-letter-request-invalid:
         summary: Request for an invalid update
-        value:
-          $ref: ../examples/patchLetter/requests/patchLetter_INVALID.json
+        $ref: ../examples/patchLetter/requests/patchLetter_INVALID.json
       patch-letter-request-not-found:
         summary: Request for a non existant letter
-        value:
-          $ref: ../examples/patchLetter/requests/patchLetter_NOTFOUND.json
+        $ref: ../examples/patchLetter/requests/patchLetter_NOTFOUND.json
diff --git a/specification/api/components/requests/postLettersRequest.yml b/specification/api/components/requests/postLettersRequest.yml
@@ -11,5 +11,4 @@ content:
             $ref: ../schemas/letterUpdateItem.yml
     examples:
       post-letter-request:
-        value:
-          $ref: ../examples/postLetter/requests/postLetters.json
+        $ref: ../examples/postLetter/requests/postLetters.json
diff --git a/specification/api/components/requests/postMIRequest.yml b/specification/api/components/requests/postMIRequest.yml
@@ -5,13 +5,10 @@ content:
     examples:
       create-mi-request-success:
         summary: Request for successful MI record Creation
-        value:
-          $ref: "../examples/createMI/requests/createMI_SUCCESS.json"
+        $ref: "../examples/createMI/requests/createMI_request_SUCCESS.json"
       create-mi-request-invalid:
         summary: Invalid Request for MI record Creation
-        value:
-          $ref: "../examples/createMI/requests/createMI_INVALID.json"
+        $ref: "../examples/createMI/requests/createMI_request_INVALID.json"
       create-mi-request-notfound:
         summary: Request for MI record Creation for unknown spec
-        value:
-          $ref: "../examples/createMI/requests/createMI_NOTFOUND.json"
+        $ref: "../examples/createMI/requests/createMI_request_NOTFOUND.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/listLetters/listLettersBadRequest.yml b/specification/api/components/responses/errors/listLetters/listLettersBadRequest.yml
@@ -5,8 +5,6 @@ content:
       $ref: "../../../schemas/errorResponse.yml"
     examples:
       error-bad-request-unknown-parameter:
-        value:
-          $ref: ../../../examples/errors/responses/getLetter/unknownParameter.json
+        $ref: ../../../examples/errors/responses/getLetter/unknownParameter.json
       error-bad-request-invalid-limit:
-        value:
-          $ref: ../../../examples/errors/responses/getLetter/limitInvalidValue.json
+        $ref: ../../../examples/errors/responses/getLetter/limitInvalidValue.json
diff --git a/specification/api/components/responses/errors/patchLetter/patchLetterBadRequest.yml b/specification/api/components/responses/errors/patchLetter/patchLetterBadRequest.yml
@@ -5,5 +5,4 @@ content:
       $ref: "../../../schemas/errorResponse.yml"
     examples:
       error-bad-request-invalid-request-body:
-        value:
-          $ref: ../../../examples/errors/responses/patchLetter/invalidBody.json
+        $ref: ../../../examples/errors/responses/patchLetter/invalidBody.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
@@ -10,5 +10,4 @@ content:
       $ref: "../schemas/letterStatusData.yml"
     examples:
       get-letters:
-        value:
-          $ref: ../examples/getLetter/responses/getLetter-24L5eYSWGzCHlGmzNxuqVusPxDg.json
+        $ref: ../examples/getLetter/responses/getLetter-24L5eYSWGzCHlGmzNxuqVusPxDg.json
diff --git a/specification/api/components/responses/getLetters200.yml b/specification/api/components/responses/getLetters200.yml
@@ -10,5 +10,4 @@ content:
       $ref: "../schemas/lettersListResponse.yml"
     examples:
       get-letters:
-        value:
-          $ref: ../examples/getLetters/responses/getLetters_pending.json
+        $ref: ../examples/getLetters/responses/getLetters_pending.json
diff --git a/specification/api/components/responses/postMI201.yml b/specification/api/components/responses/postMI201.yml
@@ -10,5 +10,4 @@ content:
       $ref: "../schemas/miResponse.yml"
     examples:
       create-mi-response:
-        value:
-          $ref: "../examples/createMI/responses/createMI_SUCCESS.json"
+        $ref: "../examples/createMI/responses/createMI_response_SUCCESS.json"
diff --git a/specification/api/components/security-schemes/security-schemes.yml b/specification/api/components/security-schemes/security-schemes.yml
@@ -1 +1 @@
-$ref: security-schemes-prod.yml
+$ref: security-schemes-internal-dev-pr.yml
diff --git a/specification/api/components/security/security.yml b/specification/api/components/security/security.yml
@@ -1 +1 @@
-$ref: security-prod.yml
+$ref: security-internal-dev-pr.yml
diff --git a/specification/api/components/x-nhsd-apim/access.yml b/specification/api/components/x-nhsd-apim/access.yml
@@ -1 +1 @@
-$ref: access-prod.yml
+$ref: access-internal-dev-pr.yml
diff --git a/specification/api/components/x-nhsd-apim/target.yml b/specification/api/components/x-nhsd-apim/target.yml
@@ -1 +1 @@
-$ref: target-prod.yml
+$ref: target-internal-dev-pr.yml
