Merge branch 'develop' into feat/deprecatedOption

Author: LuisTejedaS

.github/workflows/integration.yml

@@ -13,6 +13,7 @@ jobs:
           node-version: '14.x'
       - run: npm install
       - run: npm run test-lint
+      - run: npm run test-system
       - run: npm run test-unit
 
   Regression:

.travis.yml

@@ -8,7 +8,7 @@ requestParametersResolution|enum|Example, Schema|Schema|Select whether to genera
 exampleParametersResolution|enum|Example, Schema|Example|Select whether to generate the response parameters based on the [schema](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject) or the [example](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#exampleObject) in the schema.|CONVERSION
 folderStrategy|enum|Paths, Tags|Paths|Select whether to create folders according to the spec’s paths or tags.|CONVERSION
 schemaFaker|boolean|-|true|Whether or not schemas should be faked.|CONVERSION
-stackLimit|integer|-|10|Number of nesting limit till which schema resolution will happen. Increasing this limit may result in more time to convert collection depending on complexity of specification. (To make sure this option works correctly "optimizeConversion" option needs to be disabled)|CONVERSION
+stackLimit|integer|-|8|Number of nesting limit till which schema resolution will happen. Increasing this limit may result in more time to convert collection depending on complexity of specification. (To make sure this option works correctly "optimizeConversion" option needs to be disabled)|CONVERSION
 includeAuthInfoInExample|boolean|-|true|Select whether to include authentication parameters in the example request|CONVERSION
 shortValidationErrors|boolean|-|false|Whether detailed error messages are required for request <> schema validation operations.|VALIDATION
 validationPropertiesToIgnore|array|-|[]|Specific properties (parts of a request/response pair) to ignore during validation. Must be sent as an array of strings. Valid inputs in the array: PATHVARIABLE, QUERYPARAM, HEADER, BODY, RESPONSE_HEADER, RESPONSE_BODY|VALIDATION

OPTIONS.md

@@ -1,16 +1,17 @@
 
-![postman icon](https://raw.githubusercontent.com/postmanlabs/postmanlabs.github.io/develop/global-artefacts/postman-logo%2Btext-320x132.png) 
+<img src="https://voyager.postman.com/logo/postman-logo-orange.svg" width="320" alt="The Postman Logo">
 
-*Supercharge your API workflow.*  
+*Supercharge your API workflow.*
 *Modern software is built on APIs. Postman helps you develop APIs faster.*
 
 # OpenAPI 3.0 to Postman Collection v2.1.0 Converter
 
-[![Build Status](https://travis-ci.org/postmanlabs/openapi-to-postman.svg?branch=master)](https://travis-ci.org/postmanlabs/openapi-to-postman)
-<a href="https://www.npmjs.com/package/openapi-to-postmanv2" alt="Latest Stable Version">![npm](https://img.shields.io/npm/v/openapi-to-postmanv2.svg)</a> 
+![Build Status](https://github.com/postmanlabs/openapi-to-postman/actions/workflows/integration.yml/badge.svg)
+
+<a href="https://www.npmjs.com/package/openapi-to-postmanv2" alt="Latest Stable Version">![npm](https://img.shields.io/npm/v/openapi-to-postmanv2.svg)</a>
 <a href="https://www.npmjs.com/package/openapi-to-postmanv2" alt="Total Downloads">![npm](https://img.shields.io/npm/dw/openapi-to-postmanv2.svg)</a>
 
-#### Contents 
+#### Contents
 
 1. [Getting Started](#getting-started)
 2. [Using the converter as a NodeJS module](#using-the-converter-as-a-nodejs-module)
@@ -101,7 +102,7 @@ Check out complete list of options and their usage at [OPTIONS.md](/OPTIONS.md)
 
 ### ConversionResult
 
-- `result` - Flag responsible for providing a status whether the conversion was successful or not 
+- `result` - Flag responsible for providing a status whether the conversion was successful or not
 
 - `reason` - Provides the reason for an unsuccessful conversion, defined only if result: false
 
@@ -160,28 +161,28 @@ The converter can be used as a CLI tool as well. The following [command line opt
 `openapi2postmanv2 [options]`
 
 ### Options
-- `-v`, `--version`  
+- `-v`, `--version`
   Specifies the version of the converter
 
-- `-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
 
-- `-t`, `--test`  
+- `-t`, `--test`
   Used to test the collection with an in-built sample specification
 
-- `-p`, `--pretty`  
+- `-p`, `--pretty`
   Used to pretty print the collection object while writing to a file
 
 - `-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)
 
-- `-h`, `--help`  
+- `-h`, `--help`
   Specifies all the options along with a few usage examples on the terminal
 
 

README.md

@@ -149,7 +149,7 @@ module.exports = {
    */
 
   resolveRefs: function (schema, parameterSourceOption, components, schemaResolutionCache,
-    resolveFor = 'CONVERSION', resolveTo = 'schema', stack = 0, seenRef = {}, stackLimit = 10, isAllOf = false) {
+    resolveFor = 'CONVERSION', resolveTo = 'schema', stack = 0, seenRef = {}, stackLimit = 8, isAllOf = false) {
     var resolvedSchema, prop, splitRef,
       ERR_TOO_MANY_LEVELS = '<Error: Too many levels of nesting to fake this schema>';
     let concreteUtils = components && components.hasOwnProperty('concreteUtils') ?

lib/deref.js

@@ -155,7 +155,7 @@ module.exports = {
         name: 'Schema resolution nesting limit',
         id: 'stackLimit',
         type: 'integer',
-        default: 10,
+        default: 8,
         description: 'Number of nesting limit till which schema resolution will happen. Increasing this limit may' +
           ' result in more time to convert collection depending on complexity of specification. (To make sure this' +
           ' option works correctly "optimizeConversion" option needs to be disabled)',

lib/options.js

@@ -309,7 +309,7 @@ module.exports = {
 
     var computedOptions = _.clone(options);
 
-    computedOptions.stackLimit = 10;
+    computedOptions.stackLimit = 8;
     // This is the score that is given to each spec on the basis of the
     // number of references present in spec and the number of requests that will be generated.
     // This ranges from 0-10.
@@ -1126,33 +1126,33 @@ module.exports = {
           helper = {
             type: 'basic',
             basic: [
-              { key: 'username', value: '<Basic Auth Username>' },
-              { key: 'password', value: '<Basic Auth Password>' }
+              { key: 'username', value: '{{basicAuthUsername}}' },
+              { key: 'password', value: '{{basicAuthPassword}}' }
             ]
           };
         }
         else if (_.toLower(securityDef.scheme) === 'bearer') {
           helper = {
             type: 'bearer',
-            bearer: [{ key: 'token', value: '<Bearer Token>' }]
+            bearer: [{ key: 'token', value: '{{bearerToken}}' }]
           };
         }
         else if (_.toLower(securityDef.scheme) === 'digest') {
           helper = {
             type: 'digest',
             digest: [
-              { key: 'username', value: '<Digest Auth Username>' },
-              { key: 'password', value: '<Digest Auth Password>' },
-              { key: 'realm', value: '<realm>' }
+              { key: 'username', value: '{{digestAuthUsername}}' },
+              { key: 'password', value: '{{digestAuthPassword}}' },
+              { key: 'realm', value: '{{realm}}' }
             ]
           };
         }
         else if (_.toLower(securityDef.scheme) === 'oauth' || _.toLower(securityDef.scheme) === 'oauth1') {
           helper = {
             type: 'oauth1',
             oauth1: [
-              { key: 'consumerSecret', value: '<OAuth 1.0 Consumer Key>' },
-              { key: 'consumerKey', value: '<OAuth 1.0 Consumer Secret>' },
+              { key: 'consumerSecret', value: '{{consumerSecret}}' },
+              { key: 'consumerKey', value: '{{consumerKey}}' },
               { key: 'addParamsToHeader', value: true }
             ]
           };
@@ -1205,7 +1205,7 @@ module.exports = {
           if (!_.isEmpty(flowObj.refreshUrl)) {
             helper.oauth2.push({
               key: 'redirect_uri',
-              value: _.isString(flowObj.refreshUrl) ? flowObj.refreshUrl : '{{OAuth2_CallbackURL}}'
+              value: _.isString(flowObj.refreshUrl) ? flowObj.refreshUrl : '{{oAuth2CallbackURL}}'
             });
           }
 
@@ -1214,7 +1214,7 @@ module.exports = {
             if (!_.isEmpty(flowObj.tokenUrl)) {
               helper.oauth2.push({
                 key: 'accessTokenUrl',
-                value: _.isString(flowObj.tokenUrl) ? flowObj.tokenUrl : '{{OAuth2_AccessTokenURL}}'
+                value: _.isString(flowObj.tokenUrl) ? flowObj.tokenUrl : '{{oAuth2AccessTokenURL}}'
               });
             }
           }
@@ -1224,7 +1224,7 @@ module.exports = {
             if (!_.isEmpty(flowObj.authorizationUrl)) {
               helper.oauth2.push({
                 key: 'authUrl',
-                value: _.isString(flowObj.authorizationUrl) ? flowObj.authorizationUrl : '{{OAuth2_AuthURL}}'
+                value: _.isString(flowObj.authorizationUrl) ? flowObj.authorizationUrl : '{{oAuth2AuthURL}}'
               });
             }
           }
@@ -1241,9 +1241,9 @@ module.exports = {
           apikey: [
             {
               key: 'key',
-              value: _.isString(securityDef.name) ? securityDef.name : '<API Key Name>'
+              value: _.isString(securityDef.name) ? securityDef.name : '{{apiKeyName}}'
             },
-            { key: 'value', value: '<API Key>' },
+            { key: 'value', value: '{{apiKey}}' },
             {
               key: 'in',
               value: _.includes(['query', 'header'], securityDef.in) ? securityDef.in : 'header'

lib/schemaUtils.js

@@ -125,7 +125,7 @@
     "lodash": "4.17.21",
     "oas-resolver-browser": "2.5.6",
     "path-browserify": "1.0.1",
-    "postman-collection": "4.1.4",
+    "postman-collection": "4.1.5",
     "swagger2openapi": "7.0.8",
     "traverse": "0.6.6",
     "yaml": "1.10.2"

package-lock.json

@@ -0,0 +1,47 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  license:
+    name: MIT
+servers:
+  - url: https://postman-echo.com/get
+security:
+  - bear: []
+paths:
+  /pets/{petId}:
+    get:
+      summary: Info for a specific pet
+      operationId: showPetById
+      tags:
+        - pets
+      parameters:
+        - name: petId
+          in: path
+          required: true
+          description: The id of the pet to retrieve
+          schema:
+            type: string
+      responses:
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+components:
+  schemas:
+    Error:
+      type: object
+      required:
+        - code
+        - message
+      properties:
+        code:
+          type: integer
+          format: int32
+        message:
+          type: string
+  securitySchemes:
+    bear:
+      type: apiKey