docusaurus-plugin-openapi-docs 4.0.1 → 4.2.0

package/src/markdown/createRequestSchema.ts

@@ -5,11 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { createDescription } from "./createDescription";
-import { createDetails } from "./createDetails";
-import { createDetailsSummary } from "./createDetailsSummary";
-import { createNodes } from "./createSchema";
-import { create, guard } from "./utils";
+import { create } from "./utils";
 import { MediaTypeObject } from "../openapi/types";
 
 interface Props {
@@ -25,142 +21,12 @@ interface Props {
 }
 
 export function createRequestSchema({ title, body, ...rest }: Props) {
-  if (
-    body === undefined ||
-    body.content === undefined ||
-    Object.keys(body).length === 0 ||
-    Object.keys(body.content).length === 0
-  ) {
-    return undefined;
-  }
-
-  // Get all MIME types, including vendor-specific
-  const mimeTypes = Object.keys(body.content);
-
-  if (mimeTypes && mimeTypes.length > 1) {
-    return create("MimeTabs", {
-      className: "openapi-tabs__mime",
-      schemaType: "request",
-      children: mimeTypes.map((mimeType) => {
-        const firstBody = body.content![mimeType].schema;
-        if (firstBody === undefined) {
-          return undefined;
-        }
-        if (firstBody.properties !== undefined) {
-          if (Object.keys(firstBody.properties).length === 0) {
-            return undefined;
-          }
-        }
-        return create("TabItem", {
-          label: mimeType,
-          value: `${mimeType}`,
-          children: [
-            createDetails({
-              className: "openapi-markdown__details mime",
-              "data-collapsed": false,
-              open: true,
-              ...rest,
-              children: [
-                createDetailsSummary({
-                  className: "openapi-markdown__details-summary-mime",
-                  children: [
-                    create("h3", {
-                      className:
-                        "openapi-markdown__details-summary-header-body",
-                      children: `${title}`,
-                    }),
-                    guard(body.required && body.required === true, () => [
-                      create("span", {
-                        className: "openapi-schema__required",
-                        children: "required",
-                      }),
-                    ]),
-                  ],
-                }),
-                create("div", {
-                  style: { textAlign: "left", marginLeft: "1rem" },
-                  children: [
-                    guard(body.description, () => [
-                      create("div", {
-                        style: { marginTop: "1rem", marginBottom: "1rem" },
-                        children: createDescription(body.description),
-                      }),
-                    ]),
-                  ],
-                }),
-                create("ul", {
-                  style: { marginLeft: "1rem" },
-                  children: createNodes(firstBody, "request"),
-                }),
-              ],
-            }),
-          ],
-        });
-      }),
-    });
-  }
-
-  const randomFirstKey = Object.keys(body.content)[0];
-  const firstBody: any =
-    body.content[randomFirstKey].schema ?? body.content![randomFirstKey];
-
-  if (firstBody === undefined) {
-    return undefined;
-  }
-
-  return create("MimeTabs", {
-    className: "openapi-tabs__mime",
-    children: [
-      create("TabItem", {
-        label: randomFirstKey,
-        value: `${randomFirstKey}-schema`,
-        children: [
-          createDetails({
-            className: "openapi-markdown__details mime",
-            "data-collapsed": false,
-            open: true,
-            ...rest,
-            children: [
-              createDetailsSummary({
-                className: "openapi-markdown__details-summary-mime",
-                children: [
-                  create("h3", {
-                    className: "openapi-markdown__details-summary-header-body",
-                    children: `${title}`,
-                  }),
-                  guard(firstBody.type === "array", (format) =>
-                    create("span", {
-                      style: { opacity: "0.6" },
-                      children: ` array`,
-                    })
-                  ),
-                  guard(body.required, () => [
-                    create("strong", {
-                      className: "openapi-schema__required",
-                      children: "required",
-                    }),
-                  ]),
-                ],
-              }),
-              create("div", {
-                style: { textAlign: "left", marginLeft: "1rem" },
-                children: [
-                  guard(body.description, () => [
-                    create("div", {
-                      style: { marginTop: "1rem", marginBottom: "1rem" },
-                      children: createDescription(body.description),
-                    }),
-                  ]),
-                ],
-              }),
-              create("ul", {
-                style: { marginLeft: "1rem" },
-                children: createNodes(firstBody, "request"),
-              }),
-            ],
-          }),
-        ],
-      }),
-    ],
-  });
+  return [
+    create("RequestSchema", {
+      title: title,
+      body: body,
+      ...rest,
+    }),
+    "\n\n",
+  ];
 }

package/src/markdown/createResponseSchema.ts

@@ -5,16 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { createDescription } from "./createDescription";
-import { createDetails } from "./createDetails";
-import { createDetailsSummary } from "./createDetailsSummary";
-import { createNodes } from "./createSchema";
-import {
-  createExampleFromSchema,
-  createResponseExample,
-  createResponseExamples,
-} from "./createStatusCodes";
-import { create, guard } from "./utils";
+import { create } from "./utils";
 import { MediaTypeObject } from "../openapi/types";
 
 interface Props {
@@ -30,106 +21,12 @@ interface Props {
 }
 
 export function createResponseSchema({ title, body, ...rest }: Props) {
-  if (
-    body === undefined ||
-    body.content === undefined ||
-    Object.keys(body).length === 0 ||
-    Object.keys(body.content).length === 0
-  ) {
-    return undefined;
-  }
-
-  // Get all MIME types, including vendor-specific
-  const mimeTypes = Object.keys(body.content);
-
-  if (mimeTypes && mimeTypes.length) {
-    return create("MimeTabs", {
-      className: "openapi-tabs__mime",
-      schemaType: "response",
-      children: mimeTypes.map((mimeType: any) => {
-        const responseExamples = body.content![mimeType].examples;
-        const responseExample = body.content![mimeType].example;
-        const firstBody: any =
-          body.content![mimeType].schema ?? body.content![mimeType];
-
-        if (
-          firstBody === undefined &&
-          responseExample === undefined &&
-          responseExamples === undefined
-        ) {
-          return undefined;
-        }
-
-        return create("TabItem", {
-          label: `${mimeType}`,
-          value: `${mimeType}`,
-          children: [
-            create("SchemaTabs", {
-              className: "openapi-tabs__schema",
-              // TODO: determine if we should persist this
-              // groupId: "schema-tabs",
-              children: [
-                firstBody &&
-                  create("TabItem", {
-                    label: `${title}`,
-                    value: `${title}`,
-                    children: [
-                      createDetails({
-                        className: "openapi-markdown__details response",
-                        "data-collapsed": false,
-                        open: true,
-                        ...rest,
-                        children: [
-                          createDetailsSummary({
-                            className:
-                              "openapi-markdown__details-summary-response",
-                            children: [
-                              create("strong", { children: `${title}` }),
-                              guard(
-                                body.required && body.required === true,
-                                () => [
-                                  create("span", {
-                                    className: "openapi-schema__required",
-                                    children: "required",
-                                  }),
-                                ]
-                              ),
-                            ],
-                          }),
-                          create("div", {
-                            style: { textAlign: "left", marginLeft: "1rem" },
-                            children: [
-                              guard(body.description, () => [
-                                create("div", {
-                                  style: {
-                                    marginTop: "1rem",
-                                    marginBottom: "1rem",
-                                  },
-                                  children: createDescription(body.description),
-                                }),
-                              ]),
-                            ],
-                          }),
-                          create("ul", {
-                            style: { marginLeft: "1rem" },
-                            children: createNodes(firstBody!, "response"),
-                          }),
-                        ],
-                      }),
-                    ],
-                  }),
-                firstBody && createExampleFromSchema(firstBody, mimeType),
-                responseExamples &&
-                  createResponseExamples(responseExamples, mimeType),
-                responseExample &&
-                  createResponseExample(responseExample, mimeType),
-              ],
-            }),
-          ],
-        });
-      }),
-    });
-  }
-
-  return undefined;
+  return [
+    create("ResponseSchema", {
+      title: title,
+      body: body,
+      ...rest,
+    }),
+    "\n\n",
+  ];
 }

package/src/markdown/createSchema.test.ts

@@ -246,6 +246,70 @@ describe("createNodes", () => {
     });
   });
 
+  describe("anyOf", () => {
+    it("should render primitives within anyOf", async () => {
+      const schema: SchemaObject = {
+        type: "object",
+        properties: {
+          oneOfProperty: {
+            anyOf: [
+              {
+                type: "integer",
+              },
+              {
+                type: "boolean",
+              },
+            ],
+            title: "One of int or bool",
+          },
+        },
+      };
+
+      expect(
+        await Promise.all(
+          createNodes(schema, "response").map(
+            async (md: any) => await prettier.format(md, { parser: "babel" })
+          )
+        )
+      ).toMatchSnapshot();
+    });
+
+    it("should render oneOf within anyOf", async () => {
+      const schema: SchemaObject = {
+        type: "object",
+        properties: {
+          oneOfProperty: {
+            anyOf: [
+              {
+                oneOf: [
+                  {
+                    type: "integer",
+                  },
+                  {
+                    type: "boolean",
+                  },
+                ],
+                title: "An int or a bool",
+              },
+              {
+                type: "string",
+              },
+            ],
+            title: "One of int or bool, or a string",
+          },
+        },
+      };
+
+      expect(
+        await Promise.all(
+          createNodes(schema, "response").map(
+            async (md: any) => await prettier.format(md, { parser: "babel" })
+          )
+        )
+      ).toMatchSnapshot();
+    });
+  });
+
   describe("allOf", () => {
     it("should render same-level properties with allOf", async () => {
       const schema: SchemaObject = {

package/src/markdown/createSchema.ts

@@ -5,6 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { merge } from "allof-merge";
 import clsx from "clsx";
 import isEmpty from "lodash/isEmpty";
 
@@ -19,41 +21,18 @@ import { getQualifierMessage, getSchemaName } from "./schema";
 import { create, guard } from "./utils";
 import { SchemaObject } from "../openapi/types";
 
-const jsonSchemaMergeAllOf = require("json-schema-merge-allof");
-
 let SCHEMA_TYPE: "request" | "response";
 
 /**
  * Returns a merged representation of allOf array of schemas.
  */
-export function mergeAllOf(allOf: SchemaObject[]) {
-  const mergedSchemas = jsonSchemaMergeAllOf(allOf, {
-    resolvers: {
-      readOnly: function () {
-        return true;
-      },
-      writeOnly: function () {
-        return true;
-      },
-      example: function () {
-        return true;
-      },
-      "x-examples": function () {
-        return true;
-      },
-    },
-    ignoreAdditionalProperties: true,
-  });
-
-  const mergedRequired = allOf.reduce((acc, cur) => {
-    if (Array.isArray(cur.required)) {
-      const next = [...acc, ...cur.required];
-      return next;
-    }
-    return acc;
-  }, [] as any);
+export function mergeAllOf(allOf: SchemaObject) {
+  const onMergeError = (msg: string) => {
+    console.warn(msg);
+  };
 
-  return { mergedSchemas, mergedRequired };
+  const mergedSchemas = merge(allOf, { onMergeError }) as SchemaObject;
+  return mergedSchemas;
 }
 
 /**
@@ -104,6 +83,11 @@ function createAnyOneOf(schema: SchemaObject): any {
             delete anyOneSchema.allOf;
           }
 
+          if (anyOneSchema.oneOf !== undefined) {
+            anyOneChildren.push(createNodes(anyOneSchema, SCHEMA_TYPE));
+            delete anyOneSchema.oneOf;
+          }
+
           if (anyOneSchema.items !== undefined) {
             anyOneChildren.push(createItems(anyOneSchema));
             delete anyOneSchema.items;
@@ -266,10 +250,7 @@ function createItems(schema: SchemaObject) {
 
   if (schema.items?.allOf !== undefined) {
     // TODO: figure out if and how we should pass merged required array
-    const {
-      mergedSchemas,
-    }: { mergedSchemas: SchemaObject; mergedRequired: string[] | boolean } =
-      mergeAllOf(schema.items?.allOf);
+    const mergedSchemas = mergeAllOf(schema.items) as SchemaObject;
 
     // Handles combo anyOf/oneOf + properties
     if (
@@ -411,16 +392,16 @@ function createDetailsNode(
           create("div", {
             style: { marginLeft: "1rem" },
             children: [
-              guard(getQualifierMessage(schema), (message) =>
+              guard(schema.description, (description) =>
                 create("div", {
                   style: { marginTop: ".5rem", marginBottom: ".5rem" },
-                  children: createDescription(message),
+                  children: createDescription(description),
                 })
               ),
-              guard(schema.description, (description) =>
+              guard(getQualifierMessage(schema), (message) =>
                 create("div", {
                   style: { marginTop: ".5rem", marginBottom: ".5rem" },
-                  children: createDescription(description),
+                  children: createDescription(message),
                 })
               ),
               createNodes(schema, SCHEMA_TYPE),
@@ -554,20 +535,20 @@ function createPropertyDiscriminator(
             ]),
           ],
         }),
-        guard(getQualifierMessage(discriminator), (message) =>
+        guard(schema.description, (description) =>
           create("div", {
             style: {
               paddingLeft: "1rem",
             },
-            children: createDescription(message),
+            children: createDescription(description),
           })
         ),
-        guard(schema.description, (description) =>
+        guard(getQualifierMessage(discriminator), (message) =>
           create("div", {
             style: {
               paddingLeft: "1rem",
             },
-            children: createDescription(description),
+            children: createDescription(message),
           })
         ),
         create("DiscriminatorTabs", {
@@ -678,10 +659,8 @@ function createEdges({
     );
   }
 
-  if (schema.allOf !== undefined) {
-    const { mergedSchemas }: { mergedSchemas: SchemaObject } = mergeAllOf(
-      schema.allOf
-    );
+  if (schema.items?.allOf !== undefined) {
+    const mergedSchemas = mergeAllOf(schema.items);
 
     if (SCHEMA_TYPE === "request") {
       if (mergedSchemas.readOnly && mergedSchemas.readOnly === true) {
@@ -696,6 +675,7 @@ function createEdges({
     }
 
     const mergedSchemaName = getSchemaName(mergedSchemas);
+
     if (
       mergedSchemas.oneOf !== undefined ||
       mergedSchemas.anyOf !== undefined
@@ -705,7 +685,7 @@ function createEdges({
         mergedSchemaName,
         mergedSchemas,
         required,
-        schema.nullable
+        mergedSchemas.nullable
       );
     }
 
@@ -715,7 +695,7 @@ function createEdges({
         mergedSchemaName,
         mergedSchemas,
         required,
-        schema.nullable
+        mergedSchemas.nullable
       );
     }
 
@@ -725,7 +705,7 @@ function createEdges({
         mergedSchemaName,
         mergedSchemas,
         required,
-        schema.nullable
+        mergedSchemas.nullable
       );
     }
 
@@ -736,7 +716,7 @@ function createEdges({
         mergedSchemaName,
         mergedSchemas,
         required,
-        schema.nullable
+        mergedSchemas.nullable
       );
     }
 
@@ -803,7 +783,7 @@ export function createNodes(
   }
 
   if (schema.allOf !== undefined) {
-    const { mergedSchemas } = mergeAllOf(schema.allOf);
+    const mergedSchemas = mergeAllOf(schema) as SchemaObject;
 
     if (
       mergedSchemas.oneOf !== undefined ||