Merge branch 'feature/multipart-form-data-support' into scratch

src/api.js

@@ -136,6 +136,9 @@ Swagger.makeApisTagOperation = client => {
                   }),
                   {}
                 );
+              } else if (parameter.in === "data") {
+                parameters.data = parameters.data || {};
+                parameters.data[parameter.name] = parameter;
               } else if (parameter.in === "query") {
                 parameters[parameter.name] = parameter;
               }

src/forms/utils.js

@@ -2,8 +2,16 @@ function normalizePath(path) {
   return path.replace("]", "").replace("[", ".");
 }
 
-// TODO: more verbose error messages
 export function fieldFromSchema(schema, field) {
+  if (Array.isArray(schema)) {
+    return fieldFromFlatSchema(schema, field);
+  }
+  return fieldFromNestedSchema(schema, field);
+}
+
+// TODO: more verbose error messages
+// Nested schema is typically used for content-type application/json
+export function fieldFromNestedSchema(schema, field) {
   const normalizedSchema = { type: "object", properties: schema };
   const normalizedPath = normalizePath(field);
   return normalizedPath.split(".").reduce((acc, key) => {
@@ -27,6 +35,15 @@ export function fieldFromSchema(schema, field) {
   }, normalizedSchema);
 }
 
+// Flat schema is typically used for content-type multipart/form-data
+export function fieldFromFlatSchema(schema, field) {
+  const value = schema.find(({ name }) => name === field);
+  if (typeof value === "undefined") {
+    throw new Error(`Encountered a non-existent field "${field}".`);
+  }
+  return value;
+}
+
 export function fieldFromErrorResponse(response, field) {
   const normalizedPath = normalizePath(field);
   return normalizedPath

tests/fixtures/schema.js

@@ -87,3 +87,35 @@ export const nestedSchema = {
     $$ref: "#/definitions/Artist",
   },
 };
+
+// Used when an endpoint expects multipart/form-data
+export const flatSchema = [
+  {
+    name: "order",
+    in: "formData",
+    required: true,
+    type: "integer",
+  },
+  {
+    name: "title",
+    in: "formData",
+    required: true,
+    type: "string",
+    maxLength: 64,
+    minLength: 1,
+  },
+  {
+    name: "content",
+    in: "formData",
+    required: false,
+    type: "string",
+    "x-nullable": true,
+  },
+  {
+    name: "attachment",
+    in: "formData",
+    required: false,
+    type: "file",
+    "x-nullable": true,
+  },
+];

tests/forms/utils.test.js

@@ -1,6 +1,6 @@
 import { fieldFromErrorResponse, fieldFromSchema } from "../../src/forms/utils";
 import { errorResponse } from "../fixtures/response";
-import { nestedSchema } from "../fixtures/schema";
+import { flatSchema, nestedSchema } from "../fixtures/schema";
 
 test("Get a top level field from schema", () => {
   expect(fieldFromSchema(nestedSchema, "id")).toEqual({
@@ -65,3 +65,13 @@ test("Get an array field from error response", () => {
     "Ensure this field has at least 12 characters.",
   ]);
 });
+
+test("Get a field from a multipart/form-data schema", () => {
+  expect(fieldFromSchema(flatSchema, "attachment")).toEqual({
+    name: "attachment",
+    in: "formData",
+    required: false,
+    type: "file",
+    "x-nullable": true,
+  });
+});