prevent use of */* to end in an empty response

Author: LuisTejedaS

lib/schemaUtils.js

@@ -1333,7 +1333,8 @@ module.exports = {
   convertToPmResponseBody: function(contentObj, components, options, schemaCache) {
     options = _.merge({}, defaultOptions, options);
 
-    var responseBody, cTypeHeader, hasComputedType, cTypes;
+    var responseBody, cTypeHeader, hasComputedType, cTypes,
+      isJsonLike = false;
     if (!contentObj) {
       return {
         contentTypeHeader: null,
@@ -1374,12 +1375,18 @@ module.exports = {
       responseBody = JSON.stringify(responseBody, null, options.indentCharacter);
     }
     else if (typeof responseBody !== 'string') {
-      // since the collection v2 schema only supports body being a string
-      responseBody = '';
+      if (!_.isObject(responseBody) && _.isFunction(_.get(responseBody, 'toString'))) {
+        responseBody = responseBody.toString();
+      }
+      else {
+        responseBody = JSON.stringify(responseBody, null, options.indentCharacter);
+        isJsonLike = true;
+      }
     }
     return {
       contentTypeHeader: cTypeHeader,
-      responseBody: responseBody
+      responseBody: responseBody,
+      isJsonLike
     };
   },
 
@@ -2108,7 +2115,27 @@ module.exports = {
     });
 
     responseBodyWrapper = this.convertToPmResponseBody(response.content, components, options, schemaCache);
+    previewLanguage = this.resolveResponsePreviewLanguageAndResponseHeader(responseBodyWrapper,
+      responseHeaders, response);
+    // replace 'X' char with '0'
+    code = code.replace(/X/g, '0');
+    code = code === 'default' ? 500 : _.toSafeInteger(code);
+
+    sdkResponse = new sdk.Response({
+      name: response.description,
+      code: code || 500,
+      header: responseHeaders,
+      body: responseBodyWrapper.responseBody,
+      originalRequest: originalRequest
+    });
+    sdkResponse._postman_previewlanguage = previewLanguage;
+
+    return sdkResponse;
+  },
 
+  resolveResponsePreviewLanguageAndResponseHeader: function (responseBodyWrapper,
+    responseHeaders, response) {
+    let previewLanguage = 'text';
     if (responseBodyWrapper.contentTypeHeader) {
       // we could infer the content-type header from the body
       responseHeaders.push({ key: 'Content-Type', value: responseBodyWrapper.contentTypeHeader });
@@ -2118,6 +2145,9 @@ module.exports = {
       else if (this.getHeaderFamily(responseBodyWrapper.contentTypeHeader) === HEADER_TYPE.XML) {
         previewLanguage = PREVIEW_LANGUAGE.XML;
       }
+      else if (responseBodyWrapper.isJsonLike) {
+        previewLanguage = PREVIEW_LANGUAGE.JSON;
+      }
     }
     else if (response.content && Object.keys(response.content).length > 0) {
       responseHeaders.push({ key: 'Content-Type', value: Object.keys(response.content)[0] });
@@ -2127,24 +2157,14 @@ module.exports = {
       else if (this.getHeaderFamily(Object.keys(response.content)[0]) === HEADER_TYPE.XML) {
         previewLanguage = PREVIEW_LANGUAGE.XML;
       }
+      else if (responseBodyWrapper.isJsonLike) {
+        previewLanguage = PREVIEW_LANGUAGE.JSON;
+      }
     }
     else {
       responseHeaders.push({ key: 'Content-Type', value: TEXT_PLAIN });
     }
-    // replace 'X' char with '0'
-    code = code.replace(/X/g, '0');
-    code = code === 'default' ? 500 : _.toSafeInteger(code);
-
-    sdkResponse = new sdk.Response({
-      name: response.description,
-      code: code || 500,
-      header: responseHeaders,
-      body: responseBodyWrapper.responseBody,
-      originalRequest: originalRequest
-    });
-    sdkResponse._postman_previewlanguage = previewLanguage;
-
-    return sdkResponse;
+    return previewLanguage;
   },
 
   /**

test/data/valid_swagger/json/rangeMediaType.json

@@ -0,0 +1,103 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "description": "This API provides access to signature platform \n\nWorkflow:\n\nDepending on the needs of the client, the order and use of the calls to the API may differ.<br>\nHere is an example of a very basic workflow:\n1) Create Request - Provides the information that will be used for the signer's certificate.\n2) Create Signature Request - Provides the information for the creation of the visible signature. Also provides the document(s) to be signed.\n3) Launch Signature Request - Launches the signature process based on the two previous requests.\n4) Get Signature Request Status - Returns the current status of the signature request and, if the status is \"SIGNED\", provides the signed document.\nA list of all requests is provided below, however the order is not necessarily correct for the signature process.\n\nWe suggest that the client begins with this basic workflow and expands based on their specific needs.",
+    "version": "1.11.2",
+    "title": "Signature api"
+  },
+  "host": "sign-sandbox.certeurope.fr",
+  "basePath": "/",
+  "tags": [{
+    "name": "Signature",
+    "description": "Centralize Signing API"
+  }],
+  "paths": {
+    "/centralize/admin/orders/{raProfileId}": {
+      "post": {
+        "tags": ["Signature"],
+        "summary": "createAdminCentralizedOrder",
+        "operationId": "createAdminCentralizedOrderUsingPOST",
+        "consumes": ["application/json"],
+        "produces": ["*/*"],
+        "parameters": [{
+          "name": "raProfileId",
+          "in": "path",
+          "description": "raProfileId",
+          "required": true,
+          "type": "integer",
+          "format": "int64"
+        }, {
+          "in": "body",
+          "name": "request",
+          "description": "request",
+          "required": true,
+          "schema": {
+            "$ref": "#/definitions/CentralizedOrderRequestDTO"
+          }
+        }],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "schema": {
+              "$ref": "#/definitions/AliveOKDTO"
+            }
+          }
+        }
+      }
+    }
+  },
+  "definitions": {
+    "AliveOKDTO": {
+      "type": "object",
+      "properties": {
+        "archiver": {
+          "type": "boolean"
+        },
+        "kms": {
+          "type": "boolean"
+        },
+        "ok": {
+          "type": "boolean"
+        },
+        "ts": {
+          "type": "boolean"
+        }
+      },
+      "title": "AliveOKDTO"
+    },
+    "CentralizedOrderRequestDTO": {
+      "type": "object",
+      "properties": {
+        "aeFolderId": {
+          "type": "string"
+        },
+        "clientIdentifier": {
+          "type": "string"
+        },
+        "enableEmail": {
+          "type": "boolean"
+        },
+        "enableOtp": {
+          "type": "boolean"
+        },
+        "enablePin": {
+          "type": "boolean"
+        },
+        "enableSharing": {
+          "type": "boolean"
+        },
+        "externalOrderRequestId": {
+          "type": "string"
+        },
+        "otpContact": {
+          "type": "string"
+        },
+        "signatureMode": {
+          "type": "string",
+          "enum": ["SOFTWARE", "HARDWARE"]
+        }
+      },
+      "title": "CentralizedOrderRequestDTO"
+    }
+  }
+}

test/unit/x20schemapack.test.js

@@ -47,7 +47,7 @@ describe('getMetaData method', function() {
 });
 
 describe('Convert method', function() {
-  it('Should convert an example file from: ', function(done) {
+  it('Should convert an example file from: sampleswagger.json', function(done) {
     const fileSource = path.join(__dirname, SWAGGER_20_FOLDER_JSON, 'sampleswagger.json'),
       fileData = fs.readFileSync(fileSource, 'utf8'),
       input = {
@@ -62,6 +62,23 @@ describe('Convert method', function() {
     });
     done();
   });
+
+  it('Should convert an example file from: rangeMediaType.json', function(done) {
+    const fileSource = path.join(__dirname, SWAGGER_20_FOLDER_JSON, 'rangeMediaType.json'),
+      fileData = fs.readFileSync(fileSource, 'utf8'),
+      input = {
+        type: 'string',
+        data: fileData
+      },
+      schemapack = new SchemaPack(input);
+
+    schemapack.convert((error, result) => {
+      expect(error).to.be.null;
+      expect(result.output[0].data.item[0].response[0]._postman_previewlanguage).to.equal('json');
+      expect(result.output[0].data.item[0].response[0].body).to.not.be.empty;
+    });
+    done();
+  });
 });
 
 describe('Swagger 2.0  schemapack mergeAndValidate method', function() {