Feature/ccm 11662 sandbox examples 2 (#164)

* Sandbox examples for letters endpoint

* More examples

* CCM-12281: Extend documentation and examples for ManagementInformation in OAS spec

* Further examples and scripts

* sandbox examples should be source of truth

* Add groupid to MI data

* own review changes

* copy examples before build

* fix 405 errors

* move examples

* post review changes and return x headers

---------

Co-authored-by: Mike Houston <[email protected]>

Author: nhsd-david-wass

.gitignore

@@ -26,3 +26,4 @@ dist
 .reports
 /sandbox/*.log
 /sandbox-staging
+/specification/api/components/examples

Makefile

@@ -40,6 +40,7 @@ lint-oas:
 	npm run lint-oas
 
 publish-oas:
+	$(MAKE) copy-examples
 	npm run publish-oas
 
 set-target: guard-APIM_ENV
@@ -74,9 +75,11 @@ build-yml-oas-spec: guard-APIM_ENV
 	$(MAKE) bundle-oas
 
 serve-oas:
+	$(MAKE) copy-examples
 	npm run serve-oas
 
 bundle-oas:
+	$(MAKE) copy-examples
 	npm run bundle-oas
 
 generate-sandbox:
@@ -88,6 +91,9 @@ generate-sandbox:
 serve-swagger:
 	npm run serve-swagger-docs
 
+copy-examples:
+	cp -r ./sandbox/data/examples/. ./specification/api/components/examples
+
 config:: _install-dependencies version # Configure development environment (main) @Configuration
 	npm install
 	(cd docs && make install && cd ..)

package.json

@@ -47,7 +47,7 @@
   },
   "scripts": {
     "build": "npm run bundle-oas && npm run generate --buildver=$npm_config_buildver",
-    "bundle-oas": "mkdir -p build && redocly bundle specification/api/notify-supplier-phase1.yml --dereferenced -k --remove-unused-components --ext yml > build/notify-supplier.yml",
+    "bundle-oas": "cp -r sandbox/data/examples/. specification/api/components/examples && mkdir -p build && redocly bundle specification/api/notify-supplier-phase1.yml --dereferenced -k --remove-unused-components --ext yml > build/notify-supplier.yml",
     "generate": "npm run generate:cs --buildver=$npm_config_buildver && npm run generate:html && npm run generate:ts --buildver=$npm_config_buildver && npm run generate:python",
     "generate-dependencies": "npm run generate-dependencies --workspaces --if-present",
     "generate-sandbox": "openapi-generator-cli generate -g nodejs-express-server -i build/notify-supplier.json --skip-validate-spec -o sandbox-staging",

sandbox/api/openapi.yaml

@@ -2,7 +2,7 @@ const path = require('path');
 
 const config = {
   ROOT_DIR: __dirname,
-  URL_PORT: 3000,
+  URL_PORT: 9000,
   URL_PATH: 'http://127.0.0.1',
   BASE_VERSION: '',
   CONTROLLER_DIRECTORY: path.join(__dirname, 'controllers'),

sandbox/config.js

@@ -11,8 +11,9 @@ class Controller {
     * payload will be an object consisting of a code and a payload. If not customized
     * send 200 and the payload as received in this method.
     */
+    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 {
@@ -91,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()];
         }
       });
     }
@@ -105,7 +107,8 @@ class Controller {
 
   static async handleRequest(request, response, serviceOperation) {
     try {
-      const serviceResponse = await serviceOperation(this.collectRequestParams(request));
+      const requestParams = this.collectRequestParams(request);
+      const serviceResponse = await serviceOperation(requestParams);
       Controller.sendResponse(response, serviceResponse);
     } catch (error) {
       Controller.sendError(response, error);

sandbox/controllers/Controller.js

@@ -0,0 +1,13 @@
+{
+  "data": {
+    "attributes": {
+      "groupId": "abc123",
+      "lineItem": "envelope-business-standard",
+      "quantity": 22,
+      "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
+      "stockRemaining": 2000,
+      "timestamp": "yesterday"
+    },
+    "type": "ManagementInformation"
+  }
+}

sandbox/data/examples/createMI/requests/createMI_INVALID.json

@@ -1,11 +1,10 @@
 {
   "data": {
     "attributes": {
-      "cost": 10.25,
       "groupId": "abc123",
-      "lineItem": "Letter",
+      "lineItem": "envelope-business-standard",
       "quantity": 22,
-      "specificationId": "da0b1495-c7cb-468c-9d81-07dee089d728",
+      "specificationId": "123456",
       "stockRemaining": 2000,
       "timestamp": "2023-11-17T14:27:51.413Z"
     },

…s/createMI/requests/createMIRequest.json …createMI/requests/createMI_NOTFOUND.jsonspecification/api/components/examples/createMI/requests/createMIRequest.json renamed to sandbox/data/examples/createMI/requests/createMI_NOTFOUND.json specification/api/components/examples/createMI/requests/createMIRequest.json renamed to sandbox/data/examples/createMI/requests/createMI_NOTFOUND.json

@@ -1,10 +1,10 @@
 {
   "data": {
     "attributes": {
-      "cost": 10.25,
-      "lineItem": "Letter",
+      "groupId": "abc123",
+      "lineItem": "envelope-business-standard",
       "quantity": 22,
-      "specificationId": "da0b1495-c7cb-468c-9d81-07dee089d728",
+      "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
       "stockRemaining": 2000,
       "timestamp": "2023-11-17T14:27:51.413Z"
     },