CCM-11580: Update sandbox endpoints to match OAS

Author: m-houston

sandbox/api/openapi.yaml

@@ -12,17 +12,7 @@ const createMI = async (request, response) => {
   await Controller.handleRequest(request, response, service.createMI);
 };
 
-const getMi = async (request, response) => {
-  await Controller.handleRequest(request, response, service.getMi);
-};
-
-const listMi = async (request, response) => {
-  await Controller.handleRequest(request, response, service.listMi);
-};
-
 
 module.exports = {
   createMI,
-  getMi,
-  listMi,
 };

sandbox/controllers/MiController.js

@@ -12,7 +12,7 @@
     "swagger-ui-express": "^4.0.2",
     "winston": "^3.2.1"
   },
-  "description": "API for communication suppliers to integrate with NHS Notify",
+  "description": "API for communication suppliers to integrate with NHS Notify.  This specification represents the in-development 'next' version of the API schema and should be treated as unstable. ",
   "devDependencies": {
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
@@ -38,5 +38,5 @@
     "prestart": "npm install",
     "start": "node index.js"
   },
-  "version": "0.0.1"
+  "version": "next"
 }

sandbox/data/examples/getMI/responses/getMI.json

@@ -26,7 +26,7 @@ const getDataId = ({ id, xRequestID, xCorrelationID }) => new Promise(
   },
 );
 /**
-* Check for the existance of a data file
+* 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

sandbox/data/examples/listMI/responses/listMI.json

@@ -30,18 +30,18 @@ const getLetterStatus = ({ xRequestID, id, xCorrelationID }) => new Promise(
   },
 );
 /**
-* Get a list of letters
+* 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
-* status String Status of a letter
 * 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, status, xCorrelationID, page }) => new Promise(
+const listLetters = ({ xRequestID, xCorrelationID, limit }) => new Promise(
   async (resolve, reject) => {
     try {
-      const fileData = await ResponseProvider.getLettersResponse(status, page);
+      const fileData = await ResponseProvider.getLettersResponse('PENDING', limit);
 
       resolve(Service.successResponse({
         xRequestID,
@@ -66,11 +66,11 @@ const listLetters = ({ xRequestID, status, xCorrelationID, page }) => new Promis
 * 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, patchLettersRequest, xCorrelationID }) => new Promise(
   async (resolve, reject) => {
 
     try {
-      const fileData = await ResponseProvider.patchLettersResponse(body);
+      const fileData = await ResponseProvider.patchLettersResponse(patchLettersRequest);
 
       resolve(Service.successResponse({
         xRequestID,

sandbox/package.json

@@ -7,7 +7,7 @@ const Service = require('./Service');
 * 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)
-* returns listMi_200_response_data_inner
+* returns createMI_201_response
 * */
 const createMI = ({ xRequestID, createMIRequest, xCorrelationID }) => new Promise(
   async (resolve, reject) => {
@@ -25,55 +25,7 @@ const createMI = ({ xRequestID, createMIRequest, xCorrelationID }) => new Promis
     }
   },
 );
-/**
-* Fetch a specific MI record
-*
-* 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)
-* returns getMi_200_response
-* */
-const getMi = ({ xRequestID, id, xCorrelationID }) => new Promise(
-  async (resolve, reject) => {
-    try {
-      resolve(Service.successResponse({
-        xRequestID,
-        id,
-        xCorrelationID,
-      }));
-    } catch (e) {
-      reject(Service.rejectResponse(
-        e.message || 'Invalid input',
-        e.status || 405,
-      ));
-    }
-  },
-);
-/**
-* List MI Records
-*
-* 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)
-* returns listMi_200_response
-* */
-const listMi = ({ xRequestID, xCorrelationID }) => new Promise(
-  async (resolve, reject) => {
-    try {
-      resolve(Service.successResponse({
-        xRequestID,
-        xCorrelationID,
-      }));
-    } catch (e) {
-      reject(Service.rejectResponse(
-        e.message || 'Invalid input',
-        e.status || 405,
-      ));
-    }
-  },
-);
 
 module.exports = {
   createMI,
-  getMi,
-  listMi,
 };