apib2swagger 1.15.0 → 1.17.0

package/.github/workflows/nodejs.yml

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

package/.travis.yml

@@ -1,6 +1,6 @@
 language: node_js
 node_js:
+  - "18"
   - "16"
   - "14"
-  - "12"
 after_success: npm run coverage

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 12.x, 14.x, 16.x or higher
+- Node.js 18.x, 20.x or higher
 
 ## Install
 

package/package.json

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

package/src/mson_to_json_schema.js

@@ -99,6 +99,7 @@ function convert(mson, options) {
 }
 
 function convertEnum(contents) {
+    if (!contents) return null
     var schema = { type: '', enum: [] };
     for (var i = 0; i < contents.length; i++) {
         var content = contents[i];

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

@@ -1,4 +1,4 @@
-const { fixArraySchema, hasFileRef, getRefFromInclude, searchDataStructure } = require('./util')
+const { fixArraySchema, hasFileRef, getRefFromInclude, searchDataStructure, generateSchemaFromExample } = require('./util')
 const escapeJSONPointer = require('./escape_json_pointer')
 const isEqual = require('lodash.isequal')
 const http = require('http')
@@ -58,6 +58,12 @@ const getResponseSchema = (response, options) => {
             };
         }
     }
+    for (let content of response.content) {
+        const schema = generateSchemaFromExample(response.headers, content.content, options)
+        if (schema) {
+            return schema
+        }
+    }
 }
 
 const setResponseSchema = (responses, response, schema, options) => {

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

@@ -6,3 +6,9 @@ FORMAT: 1A
 ## Config
 + alice (string, required) - information about alice
 + bob (string, required) - information about bob
+
+## Filter
++ status (array[enum])
+    + Members
+        + option1
+        + option2

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/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

@@ -20,6 +20,17 @@
               "application/json": {
                 "message": "Hello World!"
               }
+            },
+            "schema": {
+              "type": "object",
+              "properties": {
+                "message": {
+                  "type": "string"
+                }
+              },
+              "example": {
+                "message": "Hello World!"
+              }
             }
           }
         },
@@ -32,7 +43,8 @@
         "parameters": [],
         "produces": [
           "application/json"
-        ]
+        ],
+        "consumes": []
       },
       "put": {
         "responses": {
@@ -48,7 +60,10 @@
         "tags": [
           "Messages"
         ],
-        "parameters": []
+        "parameters": [],
+        "consumes": [
+          "text/plain"
+        ]
       }
     }
   },

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

@@ -20,6 +20,17 @@
               "application/json": {
                 "message": "Hello World!"
               }
+            },
+            "schema": {
+              "type": "object",
+              "properties": {
+                "message": {
+                  "type": "string"
+                }
+              },
+              "example": {
+                "message": "Hello World!"
+              }
             }
           }
         },
@@ -32,7 +43,8 @@
         "parameters": [],
         "produces": [
           "application/json"
-        ]
+        ],
+        "consumes": []
       },
       "put": {
         "responses": {
@@ -48,7 +60,10 @@
         "tags": [
           "Messages"
         ],
-        "parameters": []
+        "parameters": [],
+        "consumes": [
+          "text/plain"
+        ]
       }
     }
   },

package/test/output/06. Requests.json

@@ -20,6 +20,17 @@
               "application/json": {
                 "message": "Hello World!"
               }
+            },
+            "schema": {
+              "type": "object",
+              "properties": {
+                "message": {
+                  "type": "string"
+                }
+              },
+              "example": {
+                "message": "Hello World!"
+              }
             }
           }
         },
@@ -41,7 +52,8 @@
         ],
         "produces": [
           "application/json"
-        ]
+        ],
+        "consumes": []
       },
       "put": {
         "responses": {
@@ -73,6 +85,10 @@
               }
             }
           }
+        ],
+        "consumes": [
+          "text/plain",
+          "application/json"
         ]
       }
     }

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

@@ -20,6 +20,17 @@
               "application/json": {
                 "message": "Hello World!"
               }
+            },
+            "schema": {
+              "type": "object",
+              "properties": {
+                "message": {
+                  "type": "string"
+                }
+              },
+              "example": {
+                "message": "Hello World!"
+              }
             }
           }
         },
@@ -41,7 +52,8 @@
         ],
         "produces": [
           "application/json"
-        ]
+        ],
+        "consumes": []
       },
       "put": {
         "responses": {
@@ -73,6 +85,10 @@
               }
             }
           }
+        ],
+        "consumes": [
+          "text/plain",
+          "application/json"
         ]
       }
     }

package/test/output/07. Parameters.json

@@ -21,6 +21,21 @@
                 "id": 1,
                 "message": "Hello World!"
               }
+            },
+            "schema": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "number"
+                },
+                "message": {
+                  "type": "string"
+                }
+              },
+              "example": {
+                "id": 1,
+                "message": "Hello World!"
+              }
             }
           }
         },
@@ -50,7 +65,8 @@
         ],
         "produces": [
           "application/json"
-        ]
+        ],
+        "consumes": []
       },
       "put": {
         "responses": {
@@ -90,6 +106,10 @@
               }
             }
           }
+        ],
+        "consumes": [
+          "text/plain",
+          "application/json"
         ]
       }
     },
@@ -114,6 +134,38 @@
                   "message": "So long, and thanks for all the fish."
                 }
               ]
+            },
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "number"
+                  },
+                  "message": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "id",
+                  "message"
+                ]
+              },
+              "example": [
+                {
+                  "id": 1,
+                  "message": "Hello World!"
+                },
+                {
+                  "id": 2,
+                  "message": "Time is an illusion. Lunchtime doubly so."
+                },
+                {
+                  "id": 3,
+                  "message": "So long, and thanks for all the fish."
+                }
+              ]
             }
           }
         },
@@ -135,7 +187,8 @@
         ],
         "produces": [
           "application/json"
-        ]
+        ],
+        "consumes": []
       }
     }
   },

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

@@ -21,6 +21,21 @@
                 "id": 1,
                 "message": "Hello World!"
               }
+            },
+            "schema": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "number"
+                },
+                "message": {
+                  "type": "string"
+                }
+              },
+              "example": {
+                "id": 1,
+                "message": "Hello World!"
+              }
             }
           }
         },
@@ -50,7 +65,8 @@
         ],
         "produces": [
           "application/json"
-        ]
+        ],
+        "consumes": []
       },
       "put": {
         "responses": {
@@ -90,6 +106,10 @@
               }
             }
           }
+        ],
+        "consumes": [
+          "text/plain",
+          "application/json"
         ]
       }
     },
@@ -114,6 +134,38 @@
                   "message": "So long, and thanks for all the fish."
                 }
               ]
+            },
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "number"
+                  },
+                  "message": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "id",
+                  "message"
+                ]
+              },
+              "example": [
+                {
+                  "id": 1,
+                  "message": "Hello World!"
+                },
+                {
+                  "id": 2,
+                  "message": "Time is an illusion. Lunchtime doubly so."
+                },
+                {
+                  "id": 3,
+                  "message": "So long, and thanks for all the fish."
+                }
+              ]
             }
           }
         },
@@ -135,7 +187,8 @@
         ],
         "produces": [
           "application/json"
-        ]
+        ],
+        "consumes": []
       }
     }
   },

package/test/output/08. Attributes.json

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