Merge branch 'release/v4.0.0' of github.com:postmanlabs/openapi-to-postman

Author: Vishal Shingala

CHANGELOG.md

@@ -1,5 +1,10 @@
 # OpenAPI-Postman Changelog
 
+#### v4.0.0 (July 12, 2022)
+* Added support for new multi-file API detectRootFiles() for OpenAPI 3 and Swagger 2 formats to support detection of root files among multiple files.
+* Added support for new multi-file API detectRelatedFiles() for OpenAPI 3 and Swagger 2 formats to support detection of related files for a provided root file amongst multiple files.
+* Added support for new multi-file API bundle() for OpenAPI 3 and Swagger 2 formats to support bundling of root files from provided multiple files.
+
 #### v3.2.0 (May 02, 2022)
 * Fixed some of critical and high level severity vulnerabilities.
 * Fixed issue [#10752](https://github.com/postmanlabs/postman-app-support/issues/10752) where deepObject style parameters were not generated correctly.

OPTIONS.md

@@ -22,3 +22,4 @@ allowUrlPathVarMatching|boolean|-|false|Whether to allow matching path variables
 disableOptionalParameters|boolean|-|false|Whether to set optional parameters as disabled|CONVERSION
 keepImplicitHeaders|boolean|-|false|Whether to keep implicit headers from the OpenAPI specification, which are removed by default.|CONVERSION
 includeWebhooks|boolean|-|false|Select whether to include Webhooks in the generated collection|CONVERSION
+includeReferenceMap|boolean|-|false|Whether or not to include reference map or not as part of output|BUNDLE

index.js

@@ -1,6 +1,7 @@
 'use strict';
 
-const SchemaPack = require('./lib/schemapack.js').SchemaPack;
+const _ = require('lodash'),
+  SchemaPack = require('./lib/schemapack.js').SchemaPack;
 
 module.exports = {
   // Old API wrapping the new API
@@ -32,6 +33,21 @@ module.exports = {
     return SchemaPack.getOptions(mode, criteria);
   },
 
+  detectRootFiles: async function(input) {
+    var schema = new SchemaPack(input);
+    return schema.detectRootFiles();
+  },
+
+  detectRelatedFiles: async function(input) {
+    var schema = new SchemaPack(input);
+    return schema.detectRelatedFiles();
+  },
+
+  bundle: async function(input) {
+    var schema = new SchemaPack(input, _.has(input, 'options') ? input.options : {});
+    return schema.bundle();
+  },
+
   // new API
   SchemaPack
 };

lib/30XUtils/inputValidation.js

@@ -1,3 +1,4 @@
+const _ = require('lodash');
 module.exports = {
 
   /**
@@ -7,37 +8,43 @@ module.exports = {
    * @return {Object} Validation result
    */
   validateSpec: function (spec) {
-
+    if (_.isNil(spec)) {
+      return {
+        result: false,
+        reason: 'The Specification is null or undefined'
+      };
+    }
     // Checking for the all the required properties in the specification
-    if (!spec.hasOwnProperty('openapi')) {
+    if (_.isNil(spec.openapi)) {
       return {
         result: false,
         reason: 'Specification must contain a semantic version number of the OAS specification'
       };
     }
 
-    if (!spec.hasOwnProperty('paths')) {
+    if (_.isNil(spec.paths)) {
       return {
         result: false,
         reason: 'Specification must contain Paths Object for the available operational paths'
       };
     }
 
-    if (!spec.hasOwnProperty('info')) {
+    if (_.isNil(spec.info)) {
       return {
         result: false,
         reason: 'Specification must contain an Info Object for the meta-data of the API'
       };
     }
+
     if (!spec.info.hasOwnProperty('$ref')) {
-      if (!spec.info.hasOwnProperty('title')) {
+      if (_.isNil(_.get(spec, 'info.title'))) {
         return {
           result: false,
           reason: 'Specification must contain a title in order to generate a collection'
         };
       }
 
-      if (!spec.info.hasOwnProperty('version')) {
+      if (_.isNil(_.get(spec, 'info.version'))) {
         return {
           result: false,
           reason: 'Specification must contain a semantic version number of the API in the Info Object'

lib/30XUtils/schemaUtils30X.js

@@ -9,11 +9,12 @@ module.exports = {
   /**
      * Parses an OAS string/object as a YAML or JSON
      * @param {YAML/JSON} openApiSpec - The OAS 3.x specification specified in either YAML or JSON
+     * @param {object} options - The parsing options
      * @returns {Object} - Contains the parsed JSON-version of the OAS spec, or an error
      * @no-unit-test
      */
-  parseSpec: function (openApiSpec) {
-    return schemaUtilsCommon.parseSpec(openApiSpec, inputValidation30X);
+  parseSpec: function (openApiSpec, options) {
+    return schemaUtilsCommon.parseSpec(openApiSpec, inputValidation30X, options);
   },
 
   /**

lib/31XUtils/inputValidation31X.js

@@ -1,4 +1,4 @@
-
+const _ = require('lodash');
 module.exports = {
 
   /**
@@ -11,29 +11,51 @@ module.exports = {
    */
   validateSpec: function (spec, options) {
     const includeWebhooksOption = options.includeWebhooks;
-    if (!spec.hasOwnProperty('openapi')) {
+    if (_.isNil(spec)) {
+      return {
+        result: false,
+        reason: 'The Specification is null or undefined'
+      };
+    }
+    if (_.isNil(spec.openapi)) {
       return {
         result: false,
         reason: 'Specification must contain a semantic version number of the OAS specification'
       };
     }
 
-    if (!spec.hasOwnProperty('info')) {
+    if (_.isNil(spec.info)) {
       return {
         result: false,
         reason: 'Specification must contain an Info Object for the meta-data of the API'
       };
     }
 
-    if (!spec.hasOwnProperty('paths') && !includeWebhooksOption) {
+    if (!spec.info.hasOwnProperty('$ref')) {
+      if (_.isNil(_.get(spec, 'info.title'))) {
+        return {
+          result: false,
+          reason: 'Specification must contain a title in order to generate a collection'
+        };
+      }
+
+      if (_.isNil(_.get(spec, 'info.version'))) {
+        return {
+          result: false,
+          reason: 'Specification must contain a semantic version number of the API in the Info Object'
+        };
+      }
+    }
+
+    if (_.isNil(spec.paths) && !includeWebhooksOption) {
       return {
         result: false,
         reason: 'Specification must contain Paths Object for the available operational paths'
       };
     }
 
-    if (includeWebhooksOption && !spec.hasOwnProperty('paths') &&
-      !spec.hasOwnProperty('webhooks') && !spec.hasOwnProperty('components')) {
+    if (includeWebhooksOption && _.isNil(spec.paths) &&
+      _.isNil(spec.webhooks) && _.isNil(spec.components)) {
       return {
         result: false,
         reason: 'Specification must contain either Paths, Webhooks or Components sections'