Merge branch 'develop' into feature/readme-update

Author: VShingala

.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

@@ -1,5 +1,12 @@
 # OpenAPI-Postman Changelog
 
+#### v4.4.0 (November 29, 2022)
+* Fixed issue where collection folder name for paths were having extra spaces.
+* Fixed issue where pipelines were failing for certain node version.
+
+#### v4.3.0 (October 17, 2022)
+* Fixed issue with nullable keywords getting validated incorrectly.
+
 #### v4.2.0 (August 10, 2022)
 * Improved the way to detect a circular reference by adding a new condition
 * A schema that comes from an allOf parent then we now return the same schema instead of defaulting to a schema with type as object, and no other properties

CHANGELOG.md

@@ -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, 3.1 and Swagger 2.0 to Postman Collection
 
-[![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. [Command Line Interface](#command-line-interface)

README.md

@@ -28,7 +28,8 @@ const _ = require('lodash'),
     'double'
   ],
   DEFAULT_SCHEMA_UTILS = require('./30XUtils/schemaUtils30X'),
-  traverseUtility = require('traverse');
+  traverseUtility = require('traverse'),
+  PROPERTIES_TO_ASSIGN_ON_CASCADE = ['type', 'nullable'];
 
 /**
    * @param {*} currentNode - the object from which you're trying to find references
@@ -148,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') ?
@@ -171,6 +172,11 @@ module.exports = {
           resolveTo, stack, _.cloneDeep(seenRef), stackLimit);
       }
       return { anyOf: _.map(schema.anyOf, (schemaElement) => {
+        PROPERTIES_TO_ASSIGN_ON_CASCADE.forEach((prop) => {
+          if (_.isNil(schemaElement[prop]) && !_.isNil(schema[prop])) {
+            schemaElement[prop] = schema[prop];
+          }
+        });
         return this.resolveRefs(schemaElement, parameterSourceOption, components, schemaResolutionCache, resolveFor,
           resolveTo, stack, _.cloneDeep(seenRef), stackLimit);
       }) };
@@ -181,8 +187,14 @@ module.exports = {
           resolveTo, stack, _.cloneDeep(seenRef), stackLimit);
       }
       return { oneOf: _.map(schema.oneOf, (schemaElement) => {
-        return this.resolveRefs(schemaElement, parameterSourceOption, components, schemaResolutionCache, resolveFor,
-          resolveTo, stack, _.cloneDeep(seenRef), stackLimit);
+        PROPERTIES_TO_ASSIGN_ON_CASCADE.forEach((prop) => {
+          if (_.isNil(schemaElement[prop]) && !_.isNil(schema[prop])) {
+            schemaElement[prop] = schema[prop];
+          }
+        });
+
+        return this.resolveRefs(schemaElement, parameterSourceOption, components, schemaResolutionCache,
+          resolveFor, resolveTo, stack, _.cloneDeep(seenRef), stackLimit);
       }) };
     }
     if (schema.allOf) {

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

@@ -273,7 +273,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.
@@ -990,7 +990,7 @@ module.exports = {
       // only return a Postman folder if this folder has>1 children in its subtree
       // otherwise we can end up with 10 levels of folders with 1 request in the end
       itemGroup = new sdk.ItemGroup({
-        name: utils.insertSpacesInName(resource.name)
+        name: resource.name
         // TODO: have to add auth here (but first, auth to be put into the openapi tree)
       });
       // If a folder has only one child which is a folder then we collapsed the child folder
@@ -1082,33 +1082,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 }
             ]
           };
@@ -1161,7 +1161,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}}'
             });
           }
 
@@ -1170,7 +1170,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}}'
               });
             }
           }
@@ -1180,7 +1180,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}}'
               });
             }
           }
@@ -1197,9 +1197,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'
@@ -2015,26 +2015,28 @@ module.exports = {
       }
       else {
         let getXmlVersionContent = (bodyContent) => {
-          const regExp = new RegExp('([<\\?xml]+[\\s{1,}]+[version="\\d.\\d"]+[\\sencoding="]+.{1,15}"\\?>)');
-          let xmlBody = bodyContent;
+            const regExp = new RegExp('([<\\?xml]+[\\s{1,}]+[version="\\d.\\d"]+[\\sencoding="]+.{1,15}"\\?>)');
+            let xmlBody = bodyContent;
 
-          if (!bodyContent.match(regExp)) {
-            const versionContent = '<?xml version="1.0" encoding="UTF-8"?>\n';
-            xmlBody = versionContent + xmlBody;
-          }
-          return xmlBody;
-        };
+            if (!bodyContent.match(regExp)) {
+              const versionContent = '<?xml version="1.0" encoding="UTF-8"?>\n';
+              xmlBody = versionContent + xmlBody;
+            }
+            return xmlBody;
+          },
+          headerFamily;
 
         bodyData = this.convertToPmBodyData(contentObj[bodyType], requestType, bodyType,
           PARAMETER_SOURCE.REQUEST, options.indentCharacter, components, options, schemaCache);
 
-        bodyData = (bodyType === TEXT_XML || bodyType === APP_XML) ?
+        headerFamily = this.getHeaderFamily(bodyType);
+        bodyData = (bodyType === TEXT_XML || bodyType === APP_XML || headerFamily === HEADER_TYPE.XML) ?
           getXmlVersionContent(bodyData) :
           bodyData;
 
         updateOptions = {
           mode: rDataMode,
-          raw: bodyType !== APP_JSON ?
+          raw: !_.isObject(bodyData) && _.isFunction(_.get(bodyData, 'toString')) ?
             bodyData.toString() :
             JSON.stringify(bodyData, null, options.indentCharacter)
         };

lib/schemaUtils.js

@@ -1,6 +1,6 @@
 {
   "name": "openapi-to-postmanv2",
-  "version": "4.2.0",
+  "version": "4.4.0",
   "description": "Convert a given OpenAPI specification to Postman Collection v2.0",
   "homepage": "https://github.com/postmanlabs/openapi-to-postman",
   "bugs": "https://github.com/postmanlabs/openapi-to-postman/issues",