Merge pull request #709 from postmanlabs/feature/enable-optional-params

Added support for enableOptionalParameters option in v2 interface.

Author: VShingala

OPTIONS.md

@@ -18,6 +18,6 @@ validateMetadata|boolean|-|false|Whether to show mismatches for incorrect name a
 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
+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
 includeDeprecated|boolean|-|true|Select whether to include deprecated operations, parameters, and properties in generated collection or not|CONVERSION, VALIDATION|v2, v1

lib/options.js

@@ -328,7 +328,7 @@ module.exports = {
         external: true,
         usage: ['CONVERSION'],
         supportedIn: [VERSION20, VERSION30, VERSION31],
-        supportedModuleVersion: [MODULE_VERSION.V1]
+        supportedModuleVersion: [MODULE_VERSION.V2, MODULE_VERSION.V1]
       },
       {
         name: 'Keep implicit headers',

libV2/schemaUtils.js

@@ -926,11 +926,13 @@ let QUERYPARAM = 'query',
 
   serialiseParamsBasedOnStyle = (context, param, paramValue) => {
     const { style, explode, startValue, propSeparator, keyValueSeparator, isExplodable } =
-      getParamSerialisationInfo(context, param);
+      getParamSerialisationInfo(context, param),
+      { enableOptionalParameters } = context.computedOptions;
 
     let serialisedValue = '',
       description = getParameterDescription(param),
       paramName = _.get(param, 'name'),
+      disabled = !enableOptionalParameters && _.get(param, 'required') !== true,
       pmParams = [],
       isNotSerializable = false;
 
@@ -945,7 +947,8 @@ let QUERYPARAM = 'query',
             pmParams.push({
               key: isArrayValue ? paramName : key,
               value: (value === undefined ? '' : _.toString(value)),
-              description
+              description,
+              disabled
             });
           });
 
@@ -961,7 +964,8 @@ let QUERYPARAM = 'query',
             pmParams.push({
               key: extractedParam.key,
               value: _.toString(extractedParam.value) || '',
-              description
+              description,
+              disabled
             });
           });
 
@@ -971,7 +975,8 @@ let QUERYPARAM = 'query',
           isNotSerializable = true;
           pmParams.push({
             key: paramName,
-            value: '<Error: Not supported in OAS>'
+            value: '<Error: Not supported in OAS>',
+            disabled
           });
         }
 
@@ -1004,7 +1009,8 @@ let QUERYPARAM = 'query',
     pmParams.push({
       key: paramName,
       value: _.toString(serialisedValue),
-      description
+      description,
+      disabled
     });
 
     return pmParams;

libV2/validationUtils.js

@@ -1735,7 +1735,7 @@ function checkQueryParams (context, queryParams, transactionPathPrefix, schemaPa
     requestQueryParams = [],
     resolvedSchemaParams = [],
     mismatchProperty = 'QUERYPARAM',
-    { includeDeprecated } = context.computedOptions;
+    { includeDeprecated, enableOptionalParameters } = context.computedOptions;
 
   if (options.validationPropertiesToIgnore.includes(mismatchProperty)) {
     return callback(null, []);
@@ -1837,6 +1837,11 @@ function checkQueryParams (context, queryParams, transactionPathPrefix, schemaPa
         return;
       }
 
+      // If optional parameters are disabled, do not report them as missing
+      if (!enableOptionalParameters && qp.required !== true) {
+        return;
+      }
+
       if (!_.find(requestQueryParams, (param) => {
         return param.key === qp.name;
       })) {
@@ -1888,7 +1893,7 @@ function checkRequestHeaders (context, headers, transactionPathPrefix, schemaPat
       return !_.includes(IMPLICIT_HEADERS, _.toLower(_.get(header, 'key')));
     }),
     mismatchProperty = 'HEADER',
-    { includeDeprecated } = context.computedOptions;
+    { includeDeprecated, enableOptionalParameters } = context.computedOptions;
 
   if (options.validationPropertiesToIgnore.includes(mismatchProperty)) {
     return callback(null, []);
@@ -1974,6 +1979,11 @@ function checkRequestHeaders (context, headers, transactionPathPrefix, schemaPat
           return;
         }
 
+        // If optional parameters are disabled, do not report them as missing
+        if (!enableOptionalParameters && header.required !== true) {
+          return;
+        }
+
         // assign parameter example(s) as schema examples;
         assignParameterExamples(header);
 
@@ -2019,7 +2029,7 @@ function checkResponseHeaders (context, schemaResponse, headers, transactionPath
       return !_.includes(IMPLICIT_HEADERS, _.toLower(_.get(header, 'key')));
     }),
     mismatchProperty = 'RESPONSE_HEADER',
-    { includeDeprecated } = context.computedOptions;
+    { includeDeprecated, enableOptionalParameters } = context.computedOptions;
 
   if (options.validationPropertiesToIgnore.includes(mismatchProperty)) {
     return callback(null, []);
@@ -2098,6 +2108,11 @@ function checkResponseHeaders (context, schemaResponse, headers, transactionPath
         return;
       }
 
+      // If optional parameters are disabled, do not report them as missing
+      if (!enableOptionalParameters && header.required !== true) {
+        return;
+      }
+
       if (!_.find(resHeaders, (param) => { return param.key === header.name; })) {
 
         // assign parameter example(s) as schema examples;
@@ -2139,7 +2154,7 @@ function checkRequestBody (context, requestBody, transactionPathPrefix, schemaPa
   let jsonSchemaBody,
     jsonContentType,
     mismatchProperty = 'BODY',
-    { includeDeprecated } = context.computedOptions;
+    { includeDeprecated, enableOptionalParameters } = context.computedOptions;
 
   if (options.validationPropertiesToIgnore.includes(mismatchProperty)) {
     return callback(null, []);
@@ -2278,6 +2293,11 @@ function checkRequestBody (context, requestBody, transactionPathPrefix, schemaPa
           return;
         }
 
+        // If optional parameters are disabled, do not report them as missing
+        if (!enableOptionalParameters && uParam.required !== true) {
+          return;
+        }
+
         // report mismatches only for required properties
         if (!_.find(filteredUrlEncodedBody, (param) => { return param.key === uParam.name; })) {
           mismatchObj = {