apib2swagger 1.16.1 → 1.17.1

package/.github/workflows/nodejs.yml

@@ -9,7 +9,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [14.x, 16.x, 18.x]
+        node-version: [18.x, 20.x]
 
     steps:
     - uses: actions/checkout@v1

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:16-alpine
+FROM node:18-alpine
 
 RUN npm install -g apib2swagger
 

package/README.md

@@ -14,7 +14,7 @@ Supported versions:
     - [Include directive](https://github.com/danielgtaylor/aglio#including-files)
 - Swagger 2.0
 - OpenAPI 3.0.3
-- Node.js 14.x, 16.x, 18.x or higher
+- Node.js 18.x, 20.x or higher
 
 ## Install
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apib2swagger",
-  "version": "1.16.1",
+  "version": "1.17.1",
   "description": "Convert API Blueprint to Swagger.",
   "bin": "./bin/apib2swagger.js",
   "scripts": {

package/src/mson_to_json_schema.js

@@ -32,7 +32,7 @@ function convert(mson, options) {
                 return { type: 'array', items: { 'anyOf': mson.content.map((m) => convert(m, options)) } };
             }
         case 'enum':
-            return convertEnum(mson.content);
+            return convertEnum(mson.content, componentsPath);
         case 'object':
             break;
         case 'boolean':
@@ -98,19 +98,38 @@ function convert(mson, options) {
     return schema;
 }
 
-function convertEnum(contents) {
+function convertEnum(contents, componentsPath) {
     if (!contents) return null
-    var schema = { type: '', enum: [] };
+    const schemaList = []
     for (var i = 0; i < contents.length; i++) {
         var content = contents[i];
-        if (!schema.type) {
-            schema.type = content.element;
-        } else if (schema.type != content.element) {
-            // WARN!! mixed type enum
+        switch (content.element) {
+        case "boolean":
+        case "string":
+        case "number":
+        case "array":
+        case "enum": // TODO
+        case "object":
+            let schema = schemaList.find(v => v.type === content.element)
+            if (!schema) {
+                schema = { type: content.element, enum: [] }
+                schemaList.push(schema)
+            }
+            schema.enum.push(content.content)
+            break
+        default: // CustomType
+            schemaList.push({ '$ref': componentsPath + escapeJSONPointer(content.element) })
+            break
         }
-        schema.enum.push(content.content);
     }
-    return schema;
+    switch (schemaList.length) {
+    case 0:
+        return {}
+    case 1:
+        return schemaList[0]
+    default:
+        return { oneOf: schemaList}
+    }
 }
 
 module.exports = convertMsonToJsonSchema;

package/src/requests.js

@@ -308,6 +308,8 @@ module.exports.processRequests = (operation, action, context) => {
 
     let bodyExamples = {}
 
+    if (!openApi3) operation.consumes = []
+
     for (var j = 0; j < action.examples.length; j++) {
         var example = action.examples[j];
         for (var l = 0; l < example.requests.length; l++) {
@@ -320,8 +322,14 @@ module.exports.processRequests = (operation, action, context) => {
                 operation.parameters = mergeHeaders(headers, operation.parameters, options)
             }
          
+            var contentType = 'application/json'
             const contentTypeHeader = request.headers.find((h) => h.name === 'Content-Type')
-            const contentType = contentTypeHeader ? contentTypeHeader.value : 'application/json'
+            if (contentTypeHeader) {
+                contentType = contentTypeHeader.value
+                if (!openApi3 && !operation.consumes.includes(contentType)) {
+                    operation.consumes.push(contentType)
+                }
+            }
 
             if (request.body && openApi3) {
                 bodyExamples = buildBodyExamples(request.body, bodyExamples, contentType)
@@ -346,12 +354,19 @@ module.exports.processRequests = (operation, action, context) => {
             }
         }
     }
-    if (openApi3 && (schema.length || Object.keys(bodyExamples).length)){  
+    if (openApi3 && (schema.length || Object.keys(bodyExamples).length)) {  
         operation.requestBody = { content: {} }
         if (Object.keys(bodyExamples).length) {
             operation.requestBody.content = bodyExamples
         }
     }
-  
+    if (!openApi3) {
+        for (var s of schema) {
+            if (!operation.consumes.includes(s.contentType)) {
+                operation.consumes.push(s.contentType)
+            }
+        }
+    }
+ 
     return openApi3 ? setOpenApiRequestSchema(operation, schema) : setSwaggerRequestSchema(operation, schema)
 }

package/src/responses.js

@@ -3,6 +3,7 @@ const escapeJSONPointer = require('./escape_json_pointer')
 const isEqual = require('lodash.isequal')
 const http = require('http')
 const toOpenApi = require('json-schema-to-openapi-schema')
+const generateSchema = require('generate-schema')
 
 const parseResponseSchema = (schema, options) => {
     if (!schema) return
@@ -71,9 +72,20 @@ const setResponseSchema = (responses, response, schema, options) => {
         responses[response.name].schema = schema
         return responses
     }
+    if (schema.type === 'extend') { // Workaround for invalid JSON schema
+        if (schema.enum.length > 0) {
+            schema = generateSchema.json('', schema.enum[0])
+        } else {
+            schema.type = 'object'
+        }
+    }
     // Convert JSON Schema draft04 to OpenAPI 3.0.x (type: null -> nullable: true)
     // TODO: Skip this for OpenAPI 3.1.x or later.
-    schema = toOpenApi(schema)
+    try {
+        schema = toOpenApi(schema)
+    } catch (e) {
+        return responses // TODO: Handle error
+    }
 
     // In openAPI 3 the schema lives under the content type
     const contentTypeHeader = response.headers.find((h) => h.name.toLowerCase() === 'content-type')

package/test/input/Issue-#72.md

@@ -0,0 +1,43 @@
+### Create a user [POST /api/scim/v2/Users]
+
++ Request
+    + Headers
+
+            Content-Type: application/scim+json
+            Authorization: Bearer token
+
+    + Body
+
+            {
+                "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
+                "userName": "fredsmith",
+                "name": {
+                    "givenName": "Fred",
+                    "familyName": "Smith"
+                },
+                "emails": [
+                    {"primary": true, "value": "fred@example.com", "type": "work"}
+                ],
+                "displayName": "Fred Smith",
+                "externalId": "fred-external-id",
+                "active": true
+            }
+
++ Response 201 (application/scim+json)
+
+    + Attributes (ExistingUser)
+
+### Create a user 2 [POST /api2/scim/v2/Users]
+
++ Request
+    + Headers
+
+            Content-Type: application/scim+json
+            Authorization: Bearer token
+
++ Response 201 (application/scim+json)
+
+    + Attributes (ExistingUser)
+
+# Data Structures
+## ExistingUser

package/test/input/OpenAPI3_Issue-#73.md

@@ -0,0 +1,21 @@
+FORMAT: 1A
+HOST: http://127.0.0.1/api/v1
+
+# Group Extensions
+
+## Extensions [/extensions]
+
+### Get extensions [GET]
+
++ Response 200 (application/json)
+    + Attributes (Extension)
+
+## Data Structures
+
+### Extension (enum)
+
++ (Foo type)
+
+### Foo type (object, fixed-type)
+
++ id (string) - the id

package/test/output/01. Simplest API.json

@@ -24,7 +24,8 @@
         "parameters": [],
         "produces": [
           "text/plain"
-        ]
+        ],
+        "consumes": []
       }
     }
   },

package/test/output/01. Simplest API.ref.json

@@ -24,7 +24,8 @@
         "parameters": [],
         "produces": [
           "text/plain"
-        ]
+        ],
+        "consumes": []
       }
     }
   },

package/test/output/02. Resource and Actions.json

@@ -24,7 +24,8 @@
         "parameters": [],
         "produces": [
           "text/plain"
-        ]
+        ],
+        "consumes": []
       },
       "put": {
         "responses": {
@@ -38,7 +39,10 @@
         "operationId": "",
         "description": "OK, let's add another action. This time to put new data to our resource (essentially an update action). We will need to send something in a [request](http://www.w3.org/TR/di-gloss/#def-http-request) and then send a response back confirming the posting was a success (HTTP Status Code 204 ~ Resource updated successfully, no content is returned).",
         "tags": [],
-        "parameters": []
+        "parameters": [],
+        "consumes": [
+          "text/plain"
+        ]
       }
     }
   },

package/test/output/02. Resource and Actions.ref.json

@@ -24,7 +24,8 @@
         "parameters": [],
         "produces": [
           "text/plain"
-        ]
+        ],
+        "consumes": []
       },
       "put": {
         "responses": {
@@ -38,7 +39,10 @@
         "operationId": "",
         "description": "OK, let's add another action. This time to put new data to our resource (essentially an update action). We will need to send something in a [request](http://www.w3.org/TR/di-gloss/#def-http-request) and then send a response back confirming the posting was a success (HTTP Status Code 204 ~ Resource updated successfully, no content is returned).",
         "tags": [],
-        "parameters": []
+        "parameters": [],
+        "consumes": [
+          "text/plain"
+        ]
       }
     }
   },

package/test/output/03. Named Resource and Actions.json

@@ -24,7 +24,8 @@
         "parameters": [],
         "produces": [
           "text/plain"
-        ]
+        ],
+        "consumes": []
       },
       "put": {
         "responses": {
@@ -38,7 +39,10 @@
         "operationId": "Update a Message",
         "description": "`Update a message` - nice and simple naming is the best way to go.",
         "tags": [],
-        "parameters": []
+        "parameters": [],
+        "consumes": [
+          "text/plain"
+        ]
       }
     }
   },

package/test/output/03. Named Resource and Actions.ref.json

@@ -24,7 +24,8 @@
         "parameters": [],
         "produces": [
           "text/plain"
-        ]
+        ],
+        "consumes": []
       },
       "put": {
         "responses": {
@@ -38,7 +39,10 @@
         "operationId": "Update a Message",
         "description": "`Update a message` - nice and simple naming is the best way to go.",
         "tags": [],
-        "parameters": []
+        "parameters": [],
+        "consumes": [
+          "text/plain"
+        ]
       }
     }
   },

package/test/output/04. Grouping Resources.json

@@ -26,7 +26,8 @@
         "parameters": [],
         "produces": [
           "text/plain"
-        ]
+        ],
+        "consumes": []
       },
       "put": {
         "responses": {
@@ -42,7 +43,10 @@
         "tags": [
           "Messages"
         ],
-        "parameters": []
+        "parameters": [],
+        "consumes": [
+          "text/plain"
+        ]
       }
     }
   },

package/test/output/04. Grouping Resources.ref.json

@@ -26,7 +26,8 @@
         "parameters": [],
         "produces": [
           "text/plain"
-        ]
+        ],
+        "consumes": []
       },
       "put": {
         "responses": {
@@ -42,7 +43,10 @@
         "tags": [
           "Messages"
         ],
-        "parameters": []
+        "parameters": [],
+        "consumes": [
+          "text/plain"
+        ]
       }
     }
   },

package/test/output/05. Responses.json

@@ -43,7 +43,8 @@
         "parameters": [],
         "produces": [
           "application/json"
-        ]
+        ],
+        "consumes": []
       },
       "put": {
         "responses": {
@@ -59,7 +60,10 @@
         "tags": [
           "Messages"
         ],
-        "parameters": []
+        "parameters": [],
+        "consumes": [
+          "text/plain"
+        ]
       }
     }
   },

package/test/output/05. Responses.ref.json

@@ -43,7 +43,8 @@
         "parameters": [],
         "produces": [
           "application/json"
-        ]
+        ],
+        "consumes": []
       },
       "put": {
         "responses": {
@@ -59,7 +60,10 @@
         "tags": [
           "Messages"
         ],
-        "parameters": []
+        "parameters": [],
+        "consumes": [
+          "text/plain"
+        ]
       }
     }
   },

package/test/output/06. Requests.json

@@ -52,7 +52,8 @@
         ],
         "produces": [
           "application/json"
-        ]
+        ],
+        "consumes": []
       },
       "put": {
         "responses": {
@@ -84,6 +85,10 @@
               }
             }
           }
+        ],
+        "consumes": [
+          "text/plain",
+          "application/json"
         ]
       }
     }

package/test/output/06. Requests.ref.json

@@ -52,7 +52,8 @@
         ],
         "produces": [
           "application/json"
-        ]
+        ],
+        "consumes": []
       },
       "put": {
         "responses": {
@@ -84,6 +85,10 @@
               }
             }
           }
+        ],
+        "consumes": [
+          "text/plain",
+          "application/json"
         ]
       }
     }

package/test/output/07. Parameters.json

@@ -65,7 +65,8 @@
         ],
         "produces": [
           "application/json"
-        ]
+        ],
+        "consumes": []
       },
       "put": {
         "responses": {
@@ -105,6 +106,10 @@
               }
             }
           }
+        ],
+        "consumes": [
+          "text/plain",
+          "application/json"
         ]
       }
     },
@@ -182,7 +187,8 @@
         ],
         "produces": [
           "application/json"
-        ]
+        ],
+        "consumes": []
       }
     }
   },

package/test/output/07. Parameters.ref.json

@@ -65,7 +65,8 @@
         ],
         "produces": [
           "application/json"
-        ]
+        ],
+        "consumes": []
       },
       "put": {
         "responses": {
@@ -105,6 +106,10 @@
               }
             }
           }
+        ],
+        "consumes": [
+          "text/plain",
+          "application/json"
         ]
       }
     },
@@ -182,7 +187,8 @@
         ],
         "produces": [
           "application/json"
-        ]
+        ],
+        "consumes": []
       }
     }
   },

package/test/output/08. Attributes.json

@@ -41,7 +41,8 @@
         "tags": [
           "Coupons"
         ],
-        "parameters": []
+        "parameters": [],
+        "consumes": []
       }
     }
   },

package/test/output/08. Attributes.ref.json

@@ -44,7 +44,8 @@
         "tags": [
           "Coupons"
         ],
-        "parameters": []
+        "parameters": [],
+        "consumes": []
       }
     }
   },

package/test/output/09. Advanced Attributes.json

@@ -59,7 +59,8 @@
         ],
         "produces": [
           "application/json"
-        ]
+        ],
+        "consumes": []
       }
     },
     "/coupons": {
@@ -102,7 +103,8 @@
         ],
         "produces": [
           "application/json"
-        ]
+        ],
+        "consumes": []
       },
       "post": {
         "responses": {
@@ -165,6 +167,9 @@
         ],
         "produces": [
           "application/json"
+        ],
+        "consumes": [
+          "application/json"
         ]
       }
     }

package/test/output/09. Advanced Attributes.ref.json

@@ -42,7 +42,8 @@
         ],
         "produces": [
           "application/json"
-        ]
+        ],
+        "consumes": []
       }
     },
     "/coupons": {
@@ -84,7 +85,8 @@
         ],
         "produces": [
           "application/json"
-        ]
+        ],
+        "consumes": []
       },
       "post": {
         "responses": {
@@ -130,6 +132,9 @@
         ],
         "produces": [
           "application/json"
+        ],
+        "consumes": [
+          "application/json"
         ]
       }
     }

package/test/output/10. Data Structures.json

@@ -59,7 +59,8 @@
         ],
         "produces": [
           "application/json"
-        ]
+        ],
+        "consumes": []
       }
     },
     "/coupons": {
@@ -102,7 +103,8 @@
         ],
         "produces": [
           "application/json"
-        ]
+        ],
+        "consumes": []
       },
       "post": {
         "responses": {
@@ -156,6 +158,9 @@
         ],
         "produces": [
           "application/json"
+        ],
+        "consumes": [
+          "application/json"
         ]
       }
     }