Merge pull request #760 from postmanlabs/feature/add-description

Add description for path variables to the request if present in OpenAPI schema

Author: VShingala

libV2/utils.js

@@ -66,6 +66,15 @@ const sdk = require('postman-collection'),
     });
 
     requestItem.request.url.variables.assimilate(pathParams);
+    _.forEach(pathParams, (param) => {
+      if (param.description) {
+        const item = requestItem.request.url.variables.one(param.key);
+        if (!_.isEmpty(item)) {
+          item.description = param.description;
+        }
+      }
+    });
+
     requestItem.request.auth = auth;
 
     _.forEach(responses, (response) => {

test/data/valid_openapi/path_params_with_description.json

@@ -0,0 +1,55 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+		"version": "1.0.0",
+		"title": "Swagger Petstore",
+		"license": {
+			"name": "MIT"
+		}
+	},
+	"servers": [
+		{
+			"url": "http://petstore.swagger.io/v1"
+    }
+  ],
+  "paths": {
+    "/pets/{petId}": {
+      "get": {
+				"summary": "List all pets",
+				"operationId": "listPets",
+				"parameters": [
+					{
+						"name": "petId",
+            "in": "path",
+            "description": "Id of pet",
+						"required": true,
+						"schema": {
+							"type": "integer",
+							"format": "int32"
+						}
+					}
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful response",
+            "headers": {
+              "responseHeader1": {
+                "description":"Description of responseHeader1",
+                "required": true,
+                "schema": {
+                  "type": "integer"
+                }
+              },
+              "responseHeader2": {
+                "description":"Description of responseHeader2",
+                "schema": {
+                  "type": "integer"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

test/unit/convertV2.test.js

@@ -30,6 +30,7 @@ const expect = require('chai').expect,
   examplesOutsideSchema = path.join(__dirname, VALID_OPENAPI_PATH + '/examples_outside_schema.json'),
   exampleOutsideSchema = path.join(__dirname, VALID_OPENAPI_PATH + '/example_outside_schema.json'),
   descriptionInBodyParams = path.join(__dirname, VALID_OPENAPI_PATH + '/description_in_body_params.json'),
+  descriptionInPathParams = path.join(__dirname, VALID_OPENAPI_PATH + '/path_params_with_description.json'),
   zeroDefaultValueSpec = path.join(__dirname, VALID_OPENAPI_PATH + '/zero_in_default_value.json'),
   requiredInParams = path.join(__dirname, VALID_OPENAPI_PATH, '/required_in_parameters.json'),
   multipleRefs = path.join(__dirname, VALID_OPENAPI_PATH, '/multiple_refs.json'),
@@ -552,6 +553,16 @@ describe('The convert v2 Function', function() {
     });
   });
 
+  it('should add description in path params', function (done) {
+    var openapi = fs.readFileSync(descriptionInPathParams, 'utf-8');
+    Converter.convertV2({ type: 'string', data: openapi }, { schemaFaker: true }, (err, conversionResult) => {
+      let description = conversionResult.output[0].data.item[0].item[0].item[0].request.url.variable[0].description;
+      expect(err).to.be.null;
+      expect(description).to.equal('(Required) Id of pet');
+      done();
+    });
+  });
+
   it('Should create collection from folder having one root file for browser', function(done) {
     let folderPath = path.join(__dirname, '../data/petstore separate yaml'),
       files = [],