add transitive conversion to Open API 3.0 via Swagger 2.0

dist/api-spec-converter.js

@@ -161,6 +161,18 @@ BaseFormat.prototype.convertTo = function (format, callback) {
   }).asCallback(callback);
 };
 
+BaseFormat.prototype.convertTransitive = function (intermediaries) {
+  var prom = Promise.resolve(this);
+  intermediaries.forEach(function (intermediary) {
+    prom = prom.then(function (spec) {
+      return spec.convertTo(intermediary);
+    });
+  });
+  return prom.then(function (spec) {
+    return spec.spec;
+  });
+};
+
 },{"./formats.js":2,"./util.js":11,"bluebird":82,"composite-error":127,"deep-sort-object":139,"js-yaml":1229,"lodash":1321}],2:[function(require,module,exports){
 'use strict';
 
@@ -187,12 +199,18 @@ var BPToSwagger = require('apib2swagger');
 var BaseFormat = require('../base_format.js');
 
 var APIBlueprint = module.exports = function () {
+  var _this = this;
+
   APIBlueprint.super_.apply(this, arguments);
   this.format = 'api_blueprint';
 
   this.converters.swagger_2 = Promise.method(function (apibp) {
     return BPToSwagger.convertParsed(apibp.spec);
   });
+
+  this.converters.openapi_3 = Promise.method(function (apibp) {
+    return _this.convertTransitive(['swagger_2', 'openapi_3']);
+  });
 };
 
 Inherits(APIBlueprint, BaseFormat);
@@ -225,12 +243,18 @@ var Util = require('../util.js');
 var Google2Swagger = require('google-discovery-to-swagger');
 
 var Google = module.exports = function () {
+  var _this = this;
+
   Google.super_.apply(this, arguments);
   this.format = 'google';
 
   this.converters.swagger_2 = Promise.method(function (google) {
     return Google2Swagger.convert(google.spec);
   });
+
+  this.converters.openapi_3 = Promise.method(function (google) {
+    return _this.convertTransitive(['swagger_2', 'openapi_3']);
+  });
 };
 
 Inherits(Google, BaseFormat);
@@ -262,11 +286,17 @@ var BaseFormat = require('../base_format.js');
 var Util = require('../util.js');
 
 var IODocs = module.exports = function () {
+  var _this = this;
+
   IODocs.super_.apply(this, arguments);
   this.type = 'io_docs';
   this.converters.swagger_2 = Promise.method(function (iodocs) {
     return convertToSwagger(iodocs.spec);
   });
+
+  this.converters.openapi_3 = Promise.method(function (iodocs) {
+    return _this.convertTransitive(['swagger_2', 'openapi_3']);
+  });
 };
 
 Inherits(IODocs, BaseFormat);
@@ -394,12 +424,18 @@ var BaseFormat = require('../base_format.js');
 var Util = require('../util.js');
 
 var Raml = module.exports = function () {
+  var _this = this;
+
   Raml.super_.apply(this, arguments);
   this.format = 'raml';
 
   this.converters.swagger_2 = Promise.method(function (raml) {
     return Raml2Swagger.convert(raml.spec);
   });
+
+  this.converters.openapi_3 = Promise.method(function (raml) {
+    return _this.convertTransitive(['swagger_2', 'openapi_3']);
+  });
 };
 
 Inherits(Raml, BaseFormat);
@@ -439,6 +475,8 @@ var BaseFormat = require('../base_format.js');
 var Util = require('../util.js');
 
 var Swagger1 = module.exports = function () {
+  var _this = this;
+
   Swagger1.super_.apply(this, arguments);
   this.format = 'swagger_1';
 
@@ -448,6 +486,10 @@ var Swagger1 = module.exports = function () {
     if (swagger2.info.title === 'Title was not specified') swagger2.info.title = swagger2.host;
     return swagger2;
   });
+
+  this.converters.openapi_3 = Promise.method(function (swagger1) {
+    return _this.convertTransitive(['swagger_2', 'openapi_3']);
+  });
 };
 
 Inherits(Swagger1, BaseFormat);
@@ -584,12 +626,18 @@ var BaseFormat = require('../base_format.js');
 var Util = require('../util.js');
 
 var WADL = module.exports = function () {
+  var _this = this;
+
   WADL.super_.apply(this, arguments);
   this.format = 'wadl';
 
   this.converters.swagger_2 = Promise.method(function (wadl) {
     return convertToSwagger(wadl.spec);
   });
+
+  this.converters.openapi_3 = Promise.method(function (swagger1) {
+    return _this.convertTransitive(['swagger_2', 'openapi_3']);
+  });
 };
 
 Inherits(WADL, BaseFormat);

lib/base_format.js

@@ -170,3 +170,13 @@ BaseFormat.prototype.convertTo = function(format, callback) {
     });
   }).asCallback(callback);
 }
+
+BaseFormat.prototype.convertTransitive = function(intermediaries) {
+  let prom = Promise.resolve(this);
+  intermediaries.forEach(intermediary => {
+    prom = prom.then(spec => {
+      return spec.convertTo(intermediary);
+    })
+  });
+  return prom.then(spec => spec.spec);
+}

lib/formats/api_blueprint.js

@@ -15,6 +15,9 @@ var APIBlueprint = module.exports = function() {
   this.converters.swagger_2 = Promise.method(apibp => {
     return BPToSwagger.convertParsed(apibp.spec);
   });
+
+  this.converters.openapi_3 =
+    Promise.method(apibp => this.convertTransitive(['swagger_2', 'openapi_3']));
 }
 
 Inherits(APIBlueprint, BaseFormat);

lib/formats/google.js

@@ -13,6 +13,9 @@ var Google = module.exports = function() {
 
   this.converters.swagger_2 =
     Promise.method(google => Google2Swagger.convert(google.spec));
+
+  this.converters.openapi_3 =
+    Promise.method(google => this.convertTransitive(['swagger_2', 'openapi_3']));
 }
 
 Inherits(Google, BaseFormat);

lib/formats/io_docs.js

@@ -14,6 +14,9 @@ var IODocs = module.exports = function() {
   this.type = 'io_docs';
   this.converters.swagger_2 =
     Promise.method(iodocs => convertToSwagger(iodocs.spec));
+
+  this.converters.openapi_3 =
+    Promise.method(iodocs => this.convertTransitive(['swagger_2', 'openapi_3']));
 }
 
 Inherits(IODocs, BaseFormat);

lib/formats/raml.js

@@ -15,6 +15,9 @@ var Raml = module.exports = function() {
 
   this.converters.swagger_2 =
     Promise.method(raml => Raml2Swagger.convert(raml.spec));
+
+  this.converters.openapi_3 =
+    Promise.method(raml => this.convertTransitive(['swagger_2', 'openapi_3']));
 }
 
 Inherits(Raml, BaseFormat);

lib/formats/swagger_1.js

@@ -26,6 +26,9 @@ var Swagger1 = module.exports = function() {
       swagger2.info.title = swagger2.host;
     return swagger2;
   });
+
+  this.converters.openapi_3 =
+    Promise.method(swagger1 => this.convertTransitive(['swagger_2', 'openapi_3']));
 }
 
 Inherits(Swagger1, BaseFormat);

lib/formats/wadl.js

@@ -17,6 +17,9 @@ var WADL = module.exports = function() {
 
   this.converters.swagger_2 =
     Promise.method(wadl => convertToSwagger(wadl.spec));
+
+  this.converters.openapi_3 =
+    Promise.method(swagger1 => this.convertTransitive(['swagger_2', 'openapi_3']));
 }
 
 Inherits(WADL, BaseFormat);

test/convert.js

@@ -27,7 +27,7 @@ describe('Converter', function() {
           var outfile = getFileName('output', testCase.out);
           var order = testCase.out.order || 'alpha';
           if (WRITE_GOLDEN)
-            FS.writeFileSync(outfile, spec.stringify({order}) + '\n');
+            FS.writeFileSync(outfile, spec.stringify({order: order}) + '\n');
 
           getFile(outfile, function(err, golden) {
             try {

test/output/openapi_3/OpenStack_example.json

@@ -0,0 +1,118 @@
+{
+  "components": {
+    "schemas": {}
+  },
+  "info": {
+    "title": "",
+    "version": ""
+  },
+  "openapi": "3.0.0",
+  "paths": {
+    "/": {
+      "get": {
+        "operationId": "listVersions-v2",
+        "responses": {
+          "200": {
+            "description": "Successful Response"
+          }
+        }
+      },
+      "parameters": []
+    },
+    "/v2.0": {
+      "get": {
+        "operationId": "showVersionInfo-v2.0",
+        "responses": {
+          "200": {
+            "description": "Successful Response"
+          }
+        }
+      },
+      "parameters": []
+    },
+    "/v2.0/extensions": {
+      "get": {
+        "operationId": "listExtensions-v2",
+        "responses": {
+          "200": {
+            "description": "Successful Response"
+          }
+        }
+      },
+      "parameters": []
+    },
+    "/v2.0/extensions/{alias}": {
+      "get": {
+        "operationId": "showExtension-v2",
+        "responses": {
+          "200": {
+            "description": "Successful Response"
+          }
+        }
+      },
+      "parameters": [
+        {
+          "in": "path",
+          "name": "alias",
+          "required": true,
+          "schema": {
+            "type": "string"
+          }
+        }
+      ]
+    },
+    "/v2.0/tenants": {
+      "get": {
+        "operationId": "listTenants",
+        "responses": {
+          "200": {
+            "description": "Successful Response"
+          }
+        }
+      },
+      "parameters": [
+        {
+          "in": "header",
+          "name": "X-Auth-Token",
+          "required": true,
+          "schema": {
+            "type": "string"
+          }
+        },
+        {
+          "in": "query",
+          "name": "limit",
+          "required": false,
+          "schema": {
+            "format": "int32",
+            "type": "integer"
+          }
+        },
+        {
+          "in": "query",
+          "name": "marker",
+          "required": false,
+          "schema": {
+            "type": "string"
+          }
+        }
+      ]
+    },
+    "/v2.0/tokens": {
+      "parameters": [],
+      "post": {
+        "operationId": "authenticate-v2.0",
+        "responses": {
+          "200": {
+            "description": "Successful Response"
+          }
+        }
+      }
+    }
+  },
+  "servers": [
+    {
+      "url": "http://localhost:35357/"
+    }
+  ]
+}