Merge pull request #696 from postmanlabs/feature/accept-header

Fixed issue where Accept header was not generated in convertV2().

Author: barshan23

libV2/schemaUtils.js

@@ -1555,7 +1555,7 @@ let QUERYPARAM = 'query',
   },
 
   resolveResponseBody = (context, responseBody = {}) => {
-    let responseContent, bodyType, bodyData, headerFamily;
+    let responseContent, bodyType, bodyData, headerFamily, acceptHeader;
 
     if (_.isEmpty(responseBody)) {
       return responseBody;
@@ -1583,16 +1583,24 @@ let QUERYPARAM = 'query',
     const { indentCharacter } = context.computedOptions,
       rawModeData = !_.isObject(bodyData) && _.isFunction(_.get(bodyData, 'toString')) ?
         bodyData.toString() :
-        JSON.stringify(bodyData, null, indentCharacter);
+        JSON.stringify(bodyData, null, indentCharacter),
+      responseMediaTypes = _.keys(responseContent);
 
+    if (responseMediaTypes.length > 0) {
+      acceptHeader = [{
+        key: 'Accept',
+        value: responseMediaTypes[0]
+      }];
+    }
 
     return {
       body: rawModeData,
       contentHeader: [{
         key: 'Content-Type',
         value: bodyType
       }],
-      bodyType
+      bodyType,
+      acceptHeader
     };
   },
 
@@ -1709,14 +1717,15 @@ let QUERYPARAM = 'query',
   },
 
   resolveResponseForPostmanRequest = (context, operationItem, request) => {
-    let responses = [];
+    let responses = [],
+      requestAcceptHeader;
 
     _.forOwn(operationItem.responses, (responseSchema, code) => {
       let response,
         { includeAuthInfoInExample } = context.computedOptions,
         responseAuthHelper,
         auth = request.auth,
-        { body, contentHeader = [], bodyType } = resolveResponseBody(context, responseSchema) || {},
+        { body, contentHeader = [], bodyType, acceptHeader } = resolveResponseBody(context, responseSchema) || {},
         headers = resolveResponseHeaders(context, responseSchema.headers),
         originalRequest = request,
         reqHeaders = _.clone(request.headers) || [],
@@ -1738,6 +1747,11 @@ let QUERYPARAM = 'query',
         });
       }
 
+      // set accept header value as first found response content's media type
+      if (_.isEmpty(requestAcceptHeader)) {
+        requestAcceptHeader = acceptHeader;
+      }
+
       response = {
         name: _.get(responseSchema, 'description'),
         body,
@@ -1750,7 +1764,7 @@ let QUERYPARAM = 'query',
       responses.push(response);
     });
 
-    return responses;
+    return { responses, acceptHeader: requestAcceptHeader };
   };
 
 module.exports = {
@@ -1771,7 +1785,6 @@ module.exports = {
       { pathVariables, collectionVariables } = filterCollectionAndPathVariables(url, pathParams),
       requestBody = resolveRequestBodyForPostmanRequest(context, operationItem[method]),
       request,
-      responses,
       securitySchema = _.get(operationItem, [method, 'security']),
       authHelper = generateAuthForCollectionFromOpenAPI(context.openapi, securitySchema);
 
@@ -1795,7 +1808,12 @@ module.exports = {
       auth: authHelper
     };
 
-    responses = resolveResponseForPostmanRequest(context, operationItem[method], request);
+    const { responses, acceptHeader } = resolveResponseForPostmanRequest(context, operationItem[method], request);
+
+    // add accept header if found and not present already
+    if (!_.isEmpty(acceptHeader)) {
+      request.headers = _.concat(request.headers, acceptHeader);
+    }
 
     return {
       request: {

libV2/validationUtils.js

@@ -2461,10 +2461,11 @@ function checkResponses (context, transaction, transactionPathPrefix, schemaPath
         if (options.suggestAvailableFixes) {
           let generatedResponse,
             resolvedResponse,
-            originalRequest = _.omit(_.get(transaction, 'request', {}), 'response');
+            originalRequest = _.omit(_.get(transaction, 'request', {}), 'response'),
+            resolvedResponses = resolveResponseForPostmanRequest(context,
+              { responses: { [responseCode]: responseObj } }, originalRequest);
 
-          resolvedResponse = _.head(resolveResponseForPostmanRequest(context,
-            { responses: { [responseCode]: responseObj } }, originalRequest));
+          resolvedResponse = _.head(resolvedResponses.responses);
           generatedResponse = utils.generatePmResponseObject(resolvedResponse);
 
           if (_.isFunction(generatedResponse.toJSON)) {

test/unit/convertV2.test.js

@@ -380,7 +380,9 @@ describe('The convert v2 Function', function() {
       keepImplicitHeaders: false
     }, (err, conversionResult) => {
       expect(err).to.be.null;
-      expect(conversionResult.output[0].data.item[0].item[0].request.header).to.not.ok;
+      expect(conversionResult.output[0].data.item[0].item[0].request.header.length).to.eql(1);
+      expect(conversionResult.output[0].data.item[0].item[0].request.header[0].key).to.eql('Accept');
+      expect(conversionResult.output[0].data.item[0].item[0].request.header[0].value).to.eql('application/json');
       done();
     });
   });
@@ -2006,7 +2008,9 @@ describe('The convert v2 Function', function() {
         expect(conversionResult.output[0].data.auth.apikey[1].value).to.equal('{{apiKey}}');
 
         const item = conversionResult.output[0].data.item[0].item[0].item[0];
-        expect(item.request.header).to.not.be.ok;
+        expect(item.request.header.length).to.eql(1);
+        expect(item.request.header[0].key).to.eql('Accept');
+        expect(item.request.header[0].value).to.eql('application/json');
         expect(item.response[0].originalRequest.header[0]).to.be.eql({
           description: {
             content: 'Added as a part of security scheme: apikey',
@@ -2028,8 +2032,12 @@ describe('The convert v2 Function', function() {
           expect(conversionResult.result).to.equal(true);
 
           const item = conversionResult.output[0].data.item[0].item[0].item[0];
-          expect(item.request.header).to.not.be.ok;
-          expect(item.response[0].originalRequest.header).to.not.be.ok;
+          expect(item.request.header.length).to.eql(1);
+          expect(item.request.header[0].key).to.eql('Accept');
+          expect(item.request.header[0].value).to.eql('application/json');
+          expect(item.response[0].originalRequest.header.length).to.eql(1);
+          expect(item.response[0].originalRequest.header[0].key).to.eql('Accept');
+          expect(item.response[0].originalRequest.header[0].value).to.eql('application/json');
 
           done();
         });
@@ -2051,7 +2059,9 @@ describe('The convert v2 Function', function() {
 
         const item = conversionResult.output[0].data.item[0].item[0].item[0];
 
-        expect(item.request.header).to.not.be.ok;
+        expect(item.request.header.length).to.eql(1);
+        expect(item.request.header[0].key).to.eql('Accept');
+        expect(item.request.header[0].value).to.eql('application/json');
         expect(item.response[0].originalRequest.header[0]).to.be.eql({
           description: {
             content: 'Added as a part of security scheme: oauth1',