docusaurus-plugin-openapi-docs 0.0.0-775 → 0.0.0-783

package/lib/markdown/createCallbackMethodEndpoint.d.ts

@@ -0,0 +1 @@
+export declare function createCallbackMethodEndpoint(method: String, path: String): string[];

package/lib/markdown/createCallbackMethodEndpoint.js

@@ -0,0 +1,21 @@
+"use strict";
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCallbackMethodEndpoint = void 0;
+const utils_1 = require("./utils");
+function createCallbackMethodEndpoint(method, path) {
+    return [
+        (0, utils_1.create)("MethodEndpoint", {
+            method: method,
+            path: path,
+            context: "callback",
+        }),
+        "\n\n",
+    ];
+}
+exports.createCallbackMethodEndpoint = createCallbackMethodEndpoint;

package/lib/markdown/createCallbacks.js

@@ -7,8 +7,8 @@
  * ========================================================================== */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createCallbacks = void 0;
+const createCallbackMethodEndpoint_1 = require("./createCallbackMethodEndpoint");
 const createDescription_1 = require("./createDescription");
-const createMethodEndpoint_1 = require("./createMethodEndpoint");
 const createRequestBodyDetails_1 = require("./createRequestBodyDetails");
 const createStatusCodes_1 = require("./createStatusCodes");
 const utils_1 = require("./utils");
@@ -54,7 +54,7 @@ function createCallbacks({ callbacks }) {
                                 label: `${method.toUpperCase()} ${name}`,
                                 value: `${method}-${name}`,
                                 children: [
-                                    (0, createMethodEndpoint_1.createMethodEndpoint)(method, path),
+                                    (0, createCallbackMethodEndpoint_1.createCallbackMethodEndpoint)(method, path),
                                     // TODO: add `deprecation notice` when markdown support is added
                                     (0, createDescription_1.createDescription)(description),
                                     (0, createRequestBodyDetails_1.createRequestBodyDetails)({

package/lib/markdown/createMethodEndpoint.js

@@ -9,6 +9,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createMethodEndpoint = void 0;
 const utils_1 = require("./utils");
 function createMethodEndpoint(method, path) {
-    return [(0, utils_1.create)("MethodEndpoint", { method: method, path: path }), "\n\n"];
+    return [
+        (0, utils_1.create)("MethodEndpoint", {
+            method: method,
+            path: path,
+            context: "endpoint",
+        }),
+        "\n\n",
+    ];
 }
 exports.createMethodEndpoint = createMethodEndpoint;

package/lib/markdown/createSchema.js

@@ -90,6 +90,10 @@ function createAnyOneOf(schema) {
                         anyOneChildren.push(createNodes(anyOneSchema, SCHEMA_TYPE));
                         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;

package/lib/markdown/createSchema.test.js

@@ -218,6 +218,54 @@ describe("createNodes", () => {
             expect(await Promise.all((0, createSchema_1.createNodes)(schema, "response").map(async (md) => await prettier.format(md, { parser: "babel" })))).toMatchSnapshot();
         });
     });
+    describe("anyOf", () => {
+        it("should render primitives within anyOf", async () => {
+            const schema = {
+                type: "object",
+                properties: {
+                    oneOfProperty: {
+                        anyOf: [
+                            {
+                                type: "integer",
+                            },
+                            {
+                                type: "boolean",
+                            },
+                        ],
+                        title: "One of int or bool",
+                    },
+                },
+            };
+            expect(await Promise.all((0, createSchema_1.createNodes)(schema, "response").map(async (md) => await prettier.format(md, { parser: "babel" })))).toMatchSnapshot();
+        });
+        it("should render oneOf within anyOf", async () => {
+            const schema = {
+                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((0, createSchema_1.createNodes)(schema, "response").map(async (md) => await prettier.format(md, { parser: "babel" })))).toMatchSnapshot();
+        });
+    });
     describe("allOf", () => {
         it("should render same-level properties with allOf", async () => {
             const schema = {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-775",
+  "version": "0.0.0-783",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -62,5 +62,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "fe758c269a82b21258400a773d0fcff3bd312c3e"
+  "gitHead": "fde0fbcb9f5e91b02506de828ad39cc295f68608"
 }

package/src/markdown/__snapshots__/createSchema.test.ts.snap

@@ -368,6 +368,93 @@ Array [
 ]
 `;
 
+exports[`createNodes anyOf should render oneOf within anyOf 1`] = `
+Array [
+  "<SchemaItem collapsible={true} className={\\"schemaItem\\"}>
+  <details style={{}} className={\\"openapi-markdown__details\\"}>
+    <summary style={{}}>
+      <span className={\\"openapi-schema__container\\"}>
+        <strong className={\\"openapi-schema__property\\"}>oneOfProperty</strong>
+        <span className={\\"openapi-schema__name\\"}>object</span>
+      </span>
+    </summary>
+    <div style={{ marginLeft: \\"1rem\\" }}>
+      <div>
+        <span className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }}>
+          anyOf
+        </span>
+        <SchemaTabs>
+          <TabItem label={\\"An int or a bool\\"} value={\\"0-item-properties\\"}>
+            <div>
+              <span
+                className={\\"badge badge--info\\"}
+                style={{ marginBottom: \\"1rem\\" }}
+              >
+                oneOf
+              </span>
+              <SchemaTabs>
+                <TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
+                  <div style={{ marginTop: \\".5rem\\", marginBottom: \\".5rem\\" }}>
+                    integer
+                  </div>
+                </TabItem>
+                <TabItem label={\\"MOD2\\"} value={\\"1-item-properties\\"}>
+                  <div style={{ marginTop: \\".5rem\\", marginBottom: \\".5rem\\" }}>
+                    boolean
+                  </div>
+                </TabItem>
+              </SchemaTabs>
+            </div>
+          </TabItem>
+          <TabItem label={\\"MOD2\\"} value={\\"1-item-properties\\"}>
+            <div style={{ marginTop: \\".5rem\\", marginBottom: \\".5rem\\" }}>
+              string
+            </div>
+          </TabItem>
+        </SchemaTabs>
+      </div>
+    </div>
+  </details>
+</SchemaItem>;
+",
+]
+`;
+
+exports[`createNodes anyOf should render primitives within anyOf 1`] = `
+Array [
+  "<SchemaItem collapsible={true} className={\\"schemaItem\\"}>
+  <details style={{}} className={\\"openapi-markdown__details\\"}>
+    <summary style={{}}>
+      <span className={\\"openapi-schema__container\\"}>
+        <strong className={\\"openapi-schema__property\\"}>oneOfProperty</strong>
+        <span className={\\"openapi-schema__name\\"}>object</span>
+      </span>
+    </summary>
+    <div style={{ marginLeft: \\"1rem\\" }}>
+      <div>
+        <span className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }}>
+          anyOf
+        </span>
+        <SchemaTabs>
+          <TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
+            <div style={{ marginTop: \\".5rem\\", marginBottom: \\".5rem\\" }}>
+              integer
+            </div>
+          </TabItem>
+          <TabItem label={\\"MOD2\\"} value={\\"1-item-properties\\"}>
+            <div style={{ marginTop: \\".5rem\\", marginBottom: \\".5rem\\" }}>
+              boolean
+            </div>
+          </TabItem>
+        </SchemaTabs>
+      </div>
+    </div>
+  </details>
+</SchemaItem>;
+",
+]
+`;
+
 exports[`createNodes discriminator should handle basic discriminator with mapping 1`] = `
 Array [
   "<div>

package/src/markdown/createCallbackMethodEndpoint.ts

@@ -0,0 +1,19 @@
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+
+import { create } from "./utils";
+
+export function createCallbackMethodEndpoint(method: String, path: String) {
+  return [
+    create("MethodEndpoint", {
+      method: method,
+      path: path,
+      context: "callback",
+    }),
+    "\n\n",
+  ];
+}

package/src/markdown/createCallbacks.ts

@@ -5,8 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
+import { createCallbackMethodEndpoint } from "./createCallbackMethodEndpoint";
 import { createDescription } from "./createDescription";
-import { createMethodEndpoint } from "./createMethodEndpoint";
 import { createRequestBodyDetails } from "./createRequestBodyDetails";
 import { createStatusCodes } from "./createStatusCodes";
 import { create } from "./utils";
@@ -78,7 +78,7 @@ export function createCallbacks({ callbacks }: Props) {
                 label: `${method.toUpperCase()} ${name}`,
                 value: `${method}-${name}`,
                 children: [
-                  createMethodEndpoint(method, path),
+                  createCallbackMethodEndpoint(method, path),
                   // TODO: add `deprecation notice` when markdown support is added
                   createDescription(description),
                   createRequestBodyDetails({

package/src/markdown/createMethodEndpoint.ts

@@ -8,5 +8,12 @@
 import { create } from "./utils";
 
 export function createMethodEndpoint(method: String, path: String) {
-  return [create("MethodEndpoint", { method: method, path: path }), "\n\n"];
+  return [
+    create("MethodEndpoint", {
+      method: method,
+      path: path,
+      context: "endpoint",
+    }),
+    "\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

@@ -104,6 +104,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;