post review changes and return x headers

nhsd-david-wass · nhsd-david-wass · commit e0136f70f5d6 · 2025-10-01T09:16:10.000+01:00
diff --git a/sandbox/api/openapi.yaml b/sandbox/api/openapi.yaml
diff --git a/sandbox/controllers/Controller.js b/sandbox/controllers/Controller.js
@@ -13,7 +13,7 @@ class Controller {
     */
     Object.entries(payload.headers).forEach(([name, value]) => response.setHeader(name, String(value)));
     response.status(payload.code || 200);
-    const responsePayload = payload.payload !== undefined ? payload.payload : payload;
+    const responsePayload = payload.body !== undefined ? payload.body : payload;
     if (responsePayload instanceof Object) {
       response.json(responsePayload);
     } else {
@@ -92,12 +92,13 @@ class Controller {
 
     if (request.openapi.schema.parameters !== undefined) {
       request.openapi.schema.parameters.forEach((param) => {
+
         if (param.in === 'path') {
           requestParams[param.name] = request.openapi.pathParams[param.name];
         } else if (param.in === 'query') {
           requestParams[param.name] = request.query[param.name];
         } else if (param.in === 'header') {
-          requestParams[param.name] = request.headers[param.name];
+          requestParams[camelCase(param.name)] = request.headers[param.name.toLowerCase()];
         }
       });
     }
diff --git a/sandbox/data/examples/getLetter/responses/getLetter-24L5eYSWGzCHlGmzNxuqVusPxDg.json b/sandbox/data/examples/getLetter/responses/getLetter-24L5eYSWGzCHlGmzNxuqVusPxDg.json
@@ -1,6 +1,7 @@
 {
   "data": {
     "attributes": {
+      "groupId": "c5d93f917f5546d08beccf770a915d96",
       "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
       "status": "PENDING"
     },
diff --git a/sandbox/data/examples/getLetter/responses/getLetter-2AL5eYSWGzCHlGmzNxuqVusPxDg.json b/sandbox/data/examples/getLetter/responses/getLetter-2AL5eYSWGzCHlGmzNxuqVusPxDg.json
@@ -1,6 +1,7 @@
 {
   "data": {
     "attributes": {
+      "groupId": "c5d93f917f5546d08beccf770a915d96",
       "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
       "status": "ACCEPTED"
     },
diff --git a/sandbox/data/examples/getLetter/responses/getLetter-2BL5eYSWGzCHlGmzNxuqVusPxDg.json b/sandbox/data/examples/getLetter/responses/getLetter-2BL5eYSWGzCHlGmzNxuqVusPxDg.json
@@ -1,6 +1,7 @@
 {
   "data": {
     "attributes": {
+      "groupId": "c5d93f917f5546d08beccf770a915d96",
       "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
       "status": "PRINTED"
     },
diff --git a/sandbox/data/examples/getLetter/responses/getLetter-2CL5eYSWGzCHlGmzNxuqVusPxDg.json b/sandbox/data/examples/getLetter/responses/getLetter-2CL5eYSWGzCHlGmzNxuqVusPxDg.json
@@ -1,6 +1,7 @@
 {
   "data": {
     "attributes": {
+      "groupId": "c5d93f917f5546d08beccf770a915d96",
       "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
       "status": "ENCLOSED"
     },
diff --git a/sandbox/data/examples/getLetter/responses/getLetter-2DL5eYSWGzCHlGmzNxuqVusPxDg.json b/sandbox/data/examples/getLetter/responses/getLetter-2DL5eYSWGzCHlGmzNxuqVusPxDg.json
@@ -1,6 +1,7 @@
 {
   "data": {
     "attributes": {
+      "groupId": "c5d93f917f5546d08beccf770a915d96",
       "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
       "status": "DISPATCHED"
     },
diff --git a/sandbox/data/examples/getLetter/responses/getLetter-2EL5eYSWGzCHlGmzNxuqVusPxDg.json b/sandbox/data/examples/getLetter/responses/getLetter-2EL5eYSWGzCHlGmzNxuqVusPxDg.json
@@ -1,6 +1,7 @@
 {
   "data": {
     "attributes": {
+      "groupId": "c5d93f917f5546d08beccf770a915d96",
       "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
       "status": "DELIVERED"
     },
diff --git a/sandbox/data/examples/getLetter/responses/getLetter-2WL5eYSWGzCHlGmzNxuqVusPxDg.json b/sandbox/data/examples/getLetter/responses/getLetter-2WL5eYSWGzCHlGmzNxuqVusPxDg.json
@@ -1,6 +1,7 @@
 {
   "data": {
     "attributes": {
+      "groupId": "c5d93f917f5546d08beccf770a915d96",
       "reasonCode": 100,
       "reasonText": "failed validation",
       "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
diff --git a/sandbox/data/examples/getLetter/responses/getLetter-2XL5eYSWGzCHlGmzNxuqVusPxDg.json b/sandbox/data/examples/getLetter/responses/getLetter-2XL5eYSWGzCHlGmzNxuqVusPxDg.json
@@ -1,8 +1,8 @@
 {
   "data": {
     "attributes": {
+      "groupId": "c5d93f917f5546d08beccf770a915d96",
       "reasonCode": 100,
-      "reasonText": "failed validation",
       "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
       "status": "CANCELLED"
     },
diff --git a/sandbox/data/examples/getLetter/responses/getLetter-2YL5eYSWGzCHlGmzNxuqVusPxDg.json b/sandbox/data/examples/getLetter/responses/getLetter-2YL5eYSWGzCHlGmzNxuqVusPxDg.json
@@ -1,6 +1,7 @@
 {
   "data": {
     "attributes": {
+      "groupId": "c5d93f917f5546d08beccf770a915d96",
       "reasonCode": 100,
       "reasonText": "failed validation",
       "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
diff --git a/sandbox/data/examples/getLetter/responses/getLetter-2ZL5eYSWGzCHlGmzNxuqVusPxDg.json b/sandbox/data/examples/getLetter/responses/getLetter-2ZL5eYSWGzCHlGmzNxuqVusPxDg.json
@@ -1,6 +1,7 @@
 {
   "data": {
     "attributes": {
+      "groupId": "c5d93f917f5546d08beccf770a915d96",
       "reasonCode": 100,
       "reasonText": "failed validation",
       "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
diff --git a/sandbox/services/DataService.js b/sandbox/services/DataService.js
@@ -9,23 +9,22 @@ const ResponseProvider = require('../utils/ResponseProvider');
 * Fetch a data file
 *
 * id String Unique identifier of this resource
-* xRequestID String Unique request identifier, in the format of a GUID
-* xCorrelationID String An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header. (optional)
+* xRequestId String Unique request identifier, in the format of a GUID
+* xCorrelationId String An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header. (optional)
 * no response value expected for this operation
 * */
-const getDataId = ({ id, xRequestID, xCorrelationID }) => new Promise(
+const getDataId = ({ id, xRequestId, xCorrelationId }) => new Promise(
   async (resolve, reject) => {
     try {
       const responseData = await ResponseProvider.getLetterDataResponse(id);
-      if ((responseData.responseCode) >= 300 && (responseData.responseCode < 400))
-      {
-        resolve(Service.successResponse(null, responseData.responseCode, { Location: responseData.responsePath }));
-      }else{
+      if ((responseData.responseCode) >= 300 && (responseData.responseCode < 400)) {
+        resolve(Service.successResponse({ xRequestId, xCorrelationId }, responseData.responseCode, { Location: responseData.responsePath }));
+      } else {
         const content = await fs.readFile(responseData.responsePath);
         const fileData = JSON.parse(content);
         resolve(Service.successResponse({
-          xRequestID,
-          xCorrelationID,
+          xRequestId,
+          xCorrelationId,
           data: fileData,
         }, responseData.responseCode));
       }
@@ -41,19 +40,18 @@ const getDataId = ({ id, xRequestID, xCorrelationID }) => new Promise(
 * Check for the existence of a data file
 *
 * id String Unique identifier of this resource
-* xRequestID String Unique request identifier, in the format of a GUID
-* xCorrelationID String An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header. (optional)
+* xRequestId String Unique request identifier, in the format of a GUID
+* xCorrelationId String An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header. (optional)
 * no response value expected for this operation
 * */
-const headDataId = ({ id, xRequestID, xCorrelationID }) => new Promise(
+const headDataId = ({ id, xRequestId, xCorrelationId }) => new Promise(
   async (resolve, reject) => {
     try {
       responseData = await ResponseProvider.getLetterDataResponse(id);
-      if ((responseData.responseCode >= 300) && (responseData.responseCode < 400))
-      {
-        resolve(Service.successResponse(null, 200));
-      }else{
-        resolve(Service.successResponse(null, 404));
+      if ((responseData.responseCode >= 300) && (responseData.responseCode < 400)) {
+        resolve(Service.successResponse({ xRequestId, xCorrelationId }, 200));
+      } else {
+        resolve(Service.successResponse({ xRequestId, xCorrelationId }, 404));
       }
     } catch (e) {
       reject(Service.rejectResponse(
diff --git a/sandbox/services/LetterService.js b/sandbox/services/LetterService.js
@@ -8,21 +8,21 @@ const ResponseProvider = require('../utils/ResponseProvider');
 * Retrieve the status of a letter
 * Get details the status of a letter.
 *
-* xRequestID String Unique request identifier, in the format of a GUID
+* xRequestId String Unique request identifier, in the format of a GUID
 * id String Unique identifier of this resource
-* xCorrelationID String An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header. (optional)
+* xCorrelationId String An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header. (optional)
 * returns getLetterStatus_200_response
 * */
-const getLetterStatus = ({ xRequestID, id, xCorrelationID }) => new Promise(
+const getLetterStatus = ({ xRequestId, id, xCorrelationId }) => new Promise(
   async (resolve, reject) => {
     try {
       const responseData = await ResponseProvider.getLetterStatusResponse(id);
       const content = await fs.readFile(responseData.responsePath);
 
       const fileData = JSON.parse(content);
       resolve(Service.successResponse({
-        xRequestID,
-        xCorrelationID,
+        xRequestId,
+        xCorrelationId,
         data: fileData,
       }, responseData.responseCode));
     } catch (e) {
@@ -37,12 +37,12 @@ const getLetterStatus = ({ xRequestID, id, xCorrelationID }) => new Promise(
 * Get a list of PENDING letters
 * The key use of this endpoint is to query letters which are ready to be printed
 *
-* xRequestID String Unique request identifier, in the format of a GUID
-* xCorrelationID String An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header. (optional)
+* xRequestId String Unique request identifier, in the format of a GUID
+* xCorrelationId String An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header. (optional)
 * limit BigDecimal The maximum number of items to return in a single request (optional)
 * returns listLetters_200_response
 * */
-const listLetters = ({ xRequestID, xCorrelationID, limit = 10 }) => new Promise(
+const listLetters = ({ xRequestId, xCorrelationId, limit = 10 }) => new Promise(
   async (resolve, reject) => {
     try {
       const responseData = await ResponseProvider.getLettersResponse(limit);
@@ -56,8 +56,8 @@ const listLetters = ({ xRequestID, xCorrelationID, limit = 10 }) => new Promise(
       }
 
       resolve(Service.successResponse({
-        xRequestID,
-        xCorrelationID,
+        xRequestId,
+        xCorrelationId,
         data: fileData,
       }, responseData.responseCode));
     } catch (e) {
@@ -72,13 +72,13 @@ const listLetters = ({ xRequestID, xCorrelationID, limit = 10 }) => new Promise(
 * Update the status of a letter
 * Update the status of a letter by providing the new status in the request body.
 *
-* xRequestID String Unique request identifier, in the format of a GUID
+* xRequestId String Unique request identifier, in the format of a GUID
 * id String Unique identifier of this resource
 * patchLettersRequest PatchLettersRequest
-* xCorrelationID String An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header. (optional)
+* xCorrelationId String An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header. (optional)
 * returns getLetterStatus_200_response
 * */
-const patchLetters = ({ xRequestID, id, body, xCorrelationID }) => new Promise(
+const patchLetters = ({ xRequestId, id, body, xCorrelationId }) => new Promise(
   async (resolve, reject) => {
     try {
       const responseData = await ResponseProvider.patchLettersResponse(body);
@@ -87,8 +87,8 @@ const patchLetters = ({ xRequestID, id, body, xCorrelationID }) => new Promise(
 
 
       resolve(Service.successResponse({
-        xRequestID,
-        xCorrelationID,
+        xRequestId,
+        xCorrelationId,
         data: fileData,
       }, responseData.responseCode));
     } catch (e) {
@@ -102,21 +102,21 @@ const patchLetters = ({ xRequestID, id, body, xCorrelationID }) => new Promise(
 /**
 * Update the status of multiple letters
 *
-* xRequestID String Unique request identifier, in the format of a GUID
+* xRequestId String Unique request identifier, in the format of a GUID
 * postLettersRequest PostLettersRequest
-* xCorrelationID String An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header. (optional)
+* xCorrelationId String An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header. (optional)
 * returns listLetters_200_response
 * */
-const postLetters = ({ xRequestID, body, xCorrelationID }) => new Promise(
+const postLetters = ({ xRequestId, body, xCorrelationId }) => new Promise(
   async (resolve, reject) => {
     const responseData = await ResponseProvider.postLettersResponse(body);
     const content  = await fs.readFile(responseData.responsePath);
     const fileData = JSON.parse(content);
 
     try {
       resolve(Service.successResponse({
-        xRequestID,
-        xCorrelationID,
+        xRequestId,
+        xCorrelationId,
         data: fileData,
       }, responseData.responseCode));
     } catch (e) {
diff --git a/sandbox/services/MiService.js b/sandbox/services/MiService.js
@@ -6,21 +6,21 @@ const ResponseProvider = require('../utils/ResponseProvider');
 /**
 * Create a new MI record
 *
-* xRequestID String Unique request identifier, in the format of a GUID
+* xRequestId String Unique request identifier, in the format of a GUID
 * createMIRequest CreateMIRequest
-* xCorrelationID String An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header. (optional)
+* xCorrelationId String An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header. (optional)
 * returns createMI_201_response
 * */
-const createMI = ({ xRequestID, body, xCorrelationID }) => new Promise(
+const createMI = ({ xRequestId, body, xCorrelationId }) => new Promise(
   async (resolve, reject) => {
     try {
       const responseData = await ResponseProvider.postMIResponse(body);
       const content  = await fs.readFile(responseData.responsePath);
       const fileData = JSON.parse(content);
 
       resolve(Service.successResponse({
-        xRequestID,
-        xCorrelationID,
+        xRequestId,
+        xCorrelationId,
         data: fileData,
       }, responseData.responseCode));
     } catch (e) {
diff --git a/sandbox/services/Service.js b/sandbox/services/Service.js
@@ -4,7 +4,19 @@ class Service {
   }
 
   static successResponse(payload, code = 200, headers = {}) {
-    return { payload, code, headers };
+    if (payload.xRequestId) {
+      headers['X-Request-ID'] = payload.xRequestId;
+    }
+    if (payload.xCorrelationId) {
+      headers['X-Correlation-ID'] = payload.xCorrelationId;
+    }
+
+    let body = {};
+    if (payload.data)
+    {
+      body = payload.data
+    }
+    return { body, code, headers };
   }
 }
 
diff --git a/sandbox/utils/ResponseProvider.js b/sandbox/utils/ResponseProvider.js
@@ -23,25 +23,21 @@ async function mapExampleResponse(requestBody, exampleResponseMap) {
             return response; // match found
           }
         } catch (err) {
-          console.error(`Failed to process ${requestBodyPath}:`, err);
           throw err;
         }
       }
-      return {responsePath:'data/examples/errors/responses/resourceNotFound.json',responseCode: 404}; // no match
+      return null; // no match
     })
   );
-
-  console.log('checks:', checks);
   // Find the first non-null result
-  return checks.find(result => result !== null) ?? null;
+  return checks.find(result => result !== null) ?? {responsePath:'data/examples/errors/responses/resourceNotFound.json',responseCode: 404};
 }
 
 function mapExampleGetResponse(parameterValue, exampleResponseMap) {
   const match = Object.entries(exampleResponseMap).find(([requestParameter, response]) => {
     try {
       return parameterValue === requestParameter;
     } catch (err) {
-      console.error(`Failed to process ${parameterValue}:`, err);
       throw err;
     }
   });
@@ -126,5 +122,6 @@ module.exports = {
   getLettersResponse,
   patchLettersResponse,
   postMIResponse,
-  getLetterDataResponse
+  getLetterDataResponse,
+  postLettersResponse
 };
diff --git a/sandbox/utils/openapiRouter.js b/sandbox/utils/openapiRouter.js
@@ -57,7 +57,6 @@ function openApiRouter() {
         await apiController[controllerOperation](request, response, next);
       }
     } catch (error) {
-      console.error(error);
       const err = { code: 500, error: error.message };
       handleError(err, request, response, next);
     }
diff --git a/specification/api/components/requests/postMIRequest.yml b/specification/api/components/requests/postMIRequest.yml
@@ -2,7 +2,7 @@ required: true
 content:
   application/vnd.api+json:
     schema:
-      $ref: ../schemas/miData.yml
+      $ref: ../schemas/miPostRequest.yml
     examples:
       create-mi-request-success:
         summary: Request for successful MI record Creation
diff --git a/specification/api/components/schemas/miData.yml b/specification/api/components/schemas/miData.yml
diff --git a/specification/api/components/schemas/miItem.yml b/specification/api/components/schemas/miItem.yml
diff --git a/specification/api/components/schemas/miPostRequest.yml b/specification/api/components/schemas/miPostRequest.yml
diff --git a/specification/api/components/schemas/miResponse.yml b/specification/api/components/schemas/miResponse.yml

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"data": {`
`3`	`3`	`"attributes": {`
	`4`	`+ "groupId": "c5d93f917f5546d08beccf770a915d96",`
`4`	`5`	`"specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",`
`5`	`6`	`"status": "PENDING"`
`6`	`7`	`},`