Update healthcare-worker-api.yaml

.github/workflows/publish-spec-uat.yml

@@ -23,6 +23,7 @@ jobs:
         run: |
           npx -y @redocly/cli bundle \
             specification/healthcare-worker-api.yaml \
+            -d \
             -o specification/healthcare-worker-api.resolved.json \
             --keep-url-references
           npx -y @redocly/cli lint --config redocly.yaml

.github/workflows/stage-1-commit.yaml

@@ -120,7 +120,7 @@ jobs:
     permissions:
       id-token: write
       contents: read
-    timeout-minutes: 2
+    timeout-minutes: 5
     steps:
       - name: "Checkout code"
         uses: actions/checkout@v4

.tool-versions

@@ -8,7 +8,7 @@ python 3.12
 # The section below is reserved for Docker image versions.
 
 # TODO: Move this section - consider using a different file for the repository template dependencies.
-# docker/ghcr.io/anchore/grype v0.69.1@sha256:d41fcb371d0af59f311e72123dff46900ebd6d0482391b5a830853ee4f9d1a76 # SEE: https://github.com/anchore/grype/pkgs/container/grype
+# docker/ghcr.io/anchore/grype v0.109.1@sha256:7d1d08f2d17a9080a23d46548b23df8fc369c9efbf0bb8cf7901dfb2eabfa41f # SEE: https://github.com/anchore/grype/pkgs/container/grype
 # docker/ghcr.io/anchore/syft v0.92.0@sha256:63c60f0a21efb13e80aa1359ab243e49213b6cc2d7e0f8179da38e6913b997e0 # SEE: https://github.com/anchore/syft/pkgs/container/syft
 # docker/ghcr.io/gitleaks/gitleaks v8.18.0@sha256:fd2b5cab12b563d2cc538b14631764a1c25577780e3b7dba71657d58da45d9d9 # SEE: https://github.com/gitleaks/gitleaks/pkgs/container/gitleaks
 # docker/ghcr.io/igorshubovych/markdownlint-cli v0.37.0@sha256:fb3e79946fce78e1cde84d6798c6c2a55f2de11fc16606a40d49411e281d950d # SEE: https://github.com/igorshubovych/markdownlint-cli/pkgs/container/markdownlint-cli

buildspecs/deploy.yml

@@ -25,11 +25,13 @@ phases:
       - chmod +x /usr/bin/yq
   pre_build:
     commands:
-      # Bundle the OpenAPI spec to inline all external references (e.g. externalValue example files).
+      # Bundle and dereference the OpenAPI spec before publication.
+      # Proxygen preserves response header names reliably when header component refs are already
+      # inlined under the response header map keys.
       # This resolved file is used by apim_instance_deploy.sh so that proxygen receives a fully
       # self-contained spec rather than one with unresolvable relative file paths.
       # --keep-url-references (-k) preserves the proxygen-managed security scheme $ref which must remain unresolved.
-      - npx -y @redocly/cli bundle specification/healthcare-worker-api.yaml -o specification/healthcare-worker-api.resolved.yaml --keep-url-references
+      - npx -y @redocly/cli bundle specification/healthcare-worker-api.yaml -d -o specification/healthcare-worker-api.resolved.yaml --keep-url-references
   build:
     commands:
       - cd infrastructure

specification/components/examples/GetHealthcareWorkerDetailsResponseError.json

@@ -0,0 +1,18 @@
+{
+  "resourceType": "OperationOutcome",
+  "issue": [
+    {
+      "severity": "error",
+      "code": "unknown",
+      "details": {
+        "coding": [
+          {
+            "system": "https://fhir.nhs.uk/STU3/ValueSet/Spine-ErrorOrWarningCode-1",
+            "code": "MISSING_VALUE",
+            "display": "Missing practitioner identifier"
+          }
+        ]
+      }
+    }
+  ]
+}

specification/components/examples/GetHealthcareWorkerRoleDetailsResponseError.json

@@ -0,0 +1,18 @@
+{
+  "resourceType": "OperationOutcome",
+  "issue": [
+    {
+      "severity": "error",
+      "code": "unknown",
+      "details": {
+        "coding": [
+          {
+            "system": "https://fhir.nhs.uk/STU3/ValueSet/Spine-ErrorOrWarningCode-1",
+            "code": "MISSING_VALUE",
+            "display": "Missing practitioner identifier"
+          }
+        ]
+      }
+    }
+  ]
+}

specification/components/headers/XCorrelationId.yaml

@@ -0,0 +1,5 @@
+description: |
+  The X-Correlation-Id from the request header, if supplied, mirrored back.
+schema:
+  type: string
+  example: 11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA

specification/components/headers/XRequestId.yaml

@@ -0,0 +1,6 @@
+description: |
+  The X-Request-Id from the request header, if supplied, mirrored back.
+schema:
+  type: string
+  format: uuid
+  example: '6d3d3674-7ce5-11ec-90d6-0242ac121234'