Merge branch 'release/4.5.0'

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,15 @@
 # OpenAPI-Postman Changelog
 
+#### v4.5.0 (December 23, 2022)
+* Fixed issue [#11519](https://github.com/postmanlabs/postman-app-support/issues/11519) Collection generated from imported OpenAPI were missing certain properties.
+* Fixed issue [#11227](https://github.com/postmanlabs/postman-app-support/issues/11227) Collection generated produces incorrect XML requests and responses from Open API 3.0 and Swagger 2.0 API definitions.
+* Fixed issue [#11527](https://github.com/postmanlabs/postman-app-support/issues/11527) where generated collection contained empty body when */* was used as content-type.
+* Fixed issue [#626](https://github.com/postmanlabs/openapi-to-postman/issues/626) - Add a new option (includeDeprecated) to handle deprecated properties (operations, parameters, or schema properties).
+* Fixed issue [#643](https://github.com/postmanlabs/openapi-to-postman/issues/643) Generated value for corresponding authorization should be an environment value.
+* Removed travis workflows as GitHub actions are present now.
+* Updated README.md to include Swagger 2.0 and OpenAPI 3.1 support.
+* Updated README.md to include new postman logo.
+
 #### 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.

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
@@ -23,3 +23,4 @@ disableOptionalParameters|boolean|-|false|Whether to set optional parameters as
 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
+includeDeprecated|boolean|-|true|Select whether to include deprecated operations, parameters, and properties in generated collection or not|CONVERSION, VALIDATION

OPTIONS.md

@@ -1,32 +1,39 @@
 
-![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
+# 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. [Using the converter as a NodeJS module](#using-the-converter-as-a-nodejs-module)
+2. [Command Line Interface](#command-line-interface)
+    1. [Options](#options)
+    2. [Usage](#usage)
+3. [Using the converter as a NodeJS module](#using-the-converter-as-a-nodejs-module)
     1. [Convert Function](#convert)
     2. [Options](#options)
     3. [ConversionResult](#conversionresult)
     4. [Sample usage](#sample-usage)
     5. [Validate function](#validate-function)
-3. [Command Line Interface](#command-line-interface)
-    1. [Options](#options)
-    2. [Usage](#usage)
 4. [Conversion Schema](#conversion-schema)
 
 ---
 
-## Getting Started
+---
+
+### 🚀 We now also support OpenAPI 3.1 and Swagger 2.0 along with OpenAPI 3.0.
+---
+---
+
+## 💭 Getting Started
 
 To use the converter as a Node module, you need to have a copy of the NodeJS runtime. The easiest way to do this is through npm. If you have NodeJS installed you have npm installed as well.
 
@@ -40,7 +47,64 @@ If you want to use the converter in the CLI, install it globally with NPM:
 $ npm i -g openapi-to-postmanv2
 ```
 
-## Using the converter as a NodeJS module
+
+## 📖 Command Line Interface
+
+The converter can be used as a CLI tool as well. The following [command line options](#options) are available.
+
+`openapi2postmanv2 [options]`
+
+### Options
+
+- `-s <source>`, `--spec <source>`  
+  Used to specify the OpenAPI specification (file path) which is to be converted
+
+- `-o <destination>`, `--output <destination>`  
+  Used to specify the destination file in which the collection is to be written
+
+- `-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`  
+  Used to supply options to the converter through config file, for complete options details see [here](/OPTIONS.md)
+
+- `-t`, `--test`  
+  Used to test the collection with an in-built sample specification
+
+- `-v`, `--version`  
+  Specifies the version of the converter
+
+- `-h`, `--help`  
+  Specifies all the options along with a few usage examples on the terminal
+
+
+###  Usage
+
+- Takes a specification (spec.yaml) as an input and writes to a file (collection.json) with pretty printing and using provided options
+```terminal
+$ openapi2postmanv2 -s spec.yaml -o collection.json -p -O folderStrategy=Tags,includeAuthInfoInExample=false
+```
+
+- Takes a specification (spec.yaml) as an input and writes to a file (collection.json) with pretty printing and using provided options via config file
+```terminal
+$ openapi2postmanv2 -s spec.yaml -o collection.json -p  -c ./examples/cli-options-config.json
+```
+
+- Takes a specification (spec.yaml) as an input and writes to a file (collection.json) with pretty printing and using provided options (Also avoids any `"<Error: Too many levels of nesting to fake this schema>"` kind of errors present in converted collection)
+```terminal
+$ openapi2postmanv2 -s spec.yaml -o collection.json -p -O folderStrategy=Tags,requestParametersResolution=Example,optimizeConversion=false,stackLimit=50
+```
+
+- Testing the converter
+```terminal
+$ openapi2postmanv2 --test
+```
+
+
+## 🛠 Using the converter as a NodeJS module
 
 In order to use the convert in your node application, you need to import the package using `require`.
 
@@ -52,7 +116,7 @@ The converter provides the following functions:
 
 ### Convert
 
-The convert function takes in your OpenAPI specification ( YAML / JSON ) and converts it to a Postman collection.
+The convert function takes in your OpenAPI 3.0, 3.1 and Swagger 2.0 specification ( YAML / JSON ) and converts it to a Postman collection.
 
 Signature: `convert (data, options, callback);`
 
@@ -77,6 +141,7 @@ OR
 All three properties are optional. Check the options section below for possible values for each option.
 */
 ```
+Note: All possible values of options and their usage can be found over here: [OPTIONS.md](/OPTIONS.md)
 
 **callback:**
 ```javascript
@@ -95,26 +160,25 @@ function (err, result) {
 }
 ```
 
-### Options:
+### Options
 
 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
+- `reason` - Provides the reason for an unsuccessful conversion, defined only if result if `false`.
 
 - `output` - Contains an array of Postman objects, each one with a `type` and `data`. The only type currently supported is `collection`.
 
 
 
-### Sample Usage:
+### Sample Usage
 ```javascript
-var fs = require('fs'),
-
-Converter = require('openapi-to-postmanv2'),
-openapiData = fs.readFileSync('sample-spec.yaml', {encoding: 'UTF8'});
+const fs = require('fs'),
+  Converter = require('openapi-to-postmanv2'),
+  openapiData = fs.readFileSync('sample-spec.yaml', {encoding: 'UTF8'});
 
 Converter.convert({ type: 'string', data: openapiData },
   {}, (err, conversionResult) => {
@@ -152,77 +216,19 @@ The validate function is synchronous and returns a status object which conforms
 
 - `reason` - Provides a reason for an unsuccessful validation of the specification
 
+## 🧭 Conversion Schema
 
-## Command Line Interface
-
-The converter can be used as a CLI tool as well. The following [command line options](#options) are available.
-
-`openapi2postmanv2 [options]`
-
-### Options
-- `-v`, `--version`  
-  Specifies the version of the converter
-
-- `-s <source>`, `--spec <source>`  
-  Used to specify the OpenAPI specification (file path) which is to be converted
-
-- `-o <destination>`, `--output <destination>`  
-  Used to specify the destination file in which the collection is to be written
-
-- `-t`, `--test`  
-  Used to test the collection with an in-built sample specification
-
-- `-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`  
-  Used to supply options to the converter through config file, for complete options details see [here](/OPTIONS.md)
-
-- `-h`, `--help`  
-  Specifies all the options along with a few usage examples on the terminal
-
-
-### Usage
-
-**Sample usage examples of the converter CLI**
-
-
-- Takes a specification (spec.yaml) as an input and writes to a file (collection.json) with pretty printing and using provided options
-```terminal
-$ openapi2postmanv2 -s spec.yaml -o collection.json -p -O folderStrategy=Tags,includeAuthInfoInExample=false
-```
-
-- Takes a specification (spec.yaml) as an input and writes to a file (collection.json) with pretty printing and using provided options via config file
-```terminal
-$ openapi2postmanv2 -s spec.yaml -o collection.json -p  -c ./examples/cli-options-config.json
-```
-
-- Takes a specification (spec.yaml) as an input and writes to a file (collection.json) with pretty printing and using provided options (Also avoids any `"<Error: Too many levels of nesting to fake this schema>"` kind of errors present in converted collection)
-```terminal
-$ openapi2postmanv2 -s spec.yaml -o collection.json -p -O folderStrategy=Tags,requestParametersResolution=Example,optimizeConversion=false,stackLimit=50
-```
-
-- Testing the converter
-```terminal
-$ openapi2postmanv2 --test
-```
-
-## Conversion Schema
-
-| *postman* | *openapi* | *options* | *examples* |
-| --- | --- | :---: | :--- |
-| collectionName | info.title | - |  |
-| description | info.description + info.contact | - |  |
-| collectionVariables| server.variables + pathVariables | - |  |
-| folderName | paths.path | - |  |
-| requestName | operationItem(method).operationId | default(operationId)-(`requestName`)enum['operationId','summary','url'] |  |
-| request.method | path.method | - |  |
+| *postman* | *openapi* | *related options* |
+| --- | --- | :---: |
+| collectionName | info.title | - |
+| description | info.description + info.contact | - |
+| collectionVariables| server.variables + pathVariables | - |
+| folderName | paths.path / tags.name | folderStrategy |
+| requestName | operationItem(method).summary / operationItem(method).operationId / url | requestNameSource |
+| request.method | path.method | - |
 | request.headers | parameter (`in = header`) | - | [link](#Header/Path-param-conversion-example) |
-| request.body | operationItem(method).requestBody | - |  |
-| request.url.raw | server.url (path level server >> openapi server) + path | - |  |
-| request.url.variables | parameter (`in = path`) | - | [link](#Header/Path-param-conversion-example) |
-| request.url.params | parameter (`in = query`) | - | {"key": param.name, "value": [link](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#style-examples)}|
-| api_key in (query or header) | components.securitySchemes.api_key | - ||
+| request.body | operationItem(method).requestBody | requestParametersResolution, exampleParametersResolution |
+| request.url.raw | server.url (path level server >> openapi server) + path | - |
+| request.url.variables | parameter (`in = path`) | - |
+| request.url.params | parameter (`in = query`) | - |
+| api_key in (query or header) | components.securitySchemes.api_key | includeAuthInfoInExample |

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') ?
@@ -247,16 +247,20 @@ module.exports = {
       }
       return { value: 'reference ' + schema.$ref + ' not found in the OpenAPI spec' };
     }
-    if (concreteUtils.compareTypes(schema.type, SCHEMA_TYPES.object) || schema.hasOwnProperty('properties') ||
-      schema.hasOwnProperty('additionalProperties')) {
+
+    if (
+      concreteUtils.compareTypes(schema.type, SCHEMA_TYPES.object) ||
+      schema.hasOwnProperty('properties') ||
+      (schema.hasOwnProperty('additionalProperties') && !schema.hasOwnProperty('type'))
+    ) {
       // go through all props
       schema.type = SCHEMA_TYPES.object;
+
       if (_.has(schema, 'properties') || _.has(schema, 'additionalProperties')) {
-        // shallow cloning schema object except properties object
         let tempSchema = _.omit(schema, ['properties', 'additionalProperties']);
+        // shallow cloning schema object except properties object
 
         if (_.has(schema, 'additionalProperties')) {
-          // don't resolve boolean values
           if (_.isBoolean(schema.additionalProperties)) {
             tempSchema.additionalProperties = schema.additionalProperties;
           }
@@ -332,7 +336,8 @@ module.exports = {
       // have to create a shallow clone of schema object,
       // so that the original schema.items object will not change
       // without this, schemas with circular references aren't faked correctly
-      let tempSchema = _.omit(schema, 'items');
+      let tempSchema = _.omit(schema, ['items', 'additionalProperties']);
+
       tempSchema.items = this.resolveRefs(schema.items, parameterSourceOption,
         components, schemaResolutionCache, resolveFor, resolveTo, stack, _.cloneDeep(seenRef), stackLimit);
       return tempSchema;

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)',
@@ -308,6 +308,17 @@ module.exports = {
         external: false,
         usage: ['BUNDLE'],
         supportedIn: [VERSION20, VERSION30, VERSION31]
+      },
+      {
+        name: 'Include deprecated properties',
+        id: 'includeDeprecated',
+        type: 'boolean',
+        default: true,
+        description: 'Select whether to include deprecated operations, parameters,' +
+          ' and properties in generated collection or not',
+        external: true,
+        usage: ['CONVERSION', 'VALIDATION'],
+        supportedIn: [VERSION20, VERSION30, VERSION31]
       }
     ];