[ERSSUP-64293]-[]-[Replace speccy library]-[DMW]

package.json

@@ -3,16 +3,16 @@
   "version": "0.0.1",
   "description": "OAS (Swagger v3) API Definition for Template API",
   "scripts": {
-    "lint-oas": "node_modules/.bin/speccy lint -s openapi-tags -s operation-tags specification/e-referrals-service-api.yaml --skip default-and-example-are-redundant",
-    "publish": "mkdir -p build && node_modules/.bin/speccy resolve specification/e-referrals-service-api.yaml -i | poetry run python scripts/yaml2json.py | poetry run python scripts/set_version.py | poetry run python scripts/populate_placeholders.py > build/e-referrals-service-api.json",
-    "serve": "node_modules/.bin/speccy serve build/e-referrals-service-api.json",
+    "lint-oas": "redocly lint specification/e-referrals-service-api.yaml",
+    "publish": "mkdir -p build && redocly bundle specification/e-referrals-service-api.yaml --dereferenced --remove-unused-components --ext json | poetry run python scripts/set_version.py | poetry run python scripts/populate_placeholders.py > build/e-referrals-service-api.json",
+    "serve": "redocly preview-docs -p 5000 build/e-referrals-service-api.json",
     "check-licenses": "node_modules/.bin/license-checker --failOn GPL --failOn LGPL"
   },
   "author": "NHS Digital",
   "license": "MIT",
   "homepage": "https://github.com/NHSDigital/e-referrals-service-api",
   "dependencies": {
-    "speccy": "^0.11.0"
+    "@redocly/cli": "^1.0.0-beta.124"
   },
   "devDependencies": {
     "apigeetool": "^0.16.1",

redocly.yaml

@@ -0,0 +1,6 @@
+extends:
+  - recommended
+rules:
+  no-invalid-media-type-examples:
+    severity: off
+  info-license-url: off

specification/components/stu3/schemas/endpoints/a023-retrieve-a&g-worklist.yaml

@@ -55,7 +55,7 @@ requestBody:
       schema:
         $ref: '../eRS-FetchWorklist-Parameters.yaml'
       examples:
-        a&g-requests:
+        aAndg-requests:
           summary: Advice and guidance requests
           value:
             $ref: '../../examples/retrieveAdviceAndGuidanceWorklist/requests/MinimalAdviceAndGuidanceRequests.json'

specification/components/stu3/schemas/responses/maintainReferralLetter/200Response.yaml

@@ -14,6 +14,6 @@ content:
       $ref: '../../eRS-ReferralRequest.yaml'
     examples:
       withClinicalInformation:
-        summary: `ReferralRequest` with clinical information (2 files)
+        summary: "`ReferralRequest` with clinical information (2 files)"
         value:
           $ref: '../../../examples/maintainReferralLetter/responses/ReferralRequestWithMultipleDocumentReferences.json'

specification/components/stu3/schemas/responses/retrieveAdviceAndGuidanceRequest/200Response.yaml

@@ -18,6 +18,6 @@ content:
         value:
           $ref: '../../../examples/retrieveAdviceAndGuidanceRequest/responses/MinimalExample.json'
       with-attachment-file-reference:
-        summary: `CommunicationRequest` with attachment file reference
+        summary: "`CommunicationRequest` with attachment file reference"
         value:
           $ref: '../../../examples/retrieveAdviceAndGuidanceRequest/responses/WithAttachmentFileReference.json'

specification/components/stu3/schemas/responses/retrieveAdviceAndGuidanceWorklist/200Response.yaml

@@ -11,7 +11,7 @@ content:
     schema:
       $ref: '../../eRS-FetchWorklist-List.yaml'
     examples:
-      a&g-requests:
+      aAndg-requests:
         summary: Advice and guidance requests
         value:
           $ref: '../../../examples/retrieveAdviceAndGuidanceWorklist/responses/AdviceAndGuidanceRequests.json'

specification/components/stu3/schemas/responses/retrieveAppointment/200Response.yaml

@@ -14,34 +14,34 @@ content:
       $ref: '../../eRS-Appointment.yaml'
     examples:
       booked-dbs:
-        summary: `Appointment` booked to directly-bookable service
+        summary: "`Appointment` booked to directly-bookable service"
         value:
           $ref: '../../../examples/retrieveAppointment/responses/BookedDBS.json'
       booked-ibs:
-        summary: `Appointment` booked to indirectly-bookable service
+        summary: "`Appointment` booked to indirectly-bookable service"
         value:
           $ref: '../../../examples/retrieveAppointment/responses/BookedIBS.json'
       deferred-to-provider:
-        summary: `Appointment` deferred to service provider for booking
+        summary: "`Appointment` deferred to service provider for booking"
         value:
           $ref: '../../../examples/retrieveAppointment/responses/AppointmentDeferral.json'
       deferred-to-triage:
-        summary: `Appointment` sent for triage
+        summary: "`Appointment` sent for triage"
         value:
           $ref: '../../../examples/retrieveAppointment/responses/TriageDeferral.json'
       triage-response:
-        summary: `Appointment` triage response (Record Triage Outcome)
+        summary: "`Appointment` triage response (Record Triage Outcome)"
         value:
           $ref: '../../../examples/retrieveAppointment/responses/TriageResponse.json'
       cancel-appointment-action-later:
-        summary: `Appointment` Cancel Appointment, Action Later
+        summary: "`Appointment` Cancel Appointment, Action Later"
         value:
           $ref: '../../../examples/retrieveAppointment/responses/CAAL.json'
       cancelled:
-        summary: `Appointment` cancelled
+        summary: "`Appointment` cancelled"
         value:
           $ref: '../../../examples/retrieveAppointment/responses/Cancelled.json'
       converted-and-booked:
-        summary: `Appointment` converted from an Advice and Guidance Request and booked to a directly-bookable service
+        summary: "`Appointment` converted from an Advice and Guidance Request and booked to a directly-bookable service"
         value:
           $ref: '../../../examples/retrieveAppointment/responses/AandGConvertedToDBS.json'

specification/components/stu3/schemas/responses/retrieveReferralRequest/200Response.yaml

@@ -18,26 +18,26 @@ content:
         value:
           $ref: '../../../examples/retrieveReferralRequest/responses/Unbooked.json'
       booked-dbs:
-        summary: `ReferralRequest` booked to directly-bookable service
+        summary: A `ReferralRequest` booked to directly-bookable service
         value:
           $ref: '../../../examples/retrieveReferralRequest/responses/BookedDBS.json'
       booked-ibs:
-        summary: `ReferralRequest` booked to indirectly-bookable service
+        summary: A `ReferralRequest` booked to indirectly-bookable service
         value:
           $ref: '../../../examples/retrieveReferralRequest/responses/BookedIBS.json'
       deferred-to-provider:
-        summary: `ReferralRequest` deferred to service provider for booking
+        summary: A `ReferralRequest` deferred to service provider for booking
         value:
           $ref: '../../../examples/retrieveReferralRequest/responses/DeferredToProvider.json'
       converted-from-advice-and-guidance:
-        summary: `ReferralRequest` that was converted from an Advice and Guidance Request
+        summary: A `ReferralRequest` that was converted from an Advice and Guidance Request
         value:
           $ref: '../../../examples/retrieveReferralRequest/responses/ConvertedFromAdviceAndGuidance.json'
       with-related-referral:
-        summary: `ReferralRequest` with related ReferralRequest
+        summary: A `ReferralRequest` with related ReferralRequest
         value:
           $ref: '../../../examples/retrieveReferralRequest/responses/WithRelatedReferral.json'
       with-additional-requirements:
-        summary: `ReferralRequest` with additional requirements
+        summary: A `ReferralRequest` with additional requirements
         value:
           $ref: '../../../examples/retrieveReferralRequest/responses/WithAdditionalRequirements.json'