Add operation test, minor cleanup (#458)

Author: drwpow

src/transform/operation.ts

@@ -1,5 +1,5 @@
-import { OperationObject, ParameterObject, ReferenceObject } from "../types";
-import { comment, transformRef } from "../utils";
+import { OperationObject, ParameterObject } from "../types";
+import { comment, isRef, transformRef } from "../utils";
 import { transformParametersArray } from "./parameters";
 import { transformResponsesObj } from "./responses";
 import { transformSchemaObj } from "./schema";
@@ -22,7 +22,7 @@ export function transformOperationObj(
     if (isRef(operation.requestBody)) {
       output += `  requestBody: ${transformRef(operation.requestBody.$ref)};\n`;
     } else {
-      const {description, content} = operation.requestBody
+      const { description, content } = operation.requestBody;
 
       if (description) output += comment(description);
 
@@ -36,13 +36,8 @@ export function transformOperationObj(
       } else {
         output += `  requestBody: unknown;\n`;
       }
-
     }
   }
 
   return output;
 }
-
-export function isRef(obj: any): obj is ReferenceObject {
-  return !!obj.$ref
-}

src/types/index.ts

@@ -11,9 +11,9 @@ export interface OpenAPI3 {
   paths?: Record<string, PathItemObject>; // required
   components?: {
     schemas?: Record<string, ReferenceObject | SchemaObject>;
-    requestBodies?: Record<string, ReferenceObject | RequestBody>;
     responses?: Record<string, ReferenceObject | ResponseObject>;
     parameters?: Record<string, ReferenceObject | ParameterObject>;
+    requestBodies?: Record<string, ReferenceObject | RequestBody>;
     headers?: Record<string, ReferenceObject | HeaderObject>;
     links?: Record<string, ReferenceObject | LinkObject>;
   };
@@ -56,8 +56,8 @@ export interface OperationObject {
   summary?: string; // unused
   operationId?: string;
   parameters?: (ReferenceObject | ParameterObject)[];
-  responses?: Record<string, ReferenceObject | ResponseObject>; // required
   requestBody?: ReferenceObject | RequestBody;
+  responses?: Record<string, ReferenceObject | ResponseObject>; // required
 }
 
 export interface ParameterObject {

src/utils.ts

@@ -1,4 +1,4 @@
-import { OpenAPI2, OpenAPI3 } from "./types";
+import { OpenAPI2, OpenAPI3, ReferenceObject } from "./types";
 
 export function comment(text: string): string {
   const commentText = text.trim();
@@ -19,6 +19,11 @@ export function fromEntries(entries: [string, any][]): Record<string, unknown> {
   return entries.reduce((obj, [key, val]) => ({ ...obj, [key]: val }), {});
 }
 
+/** Is this a ReferenceObject? (note: this is just a TypeScript helper for nodeType() below) */
+export function isRef(obj: any): obj is ReferenceObject {
+  return !!obj.$ref;
+}
+
 /** Return type of node (works for v2 or v3, as there are no conflicting types) */
 type SchemaObjectType = "anyOf" | "array" | "boolean" | "enum" | "number" | "object" | "oneOf" | "ref" | "string";
 export function nodeType(obj: any): SchemaObjectType | undefined {

tests/operation.test.ts

@@ -0,0 +1,33 @@
+import { transformOperationObj } from "../src/transform/operation";
+
+describe("requestBody", () => {
+  it("basic", () => {
+    expect(
+      transformOperationObj({
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: { $ref: "#/components/schemas/Pet" },
+            },
+            "application/xml": {
+              schema: { $ref: "#/components/schemas/Pet" },
+            },
+          },
+        },
+      }).trim()
+    ).toBe(`requestBody: {
+    content: {
+      "application/json": components["schemas"]["Pet"];
+      "application/xml": components["schemas"]["Pet"];
+    }
+  }`);
+  });
+
+  it("ref", () => {
+    expect(
+      transformOperationObj({
+        requestBody: { $ref: "#/components/requestBodies/Request" },
+      }).trim()
+    ).toBe(`requestBody: components["requestBodies"]["Request"];`);
+  });
+});