Added dockerized node.js based tool to convert jsonschema files to openapi files (#252)

added tool to convert jsonschema to openapi schema in scripts folder
updated director accordingly
director test does not skip jsonschema anymore

Author: sanderegg

scripts/jsonschema/openapi_converter/Dockerfile

@@ -0,0 +1,27 @@
+# Docs:
+# This tool is based on [Phil Sturgeon blog](https://philsturgeon.uk/api/2018/04/13/openapi-and-json-schema-divergence-solved/)
+# and specifically on [json-schema-to-openapi-schema](https://github.com/wework/json-schema-to-openapi-schema)
+# 
+# The tool converts any .json file present in a specific input folder into openapi schema .yaml in a specific output folder
+
+# Usage: 
+# docker build -t json2openapiconverter .
+# docker run -v %INPUT_FOLDER%:/input -v %OUTPUT_FOLDER%:/output json2openapiconverter
+
+
+
+FROM node
+
+LABEL maintainer=sanderegg
+
+VOLUME [ "/input" ]
+VOLUME [ "/output" ]
+
+WORKDIR /src
+
+RUN npm install --save json-schema-to-openapi-schema && \
+    npm install --save js-yaml
+COPY converter.js /src/converter.js
+
+
+CMD [ "node", "/src/converter.js" ]

scripts/jsonschema/openapi_converter/converter.js

@@ -0,0 +1,34 @@
+const toOpenApi = require('json-schema-to-openapi-schema');
+
+const fs = require('fs');
+const path = require('path');
+const yaml = require('js-yaml')
+
+const inputPath = '/input';
+const outputPath = '/output/';
+
+
+const filenames =  fs.readdirSync(inputPath)    
+
+filenames.forEach(filepath => {
+  const extName = path.extname(filepath);
+  if (extName == ".json") {
+    console.log("converting " + filepath + "...");
+    const contents = fs.readFileSync(inputPath + "/" + filepath, 'utf8');    
+    const object = JSON.parse(contents);    
+    const convertedSchema = toOpenApi(object);
+    console.log("converted " + filepath + " succesfully");
+    
+    var yamlSchema = yaml.safeDump(convertedSchema)
+    // console.log(yamlSchema);
+    
+    // there is a BUG here. examples in a schema are not allowed in openapi, they should be replaced by example
+    // Note that schemas and properties support singular example but not plural examples.
+    // [link to problem](https://swagger.io/docs/specification/adding-examples/)
+    yamlSchema = yamlSchema.replace(/examples:\n/g, "example:\n");
+    // write as yaml
+    fs.writeFileSync(outputPath + path.basename(filepath, ".json") + ".yaml", yamlSchema);
+    // fs.writeFileSync(outputPath + "converted_" + filepath, JSON.stringify(convertedSchema));    
+  }
+  
+});

services/director/src/simcore_service_director/oas3/v1/components/parameters/assignment_uuid.yaml

@@ -0,0 +1,9 @@
+AssignmentUuid:
+  in: query
+  name: service_uuid
+  description: The uuid to assign the service with
+  required: true
+  schema:
+    type: string
+    format: uuid
+    example: 123e4567-e89b-12d3-a456-426655440000

services/director/src/simcore_service_director/oas3/v1/components/parameters/service_key.yaml

@@ -0,0 +1,9 @@
+ServiceKey:
+  in: query
+  name: service_key
+  description: The key (url) of the service
+  required: true
+  schema:
+    type: string   
+    format: url
+    example: simcore/services/dynamic/3d-viewer

services/director/src/simcore_service_director/oas3/v1/components/parameters/service_key_path.yaml

@@ -0,0 +1,9 @@
+ServiceKeyPath:
+  in: path
+  name: service_key
+  description: The key (url) of the service
+  required: true
+  schema:
+    type: string   
+    format: url
+    example: simcore/services/dynamic/3d-viewer

services/director/src/simcore_service_director/oas3/v1/components/parameters/service_type.yaml

@@ -0,0 +1,14 @@
+ServiceType:
+  in: query
+  name: service_type
+  description: |
+    The service type:
+      * computational - a computational service
+      * interactive - an interactive service
+  required: false
+  schema:
+    type: string          
+    enum: 
+      - computational
+      - interactive            
+    example: computational

services/director/src/simcore_service_director/oas3/v1/components/parameters/service_uuid.yaml

@@ -0,0 +1,9 @@
+ServiceUuid:
+  in: path
+  name: service_uuid
+  description: The uuid of the service
+  required: true
+  schema:
+    type: string
+    format: uuid
+    example: 123e4567-e89b-12d3-a456-426655440000

services/director/src/simcore_service_director/oas3/v1/components/parameters/service_version.yaml

@@ -0,0 +1,8 @@
+ServiceVersion:
+  in: query
+  name: service_tag
+  description: The tag/version of the service
+  required: false
+  schema:
+    type: string
+    example: "1.4"

services/director/src/simcore_service_director/oas3/v1/components/parameters/service_version_path.yaml

@@ -0,0 +1,8 @@
+ServiceVersionPath:
+  in: path
+  name: service_version
+  description: The tag/version of the service
+  required: true
+  schema:
+    type: string
+    example: "1.4"

services/director/src/simcore_service_director/oas3/v1/components/schemas/error.yaml

@@ -0,0 +1,30 @@
+ErrorEnveloped:
+  type: object
+  properties:
+    data:
+      $ref: '#/Error'
+    status:
+      type: integer
+      example: 404
+Error:
+  type: object
+  required:
+    - status
+    - message
+  properties:
+    message:
+      description: Error message
+      type: string
+      example: Unexpected error
+    errors:
+      type: array
+      items:
+        properties:
+          code:
+            type: string
+            description: Server Exception
+            example: ServiceUUIDNotFoundError
+    status:
+      description: Error code
+      type: integer
+      example: 404

services/director/src/simcore_service_director/oas3/v1/components/schemas/health_check.yaml

@@ -0,0 +1,23 @@
+HealthCheckEnveloped:
+  type: object
+  properties:
+    data:
+      $ref: '#/HealthCheck'
+    status:
+      type: integer
+      example: 200
+HealthCheck:
+  type: object
+  properties:
+    name:
+      type: string
+      example: director service
+    status:
+      type: string
+      example: SERVICE_RUNNING
+    api_version:
+      type: string
+      example: 1.0.0-dev
+    version:
+      type: string
+      example: 1dfcfdc