Fix to convert "format:binary "to type:"file

postmanlabs · Jul 16, 2024 · c753ff0 · c753ff0
1 parent fec6268
commit c753ff0
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 3 deletions.
diff --git a/libV2/schemaUtils.js b/libV2/schemaUtils.js
@@ -479,11 +479,11 @@ let QUERYPARAM = 'query',
    * @param {Object} context - Global context
    * @param {Object} schema - Schema that is to be resolved
    * @param {Number} [stack] - Current recursion depth
-   * @param {String} resolveFor - For which action this resoltion is to be done
+   * @param {String} resolveFor - For which action this resolution is to be done
    * @param {Object} seenRef - Map of all the references that have been resolved
    * @todo: Explore using a directed graph/tree for maintaining seen ref
    *
-   * @returns {Object} Returns the object that staisfies the schema
+   * @returns {Object} Returns the object that satisfies the schema
    */
   resolveSchema = (context, schema, stack = 0, resolveFor = CONVERSION, seenRef = {}) => {
     if (!schema) {
@@ -576,6 +576,11 @@ let QUERYPARAM = 'query',
           return;
         }
 
+        // Set type to binary
+        if (property.format === 'binary') {
+          property.type = 'binary';
+        }
+
         if (
           property.format === 'decimal' ||
           property.format === 'byte' ||

diff --git a/test/data/valid_openapi/form-binary-file.json b/test/data/valid_openapi/form-binary-file.json
@@ -0,0 +1,37 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Form Data - Binary - OpenAPI 3.0",
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/uploadImage": {
+      "post": {
+        "summary": "uploads an image",
+        "description": "",
+        "operationId": "uploadFile",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "multipart/form-data": {
+              "schema": {
+                "properties": {
+                  "inputfile": {
+                    "type": "string",
+                    "format": "binary",
+                    "description": "The file to be uploaded."
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "successful operation"
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/test/unit/convertV2.test.js b/test/unit/convertV2.test.js
@@ -110,7 +110,8 @@ const expect = require('chai').expect,
   multiExampleResponseCodeMatching =
     path.join(__dirname, VALID_OPENAPI_PATH, '/multiExampleResponseCodeMatching.json'),
   duplicateCollectionVars =
-    path.join(__dirname, VALID_OPENAPI_PATH, '/duplicateCollectionVars.json');
+    path.join(__dirname, VALID_OPENAPI_PATH, '/duplicateCollectionVars.json'),
+  issue795 = path.join(__dirname, VALID_OPENAPI_PATH, '/form-binary-file.json');
 
 
 describe('The convert v2 Function', function() {
@@ -2819,4 +2820,25 @@ describe('The convert v2 Function', function() {
         done();
       });
   });
+
+  it('[Github #795] Should properly convert format binary to form data', function (done) {
+    var openapi = fs.readFileSync(issue795, 'utf8'),
+      reqBody, formData;
+    Converter.convertV2({ type: 'string', data: openapi }, {
+      requestNameSource: 'Fallback',
+      indentCharacter: 'Space',
+      collapseFolders: true,
+      optimizeConversion: true,
+      parametersResolution: 'schema'
+    }, (err, conversionResult) => {
+
+      reqBody = conversionResult.output[0].data.item[0].item[0].request.body;
+      formData = reqBody.formdata[0];
+
+      expect(err).to.be.null;
+      expect(conversionResult.result).to.equal(true);
+      expect(formData.type).to.equal('file');
+      done();
+    });
+  });
 });