[pull] develop from postmanlabs:develop

CHANGELOG.md

@@ -2,6 +2,45 @@
 
 ## [Unreleased]
 
+## [v4.24.0] - 2024-08-13
+
+### Added
+
+-   [#98](https://github.com/postmanlabs/openapi-to-postman/issues/98) [12255](https://github.com/postmanlabs/postman-app-support/issues/12255) Added support for readOnly and writeOnly properties to be correctly present in generated collection.
+
+### Chore
+
+-   Replaced traverse with neotraverse.
+
+## [v4.23.1] - 2024-07-22
+
+### Added
+
+-   Conversion - Added option to set preferred request body content-type and use the first mentioned content-type as request body.
+
+### Fixed
+
+-   Fixed issue with getOptions() API where default module version was still v1.
+-   Fix to convert "format:binary" to "type:file" for requests with formdata body.
+
+## [v4.22.0] - 2024-07-10
+
+### Chore
+
+-   Updated postman-collection to v4.4.0.
+
+## [v4.21.0] - 2024-05-17
+
+### Added
+
+-   Added support for simplified request and response body matching in case of multiple examples.
+
+## [v4.20.1] - 2024-03-27
+
+### Fixed
+
+-   Fixed an issue where schemas under allOf keyword having additionalProperties set to false were not generating bodies correctly.
+
 ## [v4.20.0] - 2024-02-15
 
 ### Added
@@ -608,7 +647,17 @@ Newer releases follow the [Keep a Changelog](https://keepachangelog.com/en/1.0.0
 
 -   Base release
 
-[Unreleased]: https://github.com/postmanlabs/openapi-to-postman/compare/v4.20.0...HEAD
+[Unreleased]: https://github.com/postmanlabs/openapi-to-postman/compare/v4.24.0...HEAD
+
+[v4.24.0]: https://github.com/postmanlabs/openapi-to-postman/compare/v4.23.1...v4.24.0
+
+[v4.23.1]: https://github.com/postmanlabs/openapi-to-postman/compare/v4.22.0...v4.23.1
+
+[v4.22.0]: https://github.com/postmanlabs/openapi-to-postman/compare/v4.21.0...v4.22.0
+
+[v4.21.0]: https://github.com/postmanlabs/openapi-to-postman/compare/v4.20.1...v4.21.0
+
+[v4.20.1]: https://github.com/postmanlabs/openapi-to-postman/compare/v4.20.0...v4.20.1
 
 [v4.20.0]: https://github.com/postmanlabs/openapi-to-postman/compare/v4.19.0...v4.20.0
 

OPTIONS.md

@@ -6,8 +6,11 @@ collapseFolders|boolean|-|true|Importing will collapse all folders that have onl
 optimizeConversion|boolean|-|true|Optimizes conversion for large specification, disabling this option might affect the performance of conversion.|CONVERSION|v1
 requestParametersResolution|enum|Example, Schema|Schema|Select whether to generate the request 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|v1
 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|v1
+disabledParametersValidation|boolean|-|true|Whether disabled parameters of collection should be validated|VALIDATION|v2, v1
 parametersResolution|enum|Example, Schema|Schema|Select whether to generate the request and 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|v2, v1
 folderStrategy|enum|Paths, Tags|Paths|Select whether to create folders according to the spec’s paths or tags.|CONVERSION|v2, v1
+schemaFaker|boolean|-|true|Whether or not schemas should be faked.|CONVERSION|v2, v1
+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|v2, v1
 includeAuthInfoInExample|boolean|-|true|Select whether to include authentication parameters in the example request.|CONVERSION|v2, v1
 shortValidationErrors|boolean|-|false|Whether detailed error messages are required for request <> schema validation operations.|VALIDATION|v2, v1
 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|v2, v1
@@ -20,5 +23,8 @@ strictRequestMatching|boolean|-|false|Whether requests should be strictly matche
 allowUrlPathVarMatching|boolean|-|false|Whether to allow matching path variables that are available as part of URL itself in the collection request|VALIDATION|v2, v1
 enableOptionalParameters|boolean|-|true|Optional parameters aren't selected in the collection. Once enabled they will be selected in the collection and request as well.|CONVERSION|v2, v1
 keepImplicitHeaders|boolean|-|false|Whether to keep implicit headers from the OpenAPI specification, which are removed by default.|CONVERSION|v2, v1
+includeWebhooks|boolean|-|false|Select whether to include Webhooks in the generated collection|CONVERSION|v2, v1
+includeReferenceMap|boolean|-|false|Whether or not to include reference map or not as part of output|BUNDLE|v2, v1
 includeDeprecated|boolean|-|true|Select whether to include deprecated operations, parameters, and properties in generated collection or not|CONVERSION, VALIDATION|v2, v1
 alwaysInheritAuthentication|boolean|-|false|Whether authentication details should be included on every request, or always inherited from the collection.|CONVERSION|v2, v1
+preferredRequestBodyType|enum|x-www-form-urlencoded, form-data, raw, first-listed|first-listed|When there are multiple content-types defined in the request body of OpenAPI, the conversion selects the preferred option content-type as request body.If "first-listed" is set, the first content-type defined in the OpenAPI spec will be selected.|CONVERSION|v2

lib/bundle.js

@@ -14,7 +14,7 @@ const _ = require('lodash'),
     jsonPointerDecodeAndReplace,
     generateObjectName
   } = require('./jsonPointer'),
-  traverseUtility = require('traverse'),
+  traverseUtility = require('neotraverse/legacy'),
   parse = require('./parse.js'),
   { ParseError } = require('./common/ParseError'),
   Utils = require('./utils'),

lib/common/versionUtils.js

@@ -212,9 +212,10 @@ function getSpecVersion({ type, data, specificationVersion }) {
   const openapi30 = getVersionRegexp(VERSION_30),
     openapi31 = getVersionRegexp(VERSION_31),
     openapi20 = getVersionRegexp(VERSION_20),
-    is30 = data.match(openapi30),
-    is31 = data.match(openapi31),
-    is20 = data.match(openapi20);
+    is30 = typeof data === 'string' && data.match(openapi30),
+    is31 = typeof data === 'string' && data.match(openapi31),
+    is20 = typeof data === 'string' && data.match(openapi20);
+
   let version = DEFAULT_SPEC_VERSION;
 
   if (is30) {

lib/deref.js

@@ -35,7 +35,7 @@ const _ = require('lodash'),
     isAllOf: false
   },
   DEFAULT_SCHEMA_UTILS = require('./30XUtils/schemaUtils30X'),
-  traverseUtility = require('traverse'),
+  traverseUtility = require('neotraverse/legacy'),
   PROPERTIES_TO_ASSIGN_ON_CASCADE = ['type', 'nullable'];
 
 /**
@@ -131,6 +131,8 @@ module.exports = {
             { stack, seenRef: _.cloneDeep(seenRef), resolveFor, resolveTo, stackLimit, isAllOf: true, analytics });
         })
       }), {
+        // below option is required to make sure schemas with additionalProperties set to false are resolved correctly
+        ignoreAdditionalProperties: true,
         resolvers: {
           // for keywords in OpenAPI schema that are not standard defined JSON schema keywords, use default resolver
           defaultResolver: (compacted) => { return compacted[0]; },

lib/options.js

@@ -47,10 +47,12 @@ module.exports = {
    *
    * @param {string} [mode='document'] Describes use-case. 'document' will return an array
    * with all options being described. 'use' will return the default values of all options
-   * @param {Object} criteria Decribes required criteria for options to be returned. can have properties
-   *   external: <boolean>
-   *   usage: <array> (Array of supported usage type - CONVERSION, VALIDATION)
-   *   version: <string> ('3.0' by default, supported values: '3.0', '3.1')
+   * @param {Object} criteria Decribes required criteria for options to be returned.
+   * @param {string} criteria.version The version of the OpenAPI spec to be converted
+   *  (can be one of '2.0', '3.0', '3.1')
+   * @param {string} criteria.moduleVersion The version of the module (can be one of 'v1' or 'v2')
+   * @param {Array<string>} criteria.usage The usage of the option (values can be one of 'CONVERSION', 'VALIDATION')
+   * @param {boolean} criteria.external Whether the option is exposed to Postman App UI or not
    * @returns {mixed} An array or object (depending on mode) that describes available options
    */
   getOptions: function(mode = 'document', criteria = {}) {
@@ -386,6 +388,20 @@ module.exports = {
         usage: ['CONVERSION'],
         supportedIn: [VERSION20, VERSION30, VERSION31],
         supportedModuleVersion: [MODULE_VERSION.V2, MODULE_VERSION.V1]
+      },
+      {
+        name: 'Select request body type',
+        id: 'preferredRequestBodyType',
+        type: 'enum',
+        default: 'first-listed',
+        availableOptions: ['x-www-form-urlencoded', 'form-data', 'raw', 'first-listed'],
+        description: 'When there are multiple content-types defined in the request body of OpenAPI, the conversion ' +
+          'selects the preferred option content-type as request body.If "first-listed" is set, the first ' +
+          'content-type defined in the OpenAPI spec will be selected.',
+        external: false,
+        usage: ['CONVERSION'],
+        supportedIn: [VERSION20, VERSION30, VERSION31],
+        supportedModuleVersion: [MODULE_VERSION.V2]
       }
     ];
 
@@ -408,7 +424,7 @@ module.exports = {
         }
 
         // Setting default value
-        criteria.moduleVersion = _.has(criteria, 'moduleVersion') ? criteria.moduleVersion : MODULE_VERSION.V1;
+        criteria.moduleVersion = _.has(criteria, 'moduleVersion') ? criteria.moduleVersion : MODULE_VERSION.V2;
 
         if (!_.includes(option.supportedModuleVersion, criteria.moduleVersion)) {
           return false;

lib/relatedFiles.js

@@ -1,5 +1,5 @@
 const parse = require('./parse.js'),
-  traverseUtility = require('traverse'),
+  traverseUtility = require('neotraverse/legacy'),
   BROWSER = 'browser',
   { DFS } = require('./dfs'),
   { isExtRef, removeLocalReferenceFromPath } = require('./jsonPointer');