Merge pull request #705 from NHSDigital/feature/made14-NRL-1007-reqid-required-in-spec

[NRL-1007] Make X-Request-Id a required header in the API spec

Author: mattdean3-nhs

api/consumer/record-locator/consumer.yaml

@@ -1582,7 +1582,7 @@ components:
 
         Mirrored back in a response header.
       in: header
-      required: false
+      required: true
       schema:
         $ref: "#/components/schemas/RequestHeaderRequestId"
     correlationId:
@@ -1625,4 +1625,4 @@ components:
         pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
         example: 60E0B220-8136-4CA5-AE46-1D97EF59D068
         description: |
-          The X-Request-ID from the request header, if supplied, mirrored back.
+          The X-Request-ID from the request header mirrored back.

api/consumer/swagger.yaml

@@ -1529,7 +1529,7 @@ components:
 
         Mirrored back in a response header.
       in: header
-      required: false
+      required: true
       schema:
         $ref: "#/components/schemas/RequestHeaderRequestId"
     correlationId:
@@ -1572,4 +1572,4 @@ components:
         pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
         example: 60E0B220-8136-4CA5-AE46-1D97EF59D068
         description: |
-          The X-Request-ID from the request header, if supplied, mirrored back.
+          The X-Request-ID from the request header mirrored back.

api/producer/record-locator/producer.yaml

@@ -2158,7 +2158,7 @@ components:
 
         Mirrored back in a response header.
       in: header
-      required: false
+      required: true
       schema:
         $ref: "#/components/schemas/RequestHeaderRequestId"
     correlationId:
@@ -2211,4 +2211,4 @@ components:
         pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
         example: 60E0B220-8136-4CA5-AE46-1D97EF59D068
         description: |
-          The X-Request-ID from the request header, if supplied, mirrored back.
+          The X-Request-ID from the request header mirrored back.

api/producer/swagger.yaml

@@ -2034,7 +2034,7 @@ components:
 
         Mirrored back in a response header.
       in: header
-      required: false
+      required: true
       schema:
         $ref: "#/components/schemas/RequestHeaderRequestId"
     correlationId:
@@ -2087,4 +2087,4 @@ components:
         pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
         example: 60E0B220-8136-4CA5-AE46-1D97EF59D068
         description: |
-          The X-Request-ID from the request header, if supplied, mirrored back.
+          The X-Request-ID from the request header mirrored back.

swagger/consumer-static/components.yaml

@@ -67,7 +67,7 @@ components:
 
         Mirrored back in a response header.
       in: header
-      required: false
+      required: true
       schema:
         $ref: "#/components/schemas/RequestHeaderRequestId"
     correlationId:
@@ -177,4 +177,4 @@ components:
         pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
         example: 60E0B220-8136-4CA5-AE46-1D97EF59D068
         description: |
-          The X-Request-ID from the request header, if supplied, mirrored back.
+          The X-Request-ID from the request header mirrored back.

swagger/producer-static/components.yaml

@@ -49,7 +49,7 @@ components:
 
         Mirrored back in a response header.
       in: header
-      required: false
+      required: true
       schema:
         $ref: "#/components/schemas/RequestHeaderRequestId"
     correlationId:
@@ -214,4 +214,4 @@ components:
         pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
         example: 60E0B220-8136-4CA5-AE46-1D97EF59D068
         description: |
-          The X-Request-ID from the request header, if supplied, mirrored back.
+          The X-Request-ID from the request header mirrored back.

swagger/producer-static/narrative.yaml

@@ -1271,4 +1271,4 @@ components:
       schema:
         example: 60E0B220-8136-4CA5-AE46-1D97EF59D068
         description: |
-          The X-Request-ID from the request header, if supplied, mirrored back.
+          The X-Request-ID from the request header mirrored back.