apib2swagger 1.9.2 → 1.13.0

package/test/output/apiblueprint_valid_simple.json

@@ -11,7 +11,11 @@
         "responses": {
           "200": {
             "description": "OK",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {
               "application/hal+json": {
                 "_links": {
@@ -31,6 +35,7 @@
           }
         },
         "summary": "Retrieve the Entry Point",
+        "operationId": "Retrieve the Entry Point",
         "description": "",
         "tags": [],
         "parameters": [],
@@ -44,7 +49,11 @@
         "responses": {
           "200": {
             "description": "HAL+JSON representation of Gist Resource. In addition to representing its state in the JSON form it offers affordances in the form of the HTTP Link header and HAL links.",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {},
             "schema": {
               "$ref": "#/definitions/GistModel"
@@ -52,6 +61,7 @@
           }
         },
         "summary": "Retrieve a Single Gist",
+        "operationId": "Retrieve a Single Gist",
         "description": "",
         "tags": [
           "Gist"
@@ -77,7 +87,11 @@
         "responses": {
           "200": {
             "description": "HAL+JSON representation of Gist Resource. In addition to representing its state in the JSON form it offers affordances in the form of the HTTP Link header and HAL links.",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {},
             "schema": {
               "$ref": "#/definitions/GistModel"
@@ -85,6 +99,7 @@
           }
         },
         "summary": "Edit a Gist",
+        "operationId": "Edit a Gist",
         "description": "To update a Gist send a JSON with updated value for one or more of the Gist resource attributes. All attributes values (states) from the previous version of this Gist are carried over by default if not included in the hash.",
         "tags": [
           "Gist"
@@ -130,6 +145,7 @@
           }
         },
         "summary": "Delete a Gist",
+        "operationId": "Delete a Gist",
         "description": "",
         "tags": [
           "Gist"
@@ -157,7 +173,11 @@
         "responses": {
           "200": {
             "description": "HAL+JSON representation of Gist Collection Resource. The Gist resources in collections are embedded. Note the embedded Gists resource are incomplete representations of the Gist in question. Use the respective Gist link to retrieve its full representation.",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {
               "application/hal+json": {
                 "_links": {
@@ -188,6 +208,7 @@
           }
         },
         "summary": "List All Gists",
+        "operationId": "List All Gists",
         "description": "",
         "tags": [
           "Gist"
@@ -209,7 +230,11 @@
         "responses": {
           "201": {
             "description": "HAL+JSON representation of Gist Resource. In addition to representing its state in the JSON form it offers affordances in the form of the HTTP Link header and HAL links.",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {},
             "schema": {
               "$ref": "#/definitions/GistModel"
@@ -217,6 +242,7 @@
           }
         },
         "summary": "Create a Gist",
+        "operationId": "Create a Gist",
         "description": "To create a new Gist simply provide a JSON hash of the *description* and *content* attributes for the new Gist.\n\nThis action requires an `access_token` with `gist_write` scope.",
         "tags": [
           "Gist"
@@ -261,6 +287,7 @@
           }
         },
         "summary": "Star a Gist",
+        "operationId": "Star a Gist",
         "description": "This action requires an `access_token` with `gist_write` scope.",
         "tags": [
           "Gist"
@@ -291,6 +318,7 @@
           }
         },
         "summary": "Unstar a Gist",
+        "operationId": "Unstar a Gist",
         "description": "This action requires an `access_token` with `gist_write` scope.",
         "tags": [
           "Gist"
@@ -316,7 +344,11 @@
         "responses": {
           "200": {
             "description": "HAL+JSON representation of Star Resource.",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {},
             "schema": {
               "$ref": "#/definitions/StarModel"
@@ -324,6 +356,7 @@
           }
         },
         "summary": "Check if a Gist is Starred",
+        "operationId": "Check if a Gist is Starred",
         "description": "",
         "tags": [
           "Gist"
@@ -351,7 +384,11 @@
         "responses": {
           "200": {
             "description": "OK",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {},
             "schema": {
               "$ref": "#/definitions/AuthorizationModel"
@@ -359,6 +396,7 @@
           }
         },
         "summary": "Retrieve Authorization",
+        "operationId": "Retrieve Authorization",
         "description": "",
         "tags": [
           "Access Authorization and Control"
@@ -379,6 +417,7 @@
           }
         },
         "summary": "Create Authorization",
+        "operationId": "Create Authorization",
         "description": "",
         "tags": [
           "Access Authorization and Control"
@@ -420,6 +459,7 @@
           }
         },
         "summary": "Remove an Authorization",
+        "operationId": "Remove an Authorization",
         "description": "",
         "tags": [
           "Access Authorization and Control"

package/test/output/apiblueprint_valid_simple.ref.json

@@ -11,7 +11,11 @@
         "responses": {
           "200": {
             "description": "OK",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {
               "application/hal+json": {
                 "_links": {
@@ -31,6 +35,7 @@
           }
         },
         "summary": "Retrieve the Entry Point",
+        "operationId": "Retrieve the Entry Point",
         "description": "",
         "tags": [],
         "parameters": [],
@@ -44,7 +49,11 @@
         "responses": {
           "200": {
             "description": "HAL+JSON representation of Gist Resource. In addition to representing its state in the JSON form it offers affordances in the form of the HTTP Link header and HAL links.",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {},
             "schema": {
               "$ref": "#/definitions/GistModel"
@@ -52,6 +61,7 @@
           }
         },
         "summary": "Retrieve a Single Gist",
+        "operationId": "Retrieve a Single Gist",
         "description": "",
         "tags": [
           "Gist"
@@ -77,7 +87,11 @@
         "responses": {
           "200": {
             "description": "HAL+JSON representation of Gist Resource. In addition to representing its state in the JSON form it offers affordances in the form of the HTTP Link header and HAL links.",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {},
             "schema": {
               "$ref": "#/definitions/GistModel"
@@ -85,6 +99,7 @@
           }
         },
         "summary": "Edit a Gist",
+        "operationId": "Edit a Gist",
         "description": "To update a Gist send a JSON with updated value for one or more of the Gist resource attributes. All attributes values (states) from the previous version of this Gist are carried over by default if not included in the hash.",
         "tags": [
           "Gist"
@@ -130,6 +145,7 @@
           }
         },
         "summary": "Delete a Gist",
+        "operationId": "Delete a Gist",
         "description": "",
         "tags": [
           "Gist"
@@ -157,7 +173,11 @@
         "responses": {
           "200": {
             "description": "HAL+JSON representation of Gist Collection Resource. The Gist resources in collections are embedded. Note the embedded Gists resource are incomplete representations of the Gist in question. Use the respective Gist link to retrieve its full representation.",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {
               "application/hal+json": {
                 "_links": {
@@ -188,6 +208,7 @@
           }
         },
         "summary": "List All Gists",
+        "operationId": "List All Gists",
         "description": "",
         "tags": [
           "Gist"
@@ -209,7 +230,11 @@
         "responses": {
           "201": {
             "description": "HAL+JSON representation of Gist Resource. In addition to representing its state in the JSON form it offers affordances in the form of the HTTP Link header and HAL links.",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {},
             "schema": {
               "$ref": "#/definitions/GistModel"
@@ -217,6 +242,7 @@
           }
         },
         "summary": "Create a Gist",
+        "operationId": "Create a Gist",
         "description": "To create a new Gist simply provide a JSON hash of the *description* and *content* attributes for the new Gist.\n\nThis action requires an `access_token` with `gist_write` scope.",
         "tags": [
           "Gist"
@@ -261,6 +287,7 @@
           }
         },
         "summary": "Star a Gist",
+        "operationId": "Star a Gist",
         "description": "This action requires an `access_token` with `gist_write` scope.",
         "tags": [
           "Gist"
@@ -291,6 +318,7 @@
           }
         },
         "summary": "Unstar a Gist",
+        "operationId": "Unstar a Gist",
         "description": "This action requires an `access_token` with `gist_write` scope.",
         "tags": [
           "Gist"
@@ -316,7 +344,11 @@
         "responses": {
           "200": {
             "description": "HAL+JSON representation of Star Resource.",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {},
             "schema": {
               "$ref": "#/definitions/StarModel"
@@ -324,6 +356,7 @@
           }
         },
         "summary": "Check if a Gist is Starred",
+        "operationId": "Check if a Gist is Starred",
         "description": "",
         "tags": [
           "Gist"
@@ -351,7 +384,11 @@
         "responses": {
           "200": {
             "description": "OK",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {},
             "schema": {
               "$ref": "#/definitions/AuthorizationModel"
@@ -359,6 +396,7 @@
           }
         },
         "summary": "Retrieve Authorization",
+        "operationId": "Retrieve Authorization",
         "description": "",
         "tags": [
           "Access Authorization and Control"
@@ -379,6 +417,7 @@
           }
         },
         "summary": "Create Authorization",
+        "operationId": "Create Authorization",
         "description": "",
         "tags": [
           "Access Authorization and Control"
@@ -420,6 +459,7 @@
           }
         },
         "summary": "Remove an Authorization",
+        "operationId": "Remove an Authorization",
         "description": "",
         "tags": [
           "Access Authorization and Control"

package/test/output/schema_without_body.json

@@ -0,0 +1,52 @@
+{
+    "swagger": "2.0",
+    "info": {
+        "title": "",
+        "version": "",
+        "description": ""
+    },
+    "paths": {
+        "/some/resource": {
+            "post": {
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "headers": {},
+                        "examples": {
+                            "text/plain": ""
+                        }
+                    }
+                },
+                "summary": "Some resource",
+                "operationId": "Some resource",
+                "description": "",
+                "tags": [],
+                "parameters": [
+                    {
+                        "name": "body",
+                        "in": "body",
+                        "schema": {
+                            "type": "object",
+                            "properties": {
+                                "prop1": {
+                                    "type": "string"
+                                }
+                            },
+                            "required": [
+                                "prop1"
+                            ]
+                        }
+                    }
+                ],
+                "produces": [
+                    "text/plain"
+                ]
+            }
+        }
+    },
+    "definitions": {
+        "Some resource": {}
+    },
+    "securityDefinitions": {},
+    "tags": []
+}

package/test/output/schema_without_body.ref.json

@@ -0,0 +1,52 @@
+{
+    "swagger": "2.0",
+    "info": {
+        "title": "",
+        "version": "",
+        "description": ""
+    },
+    "paths": {
+        "/some/resource": {
+            "post": {
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "headers": {},
+                        "examples": {
+                            "text/plain": ""
+                        }
+                    }
+                },
+                "summary": "Some resource",
+                "operationId": "Some resource",
+                "description": "",
+                "tags": [],
+                "parameters": [
+                    {
+                        "name": "body",
+                        "in": "body",
+                        "schema": {
+                            "type": "object",
+                            "properties": {
+                                "prop1": {
+                                    "type": "string"
+                                }
+                            },
+                            "required": [
+                                "prop1"
+                            ]
+                        }
+                    }
+                ],
+                "produces": [
+                    "text/plain"
+                ]
+            }
+        }
+    },
+    "definitions": {
+        "Some resource": {}
+    },
+    "securityDefinitions": {},
+    "tags": []
+}

package/test/test.js

@@ -4,6 +4,14 @@ var assert = require("assert"),
     apib2swagger = require("../index.js"),
     tv4 = require('tv4');
 
+const swaggerSchema = JSON.parse(fs.readFileSync('test/swagger_20_schema.json'));
+const openAPI3Schema = JSON.parse(fs.readFileSync('test/openAPI_30_schema.json'))
+const meta_schema = JSON.parse(fs.readFileSync('test/meta_schema.json'));
+
+tv4.addSchema('http://json-schema.org/draft-04/schema', meta_schema);
+tv4.addSchema('https://spec.openapis.org/oas/3.0/schema/2021-09-28', openAPI3Schema);
+tv4.addSchema('http://swagger.io/v2/schema.json', swaggerSchema);
+      
 var remote = 'https://raw.githubusercontent.com/apiaryio/api-blueprint/format-1A9/examples/',
     localInput = 'test/input/',
     localOutput = 'test/output/',
@@ -37,8 +45,15 @@ var remote = 'https://raw.githubusercontent.com/apiaryio/api-blueprint/format-1A
         'Issue-#35.md',
         'Issue-#36.md',
         'Issue-#38.md',
+        'Issue-#49.md',
         'apiblueprint_uber.md',
-        'apiblueprint_valid_simple.md'
+        'apiblueprint_valid_simple.md',
+        'schema_without_body.md',
+        'OpenAPI3_responses.md',
+        'OpenAPI3_requests.md',
+        'OpenAPI3_headers.md',
+        'OpenAPI3_includes.md',
+        'OpenAPI3_attributes.md'
     ];
 
 var fetch = function (file) {
@@ -46,7 +61,7 @@ var fetch = function (file) {
         return Promise.resolve();
     }
     console.log('Downloading ' + remote + file + ')');
-    return new Promise(function(resolve, reject) {
+    return new Promise(function (resolve, reject) {
         https.get(remote + file, function (res) {
             if (res.statusCode !== 200) {
             }
@@ -78,6 +93,7 @@ const checkResultByFile = (result, file, originalExtension, newExtension) => {
         var f = fs.readFileSync(localOutput + file.replace(originalExtension, newExtension));
         var expected_answer = JSON.parse(f);
         assert.deepEqual(result.swagger, expected_answer);
+        const schema = file.includes('OpenAPI3') ? openAPI3Schema : swaggerSchema
         var validation_result = tv4.validateResult(result.swagger, schema);
         if (validation_result.error) {
             console.log(validation_result);
@@ -94,16 +110,16 @@ describe("apib2swagger", function () {
             return Promise.all(files.map(fetch));
         });
 
-        schema = JSON.parse(fs.readFileSync('test/swagger_20_schema.json'));
-        tv4.addSchema('http://swagger.io/v2/schema.json', schema);
-        meta_schema =  JSON.parse(fs.readFileSync('test/meta_schema.json'));
-        tv4.addSchema('http://json-schema.org/draft-04/schema', meta_schema);
-
         files.concat(includedFiles).forEach(function (file) {
+            const options = {}
+            if (file.includes('OpenAPI3')){
+                options.openApi3 = true
+            }
+
             it(file, function (done) {
                 this.timeout(10000); // 10s
                 var apib = fs.readFileSync(localInput + file, "utf-8").replace(/\r/g, '');
-                apib2swagger.convert(apib, function (error, result) {
+                apib2swagger.convert(apib, options, function (error, result) {
                     if (error) {
                         return done(error);
                     }
@@ -116,7 +132,7 @@ describe("apib2swagger", function () {
             it(file + ' (--prefer-reference)', function (done) {
                 this.timeout(10000); // 10s
                 var apib = fs.readFileSync(localInput + file, "utf-8").replace(/\r/g, '');
-                apib2swagger.convert(apib, { preferReference: true }, function (error, result) {
+                apib2swagger.convert(apib, { ...options, preferReference: true }, function (error, result) {
                     if (error) {
                         return done(error);
                     }
@@ -128,9 +144,9 @@ describe("apib2swagger", function () {
         });
 
         var versionTests = [
-            {input: 'VERSION: 1.0.0', output: '1.0.0'},
-            {input: 'Version: 2.0', output: '2.0'},
-            {input: 'version: 3', output: '3'},
+            { input: 'VERSION: 1.0.0', output: '1.0.0' },
+            { input: 'Version: 2.0', output: '2.0' },
+            { input: 'version: 3', output: '3' },
         ];
         versionTests.forEach(function (test) {
             it(test.input, function (done) {
@@ -139,18 +155,18 @@ describe("apib2swagger", function () {
                         return done(error);
                     }
                     assert.equal(result.swagger.info.version, test.output);
-                    var validation_result = tv4.validateResult(result.swagger, schema);
+                    var validation_result = tv4.validateResult(result.swagger, swaggerSchema);
                     if (validation_result.error) {
                         console.log(validation_result);
                     }
                     assert(validation_result.valid);
                     assert(validation_result.missing.length === 0)
                     done();
-                });                    
+                });
             });
         });
 
-        it('Issue-#38.md (--bearer-apikey', function(done) {
+        it('Issue-#38.md (--bearer-apikey', function (done) {
             const file = 'Issue-#38.md';
             this.timeout(10000); // 10s
             var apib = fs.readFileSync(localInput + file, "utf-8").replace(/\r/g, '');