docusaurus-plugin-openapi-docs 4.1.0 → 4.3.0

package/README.md

@@ -41,7 +41,7 @@ Key Features:
 
 | Docusaurus OpenAPI Docs | Docusaurus      |
 | ----------------------- | --------------- |
-| 4.0.x (current)         | `3.5.0 - 3.5.2` |
+| 4.0.x (current)         | `3.5.0 - 3.6.x` |
 | 3.0.x (end-of-support)  | `3.0.1 - 3.4.0` |
 | 2.2.3 (legacy)          | `2.4.1 - 2.4.3` |
 | 1.7.3 (end-of-support)  | `2.0.1 - 2.2.0` |
@@ -268,6 +268,16 @@ yarn docusaurus gen-api-docs petstore
 
 > The example above will only generate API docs relative to `petstore`.
 
+If you have multiple versions of the same API, `gen-api-docs` only generates the latest. To generate all versions, use the `--all-versions` flag.
+
+Example:
+
+```bash
+yarn docusaurus gen-api-docs all --all-versions
+```
+
+> This will generate API docs for all versions of all the OpenAPI specification (OAS) files referenced in your `docusaurus-plugin-openapi-docs` config.
+
 ### Cleaning API Docs
 
 To clean/remove all API Docs, run the following command from the root directory of your project:
@@ -290,6 +300,16 @@ yarn docusaurus clean-api-docs petstore
 
 > The example above will remove all API docs relative to `burgers`.
 
+If you have multiple versions of the same API, `clean-api-docs` only cleans the latest. To clean all versions, use the `--all-versions` flag.
+
+Example:
+
+```bash
+yarn docusaurus clean-api-docs all --all-versions
+```
+
+> This will clean API docs for all versions of all the OpenAPI specification (OAS) files referenced in your `docusaurus-plugin-openapi-docs` config.
+
 ### Versioning OpenAPI docs
 
 To generate _all_ versioned OpenAPI docs, run the following command from the root directory of your project:

package/lib/index.d.ts

@@ -1,5 +1,5 @@
 import type { LoadContext, Plugin } from "@docusaurus/types";
-import type { PluginOptions, LoadedContent } from "./types";
+import type { LoadedContent, PluginOptions } from "./types";
 export declare function isURL(str: string): boolean;
 export declare function getDocsPluginConfig(presetsPlugins: any[], plugin: string, pluginId: string): Object | undefined;
 declare function pluginOpenAPIDocs(context: LoadContext, options: PluginOptions): Plugin<LoadedContent>;

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
 ---
 
@@ -405,6 +409,52 @@ custom_edit_url: null
             });
         }
     }
+    async function generateAllVersions(options, pluginId) {
+        const parentOptions = Object.assign({}, options);
+        const { versions } = parentOptions;
+        if (versions != null && Object.keys(versions).length > 0) {
+            const version = parentOptions.version;
+            const label = parentOptions.label;
+            const baseUrl = parentOptions.baseUrl;
+            let parentVersion = {};
+            parentVersion[version] = { label: label, baseUrl: baseUrl };
+            const mergedVersions = Object.assign(parentVersion, versions);
+            // Prepare for merge
+            delete parentOptions.versions;
+            delete parentOptions.version;
+            delete parentOptions.label;
+            delete parentOptions.baseUrl;
+            delete parentOptions.downloadUrl;
+            await generateVersions(mergedVersions, parentOptions.outputDir);
+            Object.keys(versions).forEach(async (key) => {
+                if (key === "all") {
+                    console.error(chalk_1.default.red("Can't use id 'all' for OpenAPI docs versions configuration key."));
+                }
+                const versionOptions = versions[key];
+                const mergedOptions = {
+                    ...parentOptions,
+                    ...versionOptions,
+                };
+                await generateApiDocs(mergedOptions, pluginId);
+            });
+        }
+    }
+    async function cleanAllVersions(options) {
+        const parentOptions = Object.assign({}, options);
+        const { versions } = parentOptions;
+        delete parentOptions.versions;
+        if (versions != null && Object.keys(versions).length > 0) {
+            await cleanVersions(parentOptions.outputDir);
+            Object.keys(versions).forEach(async (key) => {
+                const versionOptions = versions[key];
+                const mergedOptions = {
+                    ...parentOptions,
+                    ...versionOptions,
+                };
+                await cleanApiDocs(mergedOptions);
+            });
+        }
+    }
     return {
         name: `docusaurus-plugin-openapi-docs`,
         extendCli(cli) {
@@ -414,10 +464,12 @@ custom_edit_url: null
                 .usage("<id>")
                 .arguments("<id>")
                 .option("-p, --plugin-id <plugin>", "OpenAPI docs plugin ID.")
+                .option("--all-versions", "Generate all versions.")
                 .action(async (id, instance) => {
                 var _a;
                 const options = instance.opts();
                 const pluginId = options.pluginId;
+                const allVersions = options.allVersions;
                 const pluginInstances = getPluginInstances(plugins);
                 let targetConfig;
                 let targetDocsPluginId;
@@ -446,6 +498,9 @@ custom_edit_url: null
                     else {
                         Object.keys(targetConfig).forEach(async function (key) {
                             await generateApiDocs(targetConfig[key], targetDocsPluginId);
+                            if (allVersions) {
+                                await generateAllVersions(targetConfig[key], targetDocsPluginId);
+                            }
                         });
                     }
                 }
@@ -454,6 +509,9 @@ custom_edit_url: null
                 }
                 else {
                     await generateApiDocs(targetConfig[id], targetDocsPluginId);
+                    if (allVersions) {
+                        await generateAllVersions(targetConfig[id], targetDocsPluginId);
+                    }
                 }
             });
             cli
@@ -538,10 +596,12 @@ custom_edit_url: null
                 .usage("<id>")
                 .arguments("<id>")
                 .option("-p, --plugin-id <plugin>", "OpenAPI docs plugin ID.")
+                .option("--all-versions", "Clean all versions.")
                 .action(async (id, instance) => {
                 var _a;
                 const options = instance.opts();
                 const pluginId = options.pluginId;
+                const allVersions = options.allVersions;
                 const pluginInstances = getPluginInstances(plugins);
                 let targetConfig;
                 if (pluginId) {
@@ -568,11 +628,17 @@ custom_edit_url: null
                     else {
                         Object.keys(targetConfig).forEach(async function (key) {
                             await cleanApiDocs(targetConfig[key]);
+                            if (allVersions) {
+                                await cleanAllVersions(targetConfig[key]);
+                            }
                         });
                     }
                 }
                 else {
                     await cleanApiDocs(targetConfig[id]);
+                    if (allVersions) {
+                        await cleanAllVersions(targetConfig[id]);
+                    }
                 }
             });
             cli

package/lib/markdown/createAuthentication.js

@@ -28,11 +28,11 @@ function createAuthentication(securitySchemes) {
                         (0, utils_1.create)("th", { children: `OAuth Flow (${flowType}):` }),
                         (0, utils_1.create)("td", {
                             children: [
-                                (0, utils_1.guard)(tokenUrl, () => (0, utils_1.create)("p", { children: `Token URL: ${tokenUrl}` })),
-                                (0, utils_1.guard)(authorizationUrl, () => (0, utils_1.create)("p", {
+                                (0, utils_1.guard)(tokenUrl, () => (0, utils_1.create)("div", { children: `Token URL: ${tokenUrl}` })),
+                                (0, utils_1.guard)(authorizationUrl, () => (0, utils_1.create)("div", {
                                     children: `Authorization URL: ${authorizationUrl}`,
                                 })),
-                                (0, utils_1.guard)(refreshUrl, () => (0, utils_1.create)("p", { children: `Refresh URL: ${refreshUrl}` })),
+                                (0, utils_1.guard)(refreshUrl, () => (0, utils_1.create)("div", { children: `Refresh URL: ${refreshUrl}` })),
                                 (0, utils_1.create)("span", { children: "Scopes:" }),
                                 (0, utils_1.create)("ul", {
                                     children: Object.entries(scopes).map(([scope, description]) => (0, utils_1.create)("li", { children: `${scope}: ${description}` })),

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/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,48 +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) => {
-                            var _a, _b, _c, _d, _e;
-                            return (0, utils_1.create)("ParamsItem", {
-                                className: "paramsItem",
-                                param: {
-                                    ...param,
-                                    enumDescriptions: Object.entries((_e = (_b = (_a = param === null || param === void 0 ? void 0 : param.schema) === null || _a === void 0 ? void 0 : _a["x-enumDescriptions"]) !== null && _b !== void 0 ? _b : (_d = (_c = param === null || param === void 0 ? void 0 : param.schema) === null || _c === void 0 ? void 0 : _c.items) === null || _d === void 0 ? void 0 : _d["x-enumDescriptions"]) !== null && _e !== void 0 ? _e : {}),
-                                },
-                            });
-                        }),
-                    }),
-                ],
-            }),
-        ],
-    });
+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.
  */