Merge pull request #303 from edclements/feature/disable-optional-parameters

Disable optional parameters

Author: VShingala

OPTIONS.md

@@ -16,3 +16,4 @@ suggestAvailableFixes|boolean|-|false|Whether to provide fixes for patching corr
 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
+disableOptionalParameters|boolean|-|false|Whether to set optional parameters (not required) as disabled|CONVERSION

lib/options.js

@@ -201,6 +201,15 @@ module.exports = {
           'include any matches where the URL path segments don\'t match exactly.',
         external: true,
         usage: ['VALIDATION']
+      },
+      {
+        name: 'Disable optional parameters',
+        id: 'disableOptionalParameters',
+        type: 'boolean',
+        default: false,
+        description: 'Whether to set optional parameters (not required) as disabled',
+        external: true,
+        usage: ['CONVERSION']
       }
     ];
 

lib/schemaUtils.js

@@ -920,7 +920,7 @@ module.exports = {
             options.stackLimit) : '';
 
         convertedPathVar = this.convertParamsWithStyle(variable, fakedData, PARAMETER_SOURCE.REQUEST,
-          components, schemaCache);
+          components, schemaCache, options);
 
         variables = _.concat(variables, convertedPathVar);
       });
@@ -1455,7 +1455,7 @@ module.exports = {
         // https://github.com/postmanlabs/postman-app-support/issues/6500
         paramValue = paramValue.toString();
       }
-      return this.convertParamsWithStyle(param, paramValue, PARAMETER_SOURCE.REQUEST, components, schemaCache);
+      return this.convertParamsWithStyle(param, paramValue, PARAMETER_SOURCE.REQUEST, components, schemaCache, options);
     }
 
     let description = this.getParameterDescription(param);
@@ -1486,11 +1486,12 @@ module.exports = {
    * The styles are documented at
    * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#style-values
    */
-  convertParamsWithStyle: function(param, paramValue, parameterSource, components, schemaCache) {
+  convertParamsWithStyle: function(param, paramValue, parameterSource, components, schemaCache, options) {
     var paramName = _.get(param, 'name'),
       pmParams = [],
       serialisedValue = '',
-      description = this.getParameterDescription(param);
+      description = this.getParameterDescription(param),
+      disabled = false;
 
     // for invalid param object return null
     if (!_.isObject(param)) {
@@ -1500,6 +1501,10 @@ module.exports = {
     let { style, explode, startValue, propSeparator, keyValueSeparator, isExplodable } =
       this.getParamSerialisationInfo(param, parameterSource, components, schemaCache);
 
+    if (options && options.disableOptionalParameters) {
+      disabled = !param.required;
+    }
+
     // decide explodable params, starting value and separators between key-value and properties for serialisation
     switch (style) {
       case 'form':
@@ -1508,7 +1513,8 @@ module.exports = {
             pmParams.push({
               key: _.isArray(paramValue) ? paramName : key,
               value: (value === undefined ? '' : value),
-              description
+              description,
+              disabled
             });
           });
           return pmParams;
@@ -1525,7 +1531,8 @@ module.exports = {
             pmParams.push({
               key: param.name + '[' + key + ']',
               value: (value === undefined ? '' : value),
-              description
+              description,
+              disabled
             });
           });
         }
@@ -1555,7 +1562,8 @@ module.exports = {
     pmParams.push({
       key: paramName,
       value: serialisedValue,
-      description
+      description,
+      disabled
     });
 
     return pmParams;
@@ -1597,7 +1605,7 @@ module.exports = {
     }
 
     convertedHeader = _.get(this.convertParamsWithStyle(header, fakeData, parameterSource,
-      components, schemaCache), '[0]');
+      components, schemaCache, options), '[0]');
 
     reqHeader = new sdk.Header(convertedHeader);
     reqHeader.description = this.getParameterDescription(header);
@@ -1671,7 +1679,7 @@ module.exports = {
           };
           encoding[key].description = description;
           params = this.convertParamsWithStyle(encoding[key], value, PARAMETER_SOURCE.REQUEST, components,
-            schemaCache);
+            schemaCache, options);
           // TODO: Show warning for incorrect schema if !params
           params && params.forEach((element) => {
             // Collection v2.1 schema allows urlencoded param value to be only string
@@ -2118,7 +2126,7 @@ module.exports = {
               PARAMETER_SOURCE.REQUEST, components, SCHEMA_FORMATS.DEFAULT, options.indentCharacter, schemaCache,
               options.stackLimit) : '',
           convertedPathVar = _.get(this.convertParamsWithStyle(element, fakedData, PARAMETER_SOURCE.REQUEST,
-            components, schemaCache), '[0]', {});
+            components, schemaCache, options), '[0]', {});
 
         variableStore[element.name] = _.assign(convertedPathVar, { id: element.name, type: 'collection' });
       }

test/system/structure.test.js

@@ -19,7 +19,8 @@ const optionIds = [
     'validateMetadata',
     'ignoreUnresolvedVariables',
     'optimizeConversion',
-    'strictRequestMatching'
+    'strictRequestMatching',
+    'disableOptionalParameters'
   ],
   expectedOptions = {
     collapseFolders: {

test/unit/base.test.js

@@ -726,7 +726,8 @@ describe('CONVERT FUNCTION TESTS ', function() {
             {
               key: 'access_token',
               value: 'X-access-token',
-              description: 'Access token'
+              description: 'Access token',
+              disabled: false
             }
           ]);
         });
@@ -907,6 +908,26 @@ describe('CONVERT FUNCTION TESTS ', function() {
       });
     });
 
+    it('[Github #31] - should set optional params as disabled', function(done) {
+      let options = { schemaFaker: true, disableOptionalParameters: true };
+      Converter.convert({ type: 'file', data: requiredInParams }, options, (err, conversionResult) => {
+        expect(err).to.be.null;
+        let requests = conversionResult.output[0].data.item[0].item,
+          request;
+
+        // GET /pets
+        // query1 required, query2 optional
+        // header1 required, header2 optional
+        request = requests[0].request;
+        expect(request.url.query[0].disabled).to.be.false;
+        expect(request.url.query[1].disabled).to.be.true;
+        expect(request.header[0].disabled).to.be.false;
+        expect(request.header[1].disabled).to.be.true;
+
+        done();
+      });
+    });
+
     it('Should prefer and use example from parameter object over schema example while faking schema', function(done) {
       Converter.convert({ type: 'file', data: parameterExamples },
         { schemaFaker: true, requestParametersResolution: 'example' },