Merge pull request #901 from postmanlabs/release/v5.4.0

Release version v5.4.0

Author: barshan23

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## [Unreleased]
 
+## [v5.4.0] - 2025-11-13
+
 ## [v5.3.5] - 2025-11-10
 
 ## [v5.3.4] - 2025-11-06
@@ -675,7 +677,9 @@ Newer releases follow the [Keep a Changelog](https://keepachangelog.com/en/1.0.0
 
 -   Base release
 
-[Unreleased]: https://github.com/postmanlabs/openapi-to-postman/compare/v5.3.5...HEAD
+[Unreleased]: https://github.com/postmanlabs/openapi-to-postman/compare/v5.4.0...HEAD
+
+[v5.4.0]: https://github.com/postmanlabs/openapi-to-postman/compare/v5.3.5...v5.4.0
 
 [v5.3.5]: https://github.com/postmanlabs/openapi-to-postman/compare/v5.3.4...v5.3.5
 

assets/validationRequestListSchema.json

@@ -267,7 +267,7 @@
 							"type": "integer"
 						}
 					},
-					"required": ["id", "code"]
+					"required": ["id"]
 				}
 			}
 		},

lib/common/schemaUtilsCommon.js

@@ -4,6 +4,7 @@
 
 const parse = require('../parse.js'),
   _ = require('lodash'),
+  DEFAULT_RESPONSE_CODE_IN_OAS = 'default',
   typesMap = {
     integer: {
       int32: '<integer>',
@@ -208,6 +209,7 @@ function checkIsCorrectType(value, schema) {
 }
 
 module.exports = {
+  DEFAULT_RESPONSE_CODE_IN_OAS,
 
   /**
    * Parses an OAS string/object as a YAML or JSON

libV2/schemaUtils.js

@@ -6,6 +6,7 @@ const schemaFaker = require('../assets/json-schema-faker'),
   mergeAllOf = require('json-schema-merge-allof'),
   xmlFaker = require('./xmlSchemaFaker.js'),
   URLENCODED = 'application/x-www-form-urlencoded',
+  { DEFAULT_RESPONSE_CODE_IN_OAS } = require('../lib/common/schemaUtilsCommon.js'),
   APP_JSON = 'application/json',
   APP_JS = 'application/javascript',
   TEXT_XML = 'text/xml',
@@ -2693,9 +2694,9 @@ let QUERYPARAM = 'query',
 
       // replace 'X' char in code with '0' | E.g. 5xx -> 500
       code = code.replace(/X|x/g, '0');
-      code = code === 'default' ? 500 : _.toSafeInteger(code);
+      code = code === DEFAULT_RESPONSE_CODE_IN_OAS ? undefined : _.toSafeInteger(code);
 
-      Object.assign(responseTypes, { [code]: responseBodyHeaderObj });
+      Object.assign(responseTypes, { [code || DEFAULT_RESPONSE_CODE_IN_OAS]: responseBodyHeaderObj });
 
       _.forOwn(resolvedExamples, (resolvedExample = {}) => {
         let { body, contentHeader = [], bodyType, acceptHeader, name } = resolvedExample,

libV2/validationUtils.js

@@ -22,7 +22,7 @@ const _ = require('lodash'),
   ajvValidationError = require('../lib/ajValidation/ajvValidationError'),
   { validateSchema } = require('../lib/ajValidation/ajvValidation'),
   { formatDataPath, checkIsCorrectType, isKnownType,
-    getServersPathVars } = require('../lib/common/schemaUtilsCommon.js'),
+    getServersPathVars, DEFAULT_RESPONSE_CODE_IN_OAS } = require('../lib/common/schemaUtilsCommon.js'),
 
   { findMatchingRequestFromSchema, isPmVariable } = require('./requestMatchingUtils'),
 
@@ -2424,7 +2424,7 @@ function checkResponses (context, transaction, transactionPathPrefix, schemaPath
   // loop through all responses
   // for each response, find the appropriate response from schemaPath, and then validate response body and headers
   async.map(responses, (response, responseCallback) => {
-    let thisResponseCode = _.toString(response.code),
+    let thisResponseCode = _.toString(response.code) || DEFAULT_RESPONSE_CODE_IN_OAS,
       thisSchemaResponse = _.get(schemaPath, ['responses', thisResponseCode], _.get(schemaPath, 'responses.default')),
       responsePathPrefix = thisResponseCode;
 
@@ -2503,8 +2503,6 @@ function checkResponses (context, transaction, transactionPathPrefix, schemaPath
       missingResponses = [];
 
     _.each(_.get(schemaPath, 'responses'), (responseObj, responseCode) => {
-      responseCode = responseCode === 'default' ? '500' : responseCode;
-
       if (!_.includes(matchedResponses, responseCode)) {
         let mismatchObj = {
           property: 'RESPONSE',

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-to-postmanv2",
-  "version": "5.3.5",
+  "version": "5.4.0",
   "description": "Convert a given OpenAPI specification to Postman Collection v2.0",
   "homepage": "https://github.com/postmanlabs/openapi-to-postman",
   "bugs": "https://github.com/postmanlabs/openapi-to-postman/issues",

package.json

@@ -96,7 +96,6 @@
                 }
               },
               "status": "Internal Server Error",
-              "code": 500,
               "header": [
                 {
                   "key": "Content-Type",

test/data/validationData/ignoreUnresolvedVariablesCollection.json

@@ -103,7 +103,7 @@ function getFoldersByVersion(folder30Path, folder31Path) {
 
 describe('Validate with servers', function () {
 
-  it('Fix for GITHUB#496: Should identify url with fragment', function () {
+  it('Fix for GITHUB#496: Should identify url with fragment', function (done) {
     const openAPI = path.join(__dirname, VALID_OPENAPI_FOLDER_PATH + '/explicit_server_in_path.json'),
       openAPIData = fs.readFileSync(openAPI, 'utf8'),
       options = {
@@ -136,6 +136,8 @@ describe('Validate with servers', function () {
           expect(result.requests[requestId].endpoints[0]).to.not.be.undefined;
           expect(result.requests[requestId].endpoints[0].matched).to.be.true;
         });
+
+        done();
       });
     });
   });

test/unit/ValidateV2.test.js

@@ -2723,13 +2723,13 @@ describe('The convert v2 Function', function() {
           expect(JSON.parse(item.response[1].body)).to.eql(okResExample);
 
           expect(item.response[2].name).to.eql('ok_example');
-          expect(item.response[2].code).to.eql(500);
+          expect(item.response[2].code).to.eql(undefined);
           expect(item.response[2]._postman_previewlanguage).to.eql('json');
           expect(JSON.parse(item.response[2].originalRequest.body.raw)).to.eql(okReqExample);
           expect(JSON.parse(item.response[2].body)).to.eql(failResExample);
 
           expect(item.response[3].name).to.eql('not_ok_example');
-          expect(item.response[3].code).to.eql(500);
+          expect(item.response[3].code).to.eql(undefined);
           expect(item.response[3]._postman_previewlanguage).to.eql('json');
           expect(JSON.parse(item.response[3].originalRequest.body.raw)).to.eql(failReqExample);
           expect(JSON.parse(item.response[3].body)).to.eql(failResExample);