docusaurus-plugin-openapi-docs 4.0.1 → 4.2.0

package/README.md

@@ -172,6 +172,8 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
 | `markdownGenerators` | `object`  | `null`  | _Optional:_ Customize MDX content with a set of options for specifying markdown generator functions. See below for a list of supported options. |
 | `showSchemas`        | `boolean` | `null`  | _Optional:_ If set to `true`, generates schema pages and adds them to the sidebar.                                                              |
 
+### sidebarOptions
+
 `sidebarOptions` can be configured with the following options:
 
 | Name                 | Type      | Default | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
@@ -181,6 +183,7 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
 | `sidebarCollapsible` | `boolean` | `true`  | Whether sidebar categories are collapsible by default.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 | `sidebarCollapsed`   | `boolean` | `true`  | Whether sidebar categories are collapsed by default.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 | `customProps`        | `object`  | `null`  | Additional props for customizing a sidebar item.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| `sidebarGenerators`  | `object`  | `null`  | Optional: Customize sidebar rendering with callback functions.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
 > You may optionally configure a `sidebarOptions`. In doing so, an individual `sidebar.js` slice with the configured options will be generated within the respective `outputDir`.
 
@@ -206,6 +209,14 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
 | `createTagPageMD`    | `function` | `null`  | _Optional:_ Returns a string of the raw markdown body for tag pages.<br/><br/>**Function type:** `(pageData: TagPageMetadata) => string`       |
 | `createSchemaPageMD` | `function` | `null`  | _Optional:_ Returns a string of the raw markdown body for schema pages.<br/><br/>**Function type:** `(pageData: SchemaPageMetadata) => string` |
 
+### sidebarGenerators
+
+`sidebarGenerators` can be configured with the following options:
+
+| Name            | Type       | Default | Description                                                                                                                                                                                                                                      |
+| --------------- | ---------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `createDocItem` | `function` | `null`  | Optional: Returns a `SidebarItemDoc` object containing metadata for a sidebar item.<br/><br/>**Function type:** `(item: ApiPageMetadata \| SchemaPageMetadata, context: { sidebarOptions: SidebarOptions; basePath: string }) => SidebarItemDoc` |
+
 ## CLI Usage
 
 ```bash

package/lib/index.js

@@ -203,7 +203,11 @@ title: "{{{title}}}"
 description: "{{{frontMatter.description}}}"
 sidebar_label: "{{{title}}}"
 hide_title: true
+{{#schema}}
+hide_table_of_contents: true
+{{/schema}}
 schema: true
+sample: {{{frontMatter.sample}}}
 custom_edit_url: null
 ---
 

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/createContactInfo.js

@@ -32,7 +32,7 @@ function createContactInfo(contact) {
                 ],
             }),
             (0, utils_1.guard)(url, () => (0, utils_1.create)("span", {
-                children: ["URL: ", `[${url}](mailto:${url})`],
+                children: ["URL: ", `[${url}](${url})`],
             })),
         ],
     });

package/lib/markdown/createDeprecationNotice.js

@@ -12,11 +12,10 @@ function createAdmonition({ children }) {
     return `:::caution deprecated\n\n${(0, utils_1.render)(children)}\n\n:::`;
 }
 function createDeprecationNotice({ deprecated, description, }) {
-    return (0, utils_1.guard)(deprecated, () => {
-        var _a;
-        return createAdmonition({
-            children: (_a = (0, utils_1.clean)(description)) !== null && _a !== void 0 ? _a : "This endpoint has been deprecated and may be replaced or removed in future versions of the API.",
-        });
-    });
+    return (0, utils_1.guard)(deprecated, () => createAdmonition({
+        children: description && description.length > 0
+            ? (0, utils_1.clean)(description)
+            : "This endpoint has been deprecated and may be replaced or removed in future versions of the API.",
+    }));
 }
 exports.createDeprecationNotice = createDeprecationNotice;

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/createParamsDetails.d.ts

@@ -1,7 +1,6 @@
 import { ApiItem } from "../types";
 interface Props {
     parameters: ApiItem["parameters"];
-    type: "path" | "query" | "header" | "cookie";
 }
-export declare function createParamsDetails({ parameters, type }: Props): string | undefined;
+export declare function createParamsDetails({ parameters }: Props): string[];
 export {};

package/lib/markdown/createParamsDetails.js

@@ -7,42 +7,13 @@
  * ========================================================================== */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createParamsDetails = void 0;
-const createDetails_1 = require("./createDetails");
-const createDetailsSummary_1 = require("./createDetailsSummary");
 const utils_1 = require("./utils");
-function createParamsDetails({ parameters, type }) {
-    if (parameters === undefined) {
-        return undefined;
-    }
-    const params = parameters.filter((param) => (param === null || param === void 0 ? void 0 : param.in) === type);
-    if (params.length === 0) {
-        return undefined;
-    }
-    return (0, createDetails_1.createDetails)({
-        className: "openapi-markdown__details",
-        "data-collapsed": false,
-        open: true,
-        style: { marginBottom: "1rem" },
-        children: [
-            (0, createDetailsSummary_1.createDetailsSummary)({
-                children: [
-                    (0, utils_1.create)("h3", {
-                        className: "openapi-markdown__details-summary-header-params",
-                        children: `${type.charAt(0).toUpperCase() + type.slice(1)} Parameters`,
-                    }),
-                ],
-            }),
-            (0, utils_1.create)("div", {
-                children: [
-                    (0, utils_1.create)("ul", {
-                        children: params.map((param) => (0, utils_1.create)("ParamsItem", {
-                            className: "paramsItem",
-                            param: param,
-                        })),
-                    }),
-                ],
-            }),
-        ],
-    });
+function createParamsDetails({ parameters }) {
+    return [
+        (0, utils_1.create)("ParamsDetails", {
+            parameters: parameters,
+        }),
+        "\n\n",
+    ];
 }
 exports.createParamsDetails = createParamsDetails;

package/lib/markdown/createRequestBodyDetails.d.ts

@@ -9,5 +9,5 @@ interface Props {
         required?: boolean;
     };
 }
-export declare function createRequestBodyDetails({ title, body }: Props): string | undefined;
+export declare function createRequestBodyDetails({ title, body }: Props): string[];
 export {};

package/lib/markdown/createRequestSchema.d.ts

@@ -10,5 +10,5 @@ interface Props {
         required?: string[] | boolean;
     };
 }
-export declare function createRequestSchema({ title, body, ...rest }: Props): string | undefined;
+export declare function createRequestSchema({ title, body, ...rest }: Props): string[];
 export {};

package/lib/markdown/createRequestSchema.js

@@ -7,139 +7,15 @@
  * ========================================================================== */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createRequestSchema = void 0;
-const createDescription_1 = require("./createDescription");
-const createDetails_1 = require("./createDetails");
-const createDetailsSummary_1 = require("./createDetailsSummary");
-const createSchema_1 = require("./createSchema");
 const utils_1 = require("./utils");
 function createRequestSchema({ title, body, ...rest }) {
-    var _a;
-    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 (0, utils_1.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 (0, utils_1.create)("TabItem", {
-                    label: mimeType,
-                    value: `${mimeType}`,
-                    children: [
-                        (0, createDetails_1.createDetails)({
-                            className: "openapi-markdown__details mime",
-                            "data-collapsed": false,
-                            open: true,
-                            ...rest,
-                            children: [
-                                (0, createDetailsSummary_1.createDetailsSummary)({
-                                    className: "openapi-markdown__details-summary-mime",
-                                    children: [
-                                        (0, utils_1.create)("h3", {
-                                            className: "openapi-markdown__details-summary-header-body",
-                                            children: `${title}`,
-                                        }),
-                                        (0, utils_1.guard)(body.required && body.required === true, () => [
-                                            (0, utils_1.create)("span", {
-                                                className: "openapi-schema__required",
-                                                children: "required",
-                                            }),
-                                        ]),
-                                    ],
-                                }),
-                                (0, utils_1.create)("div", {
-                                    style: { textAlign: "left", marginLeft: "1rem" },
-                                    children: [
-                                        (0, utils_1.guard)(body.description, () => [
-                                            (0, utils_1.create)("div", {
-                                                style: { marginTop: "1rem", marginBottom: "1rem" },
-                                                children: (0, createDescription_1.createDescription)(body.description),
-                                            }),
-                                        ]),
-                                    ],
-                                }),
-                                (0, utils_1.create)("ul", {
-                                    style: { marginLeft: "1rem" },
-                                    children: (0, createSchema_1.createNodes)(firstBody, "request"),
-                                }),
-                            ],
-                        }),
-                    ],
-                });
-            }),
-        });
-    }
-    const randomFirstKey = Object.keys(body.content)[0];
-    const firstBody = (_a = body.content[randomFirstKey].schema) !== null && _a !== void 0 ? _a : body.content[randomFirstKey];
-    if (firstBody === undefined) {
-        return undefined;
-    }
-    return (0, utils_1.create)("MimeTabs", {
-        className: "openapi-tabs__mime",
-        children: [
-            (0, utils_1.create)("TabItem", {
-                label: randomFirstKey,
-                value: `${randomFirstKey}-schema`,
-                children: [
-                    (0, createDetails_1.createDetails)({
-                        className: "openapi-markdown__details mime",
-                        "data-collapsed": false,
-                        open: true,
-                        ...rest,
-                        children: [
-                            (0, createDetailsSummary_1.createDetailsSummary)({
-                                className: "openapi-markdown__details-summary-mime",
-                                children: [
-                                    (0, utils_1.create)("h3", {
-                                        className: "openapi-markdown__details-summary-header-body",
-                                        children: `${title}`,
-                                    }),
-                                    (0, utils_1.guard)(firstBody.type === "array", (format) => (0, utils_1.create)("span", {
-                                        style: { opacity: "0.6" },
-                                        children: ` array`,
-                                    })),
-                                    (0, utils_1.guard)(body.required, () => [
-                                        (0, utils_1.create)("strong", {
-                                            className: "openapi-schema__required",
-                                            children: "required",
-                                        }),
-                                    ]),
-                                ],
-                            }),
-                            (0, utils_1.create)("div", {
-                                style: { textAlign: "left", marginLeft: "1rem" },
-                                children: [
-                                    (0, utils_1.guard)(body.description, () => [
-                                        (0, utils_1.create)("div", {
-                                            style: { marginTop: "1rem", marginBottom: "1rem" },
-                                            children: (0, createDescription_1.createDescription)(body.description),
-                                        }),
-                                    ]),
-                                ],
-                            }),
-                            (0, utils_1.create)("ul", {
-                                style: { marginLeft: "1rem" },
-                                children: (0, createSchema_1.createNodes)(firstBody, "request"),
-                            }),
-                        ],
-                    }),
-                ],
-            }),
-        ],
-    });
+    return [
+        (0, utils_1.create)("RequestSchema", {
+            title: title,
+            body: body,
+            ...rest,
+        }),
+        "\n\n",
+    ];
 }
 exports.createRequestSchema = createRequestSchema;

package/lib/markdown/createResponseSchema.d.ts

@@ -10,5 +10,5 @@ interface Props {
         required?: string[] | boolean;
     };
 }
-export declare function createResponseSchema({ title, body, ...rest }: Props): string | undefined;
+export declare function createResponseSchema({ title, body, ...rest }: Props): string[];
 export {};

package/lib/markdown/createResponseSchema.js

@@ -7,101 +7,15 @@
  * ========================================================================== */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createResponseSchema = void 0;
-const createDescription_1 = require("./createDescription");
-const createDetails_1 = require("./createDetails");
-const createDetailsSummary_1 = require("./createDetailsSummary");
-const createSchema_1 = require("./createSchema");
-const createStatusCodes_1 = require("./createStatusCodes");
 const utils_1 = require("./utils");
 function createResponseSchema({ title, body, ...rest }) {
-    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 (0, utils_1.create)("MimeTabs", {
-            className: "openapi-tabs__mime",
-            schemaType: "response",
-            children: mimeTypes.map((mimeType) => {
-                var _a;
-                const responseExamples = body.content[mimeType].examples;
-                const responseExample = body.content[mimeType].example;
-                const firstBody = (_a = body.content[mimeType].schema) !== null && _a !== void 0 ? _a : body.content[mimeType];
-                if (firstBody === undefined &&
-                    responseExample === undefined &&
-                    responseExamples === undefined) {
-                    return undefined;
-                }
-                return (0, utils_1.create)("TabItem", {
-                    label: `${mimeType}`,
-                    value: `${mimeType}`,
-                    children: [
-                        (0, utils_1.create)("SchemaTabs", {
-                            className: "openapi-tabs__schema",
-                            // TODO: determine if we should persist this
-                            // groupId: "schema-tabs",
-                            children: [
-                                firstBody &&
-                                    (0, utils_1.create)("TabItem", {
-                                        label: `${title}`,
-                                        value: `${title}`,
-                                        children: [
-                                            (0, createDetails_1.createDetails)({
-                                                className: "openapi-markdown__details response",
-                                                "data-collapsed": false,
-                                                open: true,
-                                                ...rest,
-                                                children: [
-                                                    (0, createDetailsSummary_1.createDetailsSummary)({
-                                                        className: "openapi-markdown__details-summary-response",
-                                                        children: [
-                                                            (0, utils_1.create)("strong", { children: `${title}` }),
-                                                            (0, utils_1.guard)(body.required && body.required === true, () => [
-                                                                (0, utils_1.create)("span", {
-                                                                    className: "openapi-schema__required",
-                                                                    children: "required",
-                                                                }),
-                                                            ]),
-                                                        ],
-                                                    }),
-                                                    (0, utils_1.create)("div", {
-                                                        style: { textAlign: "left", marginLeft: "1rem" },
-                                                        children: [
-                                                            (0, utils_1.guard)(body.description, () => [
-                                                                (0, utils_1.create)("div", {
-                                                                    style: {
-                                                                        marginTop: "1rem",
-                                                                        marginBottom: "1rem",
-                                                                    },
-                                                                    children: (0, createDescription_1.createDescription)(body.description),
-                                                                }),
-                                                            ]),
-                                                        ],
-                                                    }),
-                                                    (0, utils_1.create)("ul", {
-                                                        style: { marginLeft: "1rem" },
-                                                        children: (0, createSchema_1.createNodes)(firstBody, "response"),
-                                                    }),
-                                                ],
-                                            }),
-                                        ],
-                                    }),
-                                firstBody && (0, createStatusCodes_1.createExampleFromSchema)(firstBody, mimeType),
-                                responseExamples &&
-                                    (0, createStatusCodes_1.createResponseExamples)(responseExamples, mimeType),
-                                responseExample &&
-                                    (0, createStatusCodes_1.createResponseExample)(responseExample, mimeType),
-                            ],
-                        }),
-                    ],
-                });
-            }),
-        });
-    }
-    return undefined;
+    return [
+        (0, utils_1.create)("ResponseSchema", {
+            title: title,
+            body: body,
+            ...rest,
+        }),
+        "\n\n",
+    ];
 }
 exports.createResponseSchema = createResponseSchema;

package/lib/markdown/createSchema.d.ts

@@ -2,10 +2,7 @@ import { SchemaObject } from "../openapi/types";
 /**
  * Returns a merged representation of allOf array of schemas.
  */
-export declare function mergeAllOf(allOf: SchemaObject[]): {
-    mergedSchemas: any;
-    mergedRequired: any;
-};
+export declare function mergeAllOf(allOf: SchemaObject): SchemaObject;
 /**
  * Creates a hierarchical level of a schema tree. Nodes produce edges that can branch into sub-nodes with edges, recursively.
  */