fix(execute): parse stringified objects nested in arrays (#3466)

Refs swagger-api/swagger-ui#9521
swagger-api · Apr 11, 2024 · b1f2ee7 · b1f2ee7
1 parent f72651a
commit b1f2ee7
Show file tree

Hide file tree

Showing 2 changed files with 102 additions and 1 deletion.
diff --git a/src/execute/oas3/content-serializer.js b/src/execute/oas3/content-serializer.js
@@ -9,8 +9,19 @@ export default function serialize(value, mediaType) {
       // Assume the user has a JSON string
       return value;
     }
+
+    if (Array.isArray(value)) {
+      value = value.map((v) => {
+        try {
+          return JSON.parse(v);
+        } catch (e) {
+          return v;
+        }
+      });
+    }
+
     return JSON.stringify(value);
   }
 
-  return value.toString();
+  return String(value);
 }
diff --git a/test/oas3/execute/main.js b/test/oas3/execute/main.js
@@ -871,6 +871,96 @@ describe('buildRequest - OpenAPI Specification 3.0', () => {
       });
     });
 
+    it('should serialize JSON values provided as arrays of stringified objects', () => {
+      const req = buildRequest({
+        spec: {
+          openapi: '3.0.0',
+          paths: {
+            '/{pathPartial}': {
+              post: {
+                operationId: 'myOp',
+                parameters: [
+                  {
+                    name: 'query',
+                    in: 'query',
+                    content: {
+                      'application/json': {
+                        schema: {
+                          type: 'array',
+                          items: {
+                            type: 'object',
+                          },
+                        },
+                      },
+                    },
+                  },
+                  {
+                    name: 'FooHeader',
+                    in: 'header',
+                    content: {
+                      'application/json': {
+                        schema: {
+                          type: 'array',
+                          items: {
+                            type: 'object',
+                          },
+                        },
+                      },
+                    },
+                  },
+                  {
+                    name: 'pathPartial',
+                    in: 'path',
+                    content: {
+                      'application/json': {
+                        schema: {
+                          type: 'array',
+                          items: {
+                            type: 'object',
+                          },
+                        },
+                      },
+                    },
+                  },
+                  {
+                    name: 'myCookie',
+                    in: 'cookie',
+                    content: {
+                      'application/json': {
+                        schema: {
+                          type: 'array',
+                          items: {
+                            type: 'object',
+                          },
+                        },
+                      },
+                    },
+                  },
+                ],
+              },
+            },
+          },
+        },
+        operationId: 'myOp',
+        parameters: {
+          query: ['{"a":1}', '{"b":"2"}'],
+          FooHeader: ['{"foo":"bar"}'],
+          pathPartial: ['{"baz":"qux"}'],
+          myCookie: ['{"flavor":"chocolate chip"}'],
+        },
+      });
+
+      expect(req).toEqual({
+        method: 'POST',
+        url: `/${escape('[{"baz":"qux"}]')}?query=${escape('[{"a":1},{"b":"2"}]')}`,
+        credentials: 'same-origin',
+        headers: {
+          FooHeader: '[{"foo":"bar"}]',
+          Cookie: 'myCookie=[{"flavor":"chocolate chip"}]',
+        },
+      });
+    });
+
     it('should not serialize undefined parameters', () => {
       const spec = {
         openapi: '3.0.1',