Merge pull request #571 from postmanlabs/fix/559-parameterDescriptionFormData

Deref object in form data params

Author: VShingala

lib/schemaUtils.js

@@ -1827,6 +1827,10 @@ module.exports = {
       bodyData = this.convertToPmBodyData(contentObj[FORM_DATA], requestType, FORM_DATA,
         PARAMETER_SOURCE.REQUEST, options.indentCharacter, components, options, schemaCache);
       encoding = contentObj[FORM_DATA].encoding ? contentObj[FORM_DATA].encoding : {};
+
+      if (contentObj[FORM_DATA].hasOwnProperty('schema') && contentObj[FORM_DATA].schema.hasOwnProperty('$ref')) {
+        contentObj[FORM_DATA].schema = this.getRefObject(contentObj[FORM_DATA].schema.$ref, components, options);
+      }
       // create the form parameters and add it to the request body object
       _.forOwn(bodyData, (value, key) => {
 

test/data/valid_openapi/form_data_param_description.yaml

@@ -0,0 +1,33 @@
+openapi: 3.0.1
+info:
+  title: My REST API
+  version: 1.0.0
+paths:
+  /description-test:
+    post:
+      description: Endpoint description
+      operationId: description-test
+      requestBody:
+        content:
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/RequestSchema'
+      responses:
+        "201":
+          description: Response description
+          content:
+            application/json;charset=UTF-8:
+              schema:
+                type: object
+                properties:
+                  responseParam:
+                    type: string
+                    description: Response param description
+components:
+  schemas:
+    RequestSchema:
+      type: object
+      properties:
+        requestParam:
+          type: string
+          description: Request param description

test/unit/base.test.js

@@ -51,6 +51,7 @@ describe('CONVERT FUNCTION TESTS ', function() {
       deepObjectLengthProperty = path.join(__dirname, VALID_OPENAPI_PATH, '/deepObjectLengthProperty.yaml'),
       valuePropInExample = path.join(__dirname, VALID_OPENAPI_PATH, '/valuePropInExample.yaml'),
       petstoreParamExample = path.join(__dirname, VALID_OPENAPI_PATH, '/petstoreParamExample.yaml'),
+      formDataParamDescription = path.join(__dirname, VALID_OPENAPI_PATH, '/form_data_param_description.yaml'),
       allHTTPMethodsSpec = path.join(__dirname, VALID_OPENAPI_PATH, '/all-http-methods.yaml');
 
 
@@ -1143,6 +1144,21 @@ describe('CONVERT FUNCTION TESTS ', function() {
         });
     });
 
+    it('[Github #559]Should convert description in form data parameters' +
+    petstoreParamExample, function(done) {
+      var openapi = fs.readFileSync(formDataParamDescription, 'utf8');
+      Converter.convert({ type: 'string', data: openapi },
+        { }, (err, conversionResult) => {
+          expect(err).to.be.null;
+          expect(conversionResult.result).to.equal(true);
+          expect(conversionResult.output[0].data.item[0].request.body.formdata[0].description)
+            .to.equal('Request param description');
+          expect(conversionResult.output[0].data.item[0].request.body.formdata[0].key).to.equal('requestParam');
+          expect(conversionResult.output[0].data.item[0].request.body.formdata[0].value).to.equal('<string>');
+          done();
+        });
+    });
+
     it('Should have disableBodyPruning option for protocolProfileBehavior set to true for all types of request' +
       allHTTPMethodsSpec, function (done) {
       var openapi = fs.readFileSync(allHTTPMethodsSpec, 'utf8');
@@ -1155,11 +1171,11 @@ describe('CONVERT FUNCTION TESTS ', function() {
           _.forEach(conversionResult.output[0].data.item[0].item, (request) => {
             expect(request.protocolProfileBehavior.disableBodyPruning).to.eql(true);
           });
-
           done();
         });
     });
   });
+
   describe('Converting swagger 2.0 files', function() {
     it('should convert path paramters to postman-compatible paramters', function (done) {
       const fileData = path.join(__dirname, SWAGGER_20_FOLDER_JSON, 'swagger2-with-params.json'),