Merge branch 'release'

NHSDigital · Jun 7, 2024 · 8275a7b · 8275a7b
2 parents acc7cac + 6a444d1
commit 8275a7b
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 5 deletions.
diff --git a/specification/schemas/enums/ErrorInvalidValue.yaml b/specification/schemas/enums/ErrorInvalidValue.yaml
@@ -8,5 +8,5 @@ enum:
   - CM_TOO_FEW_ITEMS
   - CM_ODS_CODE_REQUIRED
   - CM_CANNOT_SET_ODS_CODE
-example: CM_MISSING_VALUE
+example: CM_INVALID_NHS_NUMBER
 title: Enum_Error_InvalidValue
diff --git a/specification/schemas/responses/errors/message_batches/UnableToProcessBatch.yaml b/specification/schemas/responses/errors/message_batches/UnableToProcessBatch.yaml
@@ -15,7 +15,7 @@ properties:
         code:
           $ref: ../../../enums/ErrorInvalidValue.yaml
         links:
-          $ref: ../../../types/LinksError.yaml
+          $ref: ../../../types/LinksErrorNHSNumber.yaml
         status:
           type: string
           enum:

diff --git a/specification/schemas/responses/errors/messages/UnableToProcessMessage.yaml b/specification/schemas/responses/errors/messages/UnableToProcessMessage.yaml
@@ -15,7 +15,7 @@ properties:
         code:
           $ref: ../../../enums/ErrorInvalidValue.yaml
         links:
-          $ref: ../../../types/LinksError.yaml
+          $ref: ../../../types/LinksErrorNHSNumber.yaml
         status:
           type: string
           enum:

diff --git a/specification/schemas/types/LinksError.yaml b/specification/schemas/types/LinksError.yaml
@@ -3,8 +3,7 @@ additionalProperties: false
 properties:
   about:
     type: string
-    enum:
-      - 'https://digital.nhs.uk/developer/api-catalogue/communications-manager'
     format: uri
     example: 'https://digital.nhs.uk/developer/api-catalogue/communications-manager'
+    description: 'https://digital.nhs.uk/developer/api-catalogue/communications-manager'
 minProperties: 1
diff --git a/specification/schemas/types/LinksErrorNHSNumber.yaml b/specification/schemas/types/LinksErrorNHSNumber.yaml
@@ -0,0 +1,14 @@
+type: object
+additionalProperties: false
+properties:
+  about:
+    type: string
+    format: uri
+    example: 'https://digital.nhs.uk/developer/api-catalogue/communications-manager'
+    description: 'https://digital.nhs.uk/developer/api-catalogue/communications-manager'
+  nhsNumbers:
+    type: string
+    format: uri
+    example: 'https://www.datadictionary.nhs.uk/attributes/nhs_number.html'
+    description: https://www.datadictionary.nhs.uk/attributes/nhs_number.html This link is only provided in the instance of a "CM_INVALID_NHS_NUMBER" error.
+minProperties: 1