Merge branch 'develop' into feature/fix-validate-schema-example

Author: umeshp7

CHANGELOG.md

@@ -1,5 +1,19 @@
 # OpenAPI-Postman Changelog
 
+#### v4.6.0 (December 30, 2022)
+* Fixed issue where bundling of multi-file definition was not working correctly for more than 10 params correctly.
+* Fixed issue where request name was not using operation description if available.
+
+#### 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.

OPTIONS.md

@@ -1,6 +1,6 @@
 id|type|available options|default|description|usage
 |---|---|---|---|---|---|
-requestNameSource|enum|URL, Fallback|Fallback|Determines how the requests inside the generated collection will be named. If “Fallback” is selected, the request will be named after one of the following schema values: `description`, `operationid`, `url`.|CONVERSION, VALIDATION
+requestNameSource|enum|URL, Fallback|Fallback|Determines how the requests inside the generated collection will be named. If “Fallback” is selected, the request will be named after one of the following schema values: `summary`, `operationId`, `description`, `url`.|CONVERSION, VALIDATION
 indentCharacter|enum|Space, Tab|Space|Option for setting indentation character|CONVERSION
 collapseFolders|boolean|-|true|Importing will collapse all folders that have only one child element and lack persistent folder-level data.|CONVERSION
 optimizeConversion|boolean|-|true|Optimizes conversion for large specification, disabling this option might affect the performance of conversion.|CONVERSION
@@ -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

README.md

@@ -4,7 +4,7 @@
 *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://github.com/postmanlabs/openapi-to-postman/actions/workflows/integration.yml/badge.svg)
 
@@ -14,20 +14,26 @@
 #### 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.
 
@@ -41,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`.
 
@@ -53,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);`
 
@@ -78,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
@@ -96,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) => {
@@ -153,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 |

lib/bundle.js

@@ -237,7 +237,7 @@ function createComponentMainKey(tempRef, mainKeys) {
  */
 function getTraceFromParentKeyInComponents(nodeContext, tempRef, mainKeys, version, commonPathFromData) {
   const parents = [...nodeContext.parents].reverse(),
-    isArrayKeyRegexp = new RegExp('^\\d$', 'g'),
+    isArrayKeyRegexp = new RegExp('^\\d+$', 'g'),
     key = nodeContext.key,
     keyIsAnArrayItem = key.match(isArrayKeyRegexp),
     parentKeys = [...parents.map((parent) => {

lib/deref.js

@@ -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/options.js

@@ -64,7 +64,7 @@ module.exports = {
         availableOptions: ['URL', 'Fallback'],
         description: 'Determines how the requests inside the generated collection will be named.' +
         ' If “Fallback” is selected, the request will be named after one of the following schema' +
-        ' values: `description`, `operationid`, `url`.',
+        ' values: `summary`, `operationId`, `description`, `url`.',
         external: true,
         usage: ['CONVERSION', 'VALIDATION'],
         supportedIn: [VERSION20, VERSION30, VERSION31]
@@ -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]
       }
     ];