Merge branch 'release/4.10.1'

Author: VShingala

CHANGELOG.md

@@ -1,5 +1,10 @@
 # OpenAPI-Postman Changelog
 
+#### v4.10.1 (March 09, 2023)
+* Fixed issue where request name generated were not validated correctly.
+* Fixed test where getOptions() was not using criteria correctly.
+* Fixed issue where deprecated params were reported missing even for includeDeprecated=false
+
 #### v4.10.0 (March 08, 2023)
 * Added support for convertV2() interface which has more stacklimit for schema resolution.
 * Added support for validateTransactionV2() interface uses same v2 interface for resolving schema.

OPTIONS.md

@@ -1,28 +1,23 @@
-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: `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
-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
-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
-disabledParametersValidation|boolean|-|true|Whether disabled parameters of collection should be validated|VALIDATION
-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
-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
-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
-showMissingInSchemaErrors|boolean|-|false|MISSING_IN_SCHEMA indicates that an extra parameter was included in the request. For most use cases, this need not be considered an error.|VALIDATION
-detailedBlobValidation|boolean|-|false|Determines whether to show detailed mismatch information for application/json content in the request/response body.|VALIDATION
-suggestAvailableFixes|boolean|-|false|Whether to provide fixes for patching corresponding mismatches.|VALIDATION
-validateMetadata|boolean|-|false|Whether to show mismatches for incorrect name and description of request|VALIDATION
-ignoreUnresolvedVariables|boolean|-|false|Whether to ignore mismatches resulting from unresolved variables in the Postman request|VALIDATION
-strictRequestMatching|boolean|-|false|Whether requests should be strictly matched with schema operations. Setting to true will not include any matches where the URL path segments don't match exactly.|VALIDATION
-allowUrlPathVarMatching|boolean|-|false|Whether to allow matching path variables that are available as part of URL itself in the collection request|VALIDATION
-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
-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
+id|type|available options|default|description|usage|version
+|---|---|---|---|---|---|---|
+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|v2, v1
+indentCharacter|enum|Space, Tab|Space|Option for setting indentation character.|CONVERSION|v2, v1
+collapseFolders|boolean|-|true|Importing will collapse all folders that have only one child element and lack persistent folder-level data.|CONVERSION|v1
+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
+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
+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
+showMissingInSchemaErrors|boolean|-|false|MISSING_IN_SCHEMA indicates that an extra parameter was included in the request. For most use cases, this need not be considered an error.|VALIDATION|v2, v1
+detailedBlobValidation|boolean|-|false|Determines whether to show detailed mismatch information for application/json content in the request/response body.|VALIDATION|v2, v1
+suggestAvailableFixes|boolean|-|false|Whether to provide fixes for patching corresponding mismatches.|VALIDATION|v2, v1
+validateMetadata|boolean|-|false|Whether to show mismatches for incorrect name and description of request|VALIDATION|v2, v1
+ignoreUnresolvedVariables|boolean|-|false|Whether to ignore mismatches resulting from unresolved variables in the Postman request|VALIDATION|v2, v1
+strictRequestMatching|boolean|-|false|Whether requests should be strictly matched with schema operations. Setting to true will not include any matches where the URL path segments don't match exactly.|VALIDATION|v2, v1
+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|v1
+keepImplicitHeaders|boolean|-|false|Whether to keep implicit headers from the OpenAPI specification, which are removed by default.|CONVERSION|v2, v1
+includeDeprecated|boolean|-|true|Select whether to include deprecated operations, parameters, and properties in generated collection or not|CONVERSION, VALIDATION|v2, v1

lib/options.js

@@ -377,31 +377,34 @@ module.exports = {
       }
     ];
 
-    // Filter options based on criteria
-    if (_.isObject(criteria)) {
-      typeof criteria.external === 'boolean' && (optsArray = _.filter(optsArray, { external: criteria.external }));
-      if (_.isArray(criteria.usage)) {
-        let tempOptsArray = [];
+    optsArray = _.filter(optsArray, (option) => {
+      if (option.disabled) { return false; }
 
-        _.forEach(criteria.usage, (usageCriteria) => {
-          tempOptsArray = _.concat(tempOptsArray, _.filter(optsArray, (option) => {
-            return _.includes(option.usage, usageCriteria);
-          }));
-        });
-        optsArray = tempOptsArray;
-      }
+      if (_.isObject(criteria)) {
+        if (typeof criteria.external === 'boolean' && option.external !== criteria.external) {
+          return false;
+        }
 
-      if (_.has(criteria, 'moduleVersion')) {
-        optsArray = _.filter(optsArray, (option) => {
-          return _.includes(option.supportedModuleVersion, criteria.moduleVersion);
-        });
-      }
-      else {
-        optsArray = _.filter(optsArray, (option) => {
-          return _.includes(option.supportedModuleVersion, MODULE_VERSION.V1);
-        });
+        if (_.isArray(criteria.usage)) {
+          /**
+           * We return return a option if any of the criteria.usage value matches with what is
+           * available in option.usage
+           */
+          if (_.difference(criteria.usage, option.usage).length === criteria.usage.length) {
+            return false;
+          }
+        }
+
+        // Setting default value
+        criteria.moduleVersion = _.has(criteria, 'moduleVersion') ? criteria.moduleVersion : MODULE_VERSION.V1;
+
+        if (!_.includes(option.supportedModuleVersion, criteria.moduleVersion)) {
+          return false;
+        }
       }
-    }
+
+      return true;
+    });
 
     if (mode === 'use') {
       // options to be used as default kv-pairs
@@ -420,10 +423,6 @@ module.exports = {
       return defOptions;
     }
 
-    // options to be used as documentation
-    return _.filter(optsArray, (opt) => {
-      // only return options that are not disabled
-      return opt.disabled !== true;
-    });
+    return optsArray;
   }
 };

libV2/schemaUtils.js

@@ -1512,6 +1512,9 @@ let QUERYPARAM = 'query',
       }
     }
 
+    // Request name should be max 256 characters so trim if needed.
+    reqName = utils.trimRequestName(reqName);
+
     return reqName;
   },