Merge pull request #698 from postmanlabs/feature/formdata-content-type

Add support for contentType field for Formdata request bodies

Author: VShingala

lib/schemaUtils.js

@@ -1896,6 +1896,7 @@ module.exports = {
       updateOptions = {},
       reqBody = new sdk.RequestBody(),
       contentHeader,
+      contentTypes = {},
       rDataMode,
       params,
       encoding,
@@ -2018,6 +2019,10 @@ module.exports = {
                 REQUEST_TYPE.ROOT, PARAMETER_SOURCE.REQUEST, components, options, schemaCache));
             }
           });
+
+          if (typeof _.get(encoding, `[${key}].contentType`) === 'string') {
+            contentTypes[key] = encoding[key].contentType;
+          }
         }
         // Collection v2.1 schema allows form param value to be only string
         if (typeof value !== 'string') {
@@ -2055,6 +2060,9 @@ module.exports = {
           });
         }
         param.description = description;
+        if (contentTypes[key]) {
+          param.contentType = contentTypes[key];
+        }
         paramArray.push(param);
       });
       updateOptions = {

libV2/schemaUtils.js

@@ -1234,6 +1234,7 @@ let QUERYPARAM = 'query',
   resolveFormDataRequestBodyForPostmanRequest = (context, requestBodyContent) => {
     let bodyData = '',
       formDataParams = [],
+      encoding = {},
       requestBodyData = {
         mode: 'formdata',
         formdata: formDataParams
@@ -1244,9 +1245,11 @@ let QUERYPARAM = 'query',
     }
 
     bodyData = resolveRequestBodyData(context, requestBodyContent.schema);
+    encoding = _.get(requestBodyContent, 'encoding', {});
 
     _.forOwn(bodyData, (value, key) => {
       let requestBodySchema,
+        contentType = null,
         paramSchema,
         description,
         param;
@@ -1263,6 +1266,10 @@ let QUERYPARAM = 'query',
         _.indexOf(requestBodySchema.required, key) !== -1;
       description = getParameterDescription(paramSchema);
 
+      if (typeof _.get(encoding, `[${key}].contentType`) === 'string') {
+        contentType = encoding[key].contentType;
+      }
+
       // TODO: Add handling for headers from encoding
 
       if (paramSchema && paramSchema.type === 'binary') {
@@ -1281,6 +1288,9 @@ let QUERYPARAM = 'query',
       }
 
       param.description = description;
+      if (contentType) {
+        param.contentType = contentType;
+      }
 
       formDataParams.push(param);
     });

test/data/valid_openapi/required_in_parameters.json

@@ -98,6 +98,14 @@
                     "type": "string"
                   }
                 }
+              },
+              "encoding": {
+                "formParam1": {
+                  "contentType": "application/xml"
+                },
+                "formParam2": {
+                  "contentType": "application/js"
+                }
               }
             }
           }

test/unit/convertV2.test.js

@@ -760,6 +760,8 @@ describe('The convert v2 Function', function() {
       request = requests[2].request;
       expect(request.body.formdata[0].description.content).to.equal('(Required) Description of formParam1');
       expect(request.body.formdata[1].description.content).to.equal('Description of formParam2');
+      expect(request.body.formdata[0].contentType).to.equal('application/xml');
+      expect(request.body.formdata[1].contentType).to.equal('application/js');
 
       // POST /pets
       // RequestBody: application/x-www-form-urlencoded

test/unit/util.test.js

@@ -1899,6 +1899,11 @@ describe('SCHEMA UTILITY FUNCTION TESTS ', function () {
                     }
                   },
                   required: ['array']
+                },
+                encoding: {
+                  file: {
+                    contentType: 'application/binary'
+                  }
                 }
               }
             }
@@ -1909,6 +1914,7 @@ describe('SCHEMA UTILITY FUNCTION TESTS ', function () {
         expect(resultBody[0].key).to.equal('array');
         expect(resultBody[1].key).to.equal('file');
         expect(resultBody[1].type).to.equal('file');
+        expect(resultBody[1].contentType).to.equal('application/binary');
         expect(result.contentHeader).to.deep.include(
           { key: 'Content-Type', value: 'multipart/form-data' });
         done();