Merge pull request #867 from postmanlabs/feature/2-way-sync-schema-changes

barshan23 · web-flow · commit 16a214736c02 · 2025-09-19T16:10:31.000+05:30
[AB-1450] schema changes for 2-way-sync
diff --git a/libV2/schemaUtils.js b/libV2/schemaUtils.js
@@ -792,6 +792,8 @@ let QUERYPARAM = 'query',
 
     if (resolvedSchema.type === 'object' && resolvedSchema.properties) {
       const schemaDetails = {
+          description: resolvedSchema.description,
+          title: resolvedSchema.title,
           type: resolvedSchema.type,
           properties: {},
           required: []
@@ -1176,16 +1178,24 @@ let QUERYPARAM = 'query',
    * Gets the description of the parameter.
    * If the parameter is required, it prepends a `(Requried)` before the parameter description
    * If the parameter type is enum, it appends the possible enum values
+   * @param {object} context - Global context object controlling behavior
    * @param {object} parameter - input param for which description needs to be returned
    * @returns {string} description of the parameters
    */
-  getParameterDescription = (parameter) => {
+  getParameterDescription = (context, parameter) => {
     if (!_.isObject(parameter)) {
       return '';
     }
 
-    return (parameter.required ? '(Required) ' : '') + (parameter.description || '') +
-      (parameter.enum ? ' (This can only be one of ' + parameter.enum + ')' : '');
+    const requiredPrefix = (context && !context.enableTypeFetching && parameter.required ? '(Required) ' : ''),
+      desc = parameter.description || '';
+
+    let enumDescription = '';
+    if (parameter && parameter.schema && parameter.schema.enum && !(context && context.enableTypeFetching)) {
+      enumDescription = ' (This can only be one of ' + parameter.schema.enum + ')';
+    }
+
+    return requiredPrefix + desc + enumDescription;
   },
 
   /**
@@ -1204,7 +1214,7 @@ let QUERYPARAM = 'query',
       { enableOptionalParameters } = context.computedOptions;
 
     let serialisedValue = '',
-      description = getParameterDescription(param),
+      description = getParameterDescription(context, param),
       paramName = _.get(param, 'name'),
       disabled = !enableOptionalParameters && _.get(param, 'required') !== true,
       pmParams = [],
@@ -1844,7 +1854,7 @@ let QUERYPARAM = 'query',
       paramSchema.required = _.has(paramSchema, 'required') ?
         paramSchema.required :
         _.indexOf(requestBodySchema.required, key) !== -1;
-      description = getParameterDescription(paramSchema);
+      description = getParameterDescription(context, paramSchema);
 
       if (typeof _.get(encoding, `[${key}].contentType`) === 'string') {
         contentType = encoding[key].contentType;
@@ -2099,8 +2109,8 @@ let QUERYPARAM = 'query',
       type: schema.type,
       format: schema.format,
       default: schema.default,
-      required: param.required || false,
-      deprecated: param.deprecated || false,
+      required: param.required,
+      deprecated: param.deprecated,
       enum: schema.enum || undefined,
       minLength: schema.minLength,
       maxLength: schema.maxLength,
@@ -2442,8 +2452,8 @@ let QUERYPARAM = 'query',
           type: schema.type,
           format: schema.format,
           default: schema.default,
-          required: schema.required || false,
-          deprecated: schema.deprecated || false,
+          required: schema.required,
+          deprecated: schema.deprecated,
           enum: schema.enum || undefined,
           minLength: schema.minLength,
           maxLength: schema.maxLength,
diff --git a/test/data/valid_openapi/test1.json b/test/data/valid_openapi/test1.json
@@ -281,8 +281,10 @@
 				"in": "query",
 				"description": "component level query param",
 				"required": false,
+				"deprecated": false,
 				"schema": {
-					"type": "string"
+          			"type": "string",
+					"enum": ["medium"]
 				}
 			}
         },
diff --git a/test/unit/convertV2.test.js b/test/unit/convertV2.test.js
@@ -279,12 +279,17 @@ describe('The convert v2 Function', function() {
   it('Should generate collection conforming to schema for and fail if not valid ' +
   testSpec1, function(done) {
     Converter.convertV2({ type: 'file', data: testSpec1 }, { requestNameSource: 'url' }, (err, conversionResult) => {
+      const firstFolder = conversionResult.output[0].data.item[0];
+      const listAllPets = firstFolder.item[0];
+      const queryParams = listAllPets.request.url.query;
+      const limitDescription = queryParams[0].description.content;
       expect(err).to.be.null;
       expect(conversionResult.result).to.equal(true);
       expect(conversionResult.output.length).to.equal(1);
       expect(conversionResult.output[0].type).to.equal('collection');
       expect(conversionResult.output[0].data).to.have.property('info');
       expect(conversionResult.output[0].data).to.have.property('item');
+      expect(limitDescription).to.equal('component level query param (This can only be one of medium)');
 
       done();
     });
diff --git a/test/unit/convertV2WithTypes.test.js b/test/unit/convertV2WithTypes.test.js
@@ -29,7 +29,7 @@ const expect = require('chai').expect,
         (acc, [key, value]) => {
           acc[key] = {
             type: value.type,
-            deprecated: value.deprecated || false,
+            deprecated: value.deprecated,
             enum: value.enum !== null ? value.enum : undefined,
             minLength: value.minLength !== null ? value.minLength : undefined,
             maxLength: value.maxLength !== null ? value.maxLength : undefined,
@@ -75,22 +75,28 @@ describe('convertV2WithTypes should generate collection conforming to collection
       expect(conversionResult.output).to.be.an('array').that.is.not.empty;
 
       const firstFolder = conversionResult.output[0].data.item[0];
+      const secondFolder = conversionResult.output[0].data.item[1];
       expect(firstFolder).to.have.property('name', 'pets');
 
       const listAllPets = firstFolder.item[0];
       expect(listAllPets).to.have.property('name', 'List all pets');
       expect(listAllPets.request.method).to.equal('GET');
 
       const createPet = firstFolder.item[1];
+      const getPetById = secondFolder.item[0];
+      const idDescription = getPetById.item[0].request.url.variable[0].description.content;
       expect(createPet).to.have.property('name', '/pets');
       expect(createPet.request.method).to.equal('POST');
+      expect(idDescription).to.equal('The id of the pet to retrieve');
       expect(createPet.request.body.mode).to.equal('raw');
       expect(createPet.request.body.raw).to.include('request body comes here');
 
       const queryParams = listAllPets.request.url.query;
       expect(queryParams).to.be.an('array').that.has.length(3);
       expect(queryParams[0]).to.have.property('key', 'limit');
-      expect(queryParams[0]).to.have.property('value', '<string>');
+      expect(queryParams[0]).to.have.property('value', 'medium');
+      const limitDescription = queryParams[0].description.content;
+      expect(limitDescription).to.equal('component level query param');
 
       const headers = listAllPets.request.header;
       expect(headers).to.be.an('array').that.is.not.empty;
@@ -207,14 +213,14 @@ describe('convertV2WithTypes', function() {
     const expectedExtractedTypes = {
         'get/pets': {
           'request': {
-            'headers': '[\n  {\n    "keyName": "variable",\n    "properties": {\n      "type": "array",\n      "required": false,\n      "deprecated": false\n    }\n  }\n]',
+            'headers': '[\n  {\n    "keyName": "variable",\n    "properties": {\n      "type": "array"\n    }\n  }\n]',
             'pathParam': '[]',
-            'queryParam': '[\n  {\n    "keyName": "limit",\n    "properties": {\n      "type": "string",\n      "default": "<string>",\n      "required": false,\n      "deprecated": false\n    }\n  },\n  {\n    "keyName": "variable2",\n    "properties": {\n      "type": "array",\n      "required": false,\n      "deprecated": false\n    }\n  },\n  {\n    "keyName": "variable3",\n    "properties": {\n      "type": "array",\n      "required": false,\n      "deprecated": false\n    }\n  }\n]'
+            'queryParam': '[\n  {\n    "keyName": "limit",\n    "properties": {\n      "type": "string",\n      "required": false,\n      "deprecated": false,\n      "enum": [\n        "medium"\n      ]\n    }\n  },\n  {\n    "keyName": "variable2",\n    "properties": {\n      "type": "array"\n    }\n  },\n  {\n    "keyName": "variable3",\n    "properties": {\n      "type": "array"\n    }\n  }\n]'
           },
           'response': {
             '200': {
               'body': '{\n  "type": "array",\n  "items": {\n    "type": "object",\n    "properties": {\n      "id": {\n        "type": "integer",\n        "format": "int64"\n      },\n      "name": {\n        "type": "string"\n      },\n      "tag": {\n        "type": "string"\n      }\n    },\n    "required": [\n      "id",\n      "name"\n    ]\n  }\n}',
-              'headers': '[\n  {\n    "keyName": "x-next",\n    "properties": {\n      "type": "string",\n      "default": "<string>",\n      "required": false,\n      "deprecated": false\n    }\n  }\n]'
+              'headers': '[\n  {\n    "keyName": "x-next",\n    "properties": {\n      "type": "string",\n      "default": "<string>"\n    }\n  }\n]'
             },
             '500': {
               'body': '{\n  "type": "object",\n  "properties": {\n    "code": {\n      "type": "integer"\n    },\n    "message": {\n      "type": "string"\n    }\n  },\n  "required": [\n    "code",\n    "message"\n  ]\n}',
@@ -226,7 +232,7 @@ describe('convertV2WithTypes', function() {
           'request': {
             'headers': '[]',
             'pathParam': '[]',
-            'queryParam': '[\n  {\n    "keyName": "limit",\n    "properties": {\n      "type": "string",\n      "default": "<string>",\n      "required": false,\n      "deprecated": false\n    }\n  },\n  {\n    "keyName": "variable3",\n    "properties": {\n      "type": "array",\n      "required": false,\n      "deprecated": false\n    }\n  }\n]'
+            'queryParam': '[\n  {\n    "keyName": "limit",\n    "properties": {\n      "type": "string",\n      "required": false,\n      "deprecated": false,\n      "enum": [\n        "medium"\n      ]\n    }\n  },\n  {\n    "keyName": "variable3",\n    "properties": {\n      "type": "array"\n    }\n  }\n]'
           },
           'response': {
             '201': {
@@ -241,7 +247,7 @@ describe('convertV2WithTypes', function() {
         'get/pet/{petId}': {
           'request': {
             'headers': '[]',
-            'pathParam': '[\n  {\n    "keyName": "petId",\n    "properties": {\n      "type": "string",\n      "default": "<string>",\n      "required": true,\n      "deprecated": false\n    }\n  }\n]',
+            'pathParam': '[\n  {\n    "keyName": "petId",\n    "properties": {\n      "type": "string",\n      "default": "<string>",\n      "required": true\n    }\n  }\n]',
             'queryParam': '[]'
           },
           'response': {
@@ -258,7 +264,7 @@ describe('convertV2WithTypes', function() {
         'post/pet/{petId}': {
           'request': {
             'headers': '[]',
-            'pathParam': '[\n  {\n    "keyName": "petId",\n    "properties": {\n      "type": "string",\n      "default": "<string>",\n      "required": true,\n      "deprecated": false\n    }\n  }\n]',
+            'pathParam': '[\n  {\n    "keyName": "petId",\n    "properties": {\n      "type": "string",\n      "default": "<string>",\n      "required": true\n    }\n  }\n]',
             'queryParam': '[]'
           },
           'response': {

Original file line number	Diff line number	Diff line change
`@@ -281,8 +281,10 @@`
`281`	`281`	`"in": "query",`
`282`	`282`	`"description": "component level query param",`
`283`	`283`	`"required": false,`
	`284`	`+ "deprecated": false,`
`284`	`285`	`"schema": {`
`285`		`- "type": "string"`
	`286`	`+ "type": "string",`
	`287`	`+ "enum": ["medium"]`
`286`	`288`	`}`
`287`	`289`	`}`
`288`	`290`	`},`