Merge pull request #701 from postmanlabs/feature/cli-v2-usage

Added support for usage of interface version in CLI conversions with v2 as default.

Author: VShingala

README.md

@@ -56,28 +56,31 @@ The converter can be used as a CLI tool as well. The following [command line opt
 
 ### Options
 
-- `-s <source>`, `--spec <source>`  
+- `-s <source>`, `--spec <source>`
   Used to specify the OpenAPI specification (file path) which is to be converted
 
-- `-o <destination>`, `--output <destination>`  
+- `-o <destination>`, `--output <destination>`
   Used to specify the destination file in which the collection is to be written
 
-- `-p`, `--pretty`  
+- `-p`, `--pretty`
   Used to pretty print the collection object while writing to a file
 
-- `-O`, `--options`  
+- `-i`, `--interface-version`
+  Specifies the interface version of the converter to be used. Value can be 'v2' or 'v1'. Default is 'v2'.
+
+- `-O`, `--options`
   Used to supply options to the converter, for complete options details see [here](/OPTIONS.md)
 
-- `-c`, `--options-config`  
+- `-c`, `--options-config`
   Used to supply options to the converter through config file, for complete options details see [here](/OPTIONS.md)
 
-- `-t`, `--test`  
+- `-t`, `--test`
   Used to test the collection with an in-built sample specification
 
-- `-v`, `--version`  
+- `-v`, `--version`
   Specifies the version of the converter
 
-- `-h`, `--help`  
+- `-h`, `--help`
   Specifies all the options along with a few usage examples on the terminal
 
 

bin/openapi2postmanv2.js

@@ -12,6 +12,7 @@ var _ = require('lodash'),
   definedOptions,
   testFlag,
   swaggerInput,
+  interfaceVersion,
   swaggerData;
 
 /**
@@ -41,6 +42,14 @@ function parseOptions (value) {
       console.warn('\x1b[33m%s\x1b[0m', 'Warning: Invalid option supplied ', option[0]);
     }
   });
+
+  /**
+   * As v2 interface uses parametersResolution instead of previous requestParametersResolution option,
+   * override value of parametersResolution if it's not defined and requestParametersResolution is defined
+   */
+  if (_.has(parsedOptions, 'requestParametersResolution') && !_.has(parsedOptions, 'parametersResolution')) {
+    parsedOptions.parametersResolution = parsedOptions.requestParametersResolution;
+  }
   return parsedOptions;
 }
 
@@ -50,6 +59,7 @@ program
   .option('-o, --output <output>', 'Write the collection to an output file')
   .option('-t, --test', 'Test the OPENAPI converter')
   .option('-p, --pretty', 'Pretty print the JSON file')
+  .option('-i, --interface-version <interfaceVersion>', 'Interface version of convert() to be used')
   .option('-c, --options-config <optionsConfig>', 'JSON file containing Converter options')
   .option('-O, --options <options>', 'comma separated list of options', parseOptions);
 
@@ -76,6 +86,7 @@ inputFile = program.spec;
 outputFile = program.output || false;
 testFlag = program.test || false;
 prettyPrintFlag = program.pretty || false;
+interfaceVersion = program.interfaceVersion || 'v2';
 configFile = program.optionsConfig || false;
 definedOptions = (!(program.options instanceof Array) ? program.options : {});
 swaggerInput;
@@ -112,7 +123,8 @@ function writetoFile(prettyPrintFlag, file, collection) {
  * @returns {void}
  */
 function convert(swaggerData) {
-  let options = {};
+  let options = {},
+    convertFn = interfaceVersion === 'v1' ? 'convert' : 'convertV2';
 
   // apply options from config file if present
   if (configFile) {
@@ -126,7 +138,7 @@ function convert(swaggerData) {
     options = definedOptions;
   }
 
-  Converter.convert({
+  Converter[convertFn]({
     type: 'string',
     data: swaggerData
   }, options, (err, status) => {

libV2/schemaUtils.js

@@ -236,6 +236,19 @@ let QUERYPARAM = 'query',
     return { collectionVariables, pathVariables, baseUrl };
   },
 
+  /**
+   * Provides ref stack limit for current instance
+   * @param {*} stackLimit - Defined stackLimit in options
+   *
+   * @returns {Number} Returns the stackLimit to be used
+   */
+  getRefStackLimit = (stackLimit) => {
+    if (typeof stackLimit === 'number' && stackLimit > REF_STACK_LIMIT) {
+      return stackLimit;
+    }
+    return REF_STACK_LIMIT;
+  },
+
   /**
    * Resolve a given ref from the schema
    * @param {Object} context - Global context object
@@ -246,9 +259,10 @@ let QUERYPARAM = 'query',
    * @returns {Object} Returns the object that staisfies the schema
    */
   resolveRefFromSchema = (context, $ref, stackDepth = 0, seenRef = {}) => {
-    const { specComponents } = context;
+    const { specComponents } = context,
+      { stackLimit } = context.computedOptions;
 
-    if (stackDepth >= REF_STACK_LIMIT) {
+    if (stackDepth >= getRefStackLimit(stackLimit)) {
       return { value: ERR_TOO_MANY_LEVELS };
     }
 
@@ -315,9 +329,10 @@ let QUERYPARAM = 'query',
    * @returns {Object} Returns the object that staisfies the schema
    */
   resolveRefForExamples = (context, $ref, stackDepth = 0, seenRef = {}) => {
-    const { specComponents } = context;
+    const { specComponents } = context,
+      { stackLimit } = context.computedOptions;
 
-    if (stackDepth >= REF_STACK_LIMIT) {
+    if (stackDepth >= getRefStackLimit(stackLimit)) {
       return { value: ERR_TOO_MANY_LEVELS };
     }
 
@@ -467,12 +482,15 @@ let QUERYPARAM = 'query',
       return new Error('Schema is empty');
     }
 
-    if (stack >= REF_STACK_LIMIT) {
+    const { stackLimit } = context.computedOptions;
+
+    if (stack >= getRefStackLimit(stackLimit)) {
       return { value: ERR_TOO_MANY_LEVELS };
     }
 
     stack++;
 
+    // eslint-disable-next-line one-var
     const compositeKeyword = schema.anyOf ? 'anyOf' : 'oneOf',
       { concreteUtils } = context;