fix: adding support for handling requestBody if its in a $ref (#847)

readmeio · Jul 17, 2020 · 7f80255 · 7f80255
1 parent 783fe1a
commit 7f80255
Show file tree

Hide file tree

Showing 7 changed files with 75 additions and 12 deletions.
diff --git a/packages/api-explorer/package-lock.json b/packages/api-explorer/package-lock.json
diff --git a/packages/api-explorer/package.json b/packages/api-explorer/package.json
@@ -10,7 +10,7 @@
     "@readme/oas-extensions": "^6.13.0",
     "@readme/oas-to-har": "^6.15.1",
     "@readme/oas-to-snippet": "^6.15.1",
-    "@readme/oas-tooling": "^3.5.2",
+    "@readme/oas-tooling": "^3.5.4",
     "@readme/react-jsonschema-form": "^1.1.5",
     "@readme/syntax-highlighter": "^6.15.1",
     "@readme/variable": "^6.13.0",

diff --git a/packages/oas-to-har/__tests__/index.test.js b/packages/oas-to-har/__tests__/index.test.js
@@ -860,6 +860,69 @@ describe('requestBody', () => {
       ).toBeUndefined();
     });
 
+    describe('multipart/form-data', () => {
+      it('should handle multipart/form-data request bodies', () => {
+        const har = oasToHar(
+          new Oas({
+            components: {
+              requestBodies: {
+                payload: {
+                  required: true,
+                  content: {
+                    'multipart/form-data': {
+                      schema: {
+                        type: 'object',
+                        properties: {
+                          'Document file': {
+                            type: 'string',
+                            format: 'binary',
+                          },
+                        },
+                      },
+                    },
+                  },
+                },
+              },
+              securitySchemes: {
+                bearerAuth: {
+                  type: 'apiKey',
+                  name: 'Authorization',
+                  in: 'header',
+                },
+              },
+            },
+          }),
+          {
+            path: '/multipart',
+            method: 'post',
+            security: [
+              {
+                bearerAuth: [],
+              },
+            ],
+            requestBody: {
+              $ref: '#/components/requestBodies/payload',
+            },
+            responses: {
+              default: {
+                description: 'OK',
+              },
+            },
+          },
+          {
+            body: {
+              'Document file': '.....',
+            },
+          }
+        );
+
+        expect(har.log.entries[0].request.headers).toStrictEqual([
+          { name: 'Content-Type', value: 'multipart/form-data' },
+        ]);
+        expect(har.log.entries[0].request.postData.mimeType).toBe('multipart/form-data');
+      });
+    });
+
     describe('`json` type', () => {
       it('should work for refs that require a lookup', () => {
         expect(

diff --git a/packages/oas-to-har/package-lock.json b/packages/oas-to-har/package-lock.json
diff --git a/packages/oas-to-har/package.json b/packages/oas-to-har/package.json
@@ -5,7 +5,7 @@
   "main": "src/index.js",
   "dependencies": {
     "@readme/oas-extensions": "^6.13.0",
-    "@readme/oas-tooling": "^3.5.2"
+    "@readme/oas-tooling": "^3.5.4"
   },
   "scripts": {
     "inspect": "jsinspect",

diff --git a/packages/oas-to-snippet/package-lock.json b/packages/oas-to-snippet/package-lock.json
diff --git a/packages/oas-to-snippet/package.json b/packages/oas-to-snippet/package.json
@@ -33,7 +33,7 @@
   "devDependencies": {
     "@readme/eslint-config": "^3.2.0",
     "@readme/oas-examples": "^3.4.0",
-    "@readme/oas-tooling": "^3.5.2",
+    "@readme/oas-tooling": "^3.5.4",
     "eslint": "^7.0.0",
     "jest": "^26.0.1",
     "prettier": "^2.0.1"