docusaurus-plugin-openapi-docs 4.1.0 → 4.2.0

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/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.
  */

package/lib/markdown/createSchema.js

@@ -10,6 +10,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createNodes = exports.mergeAllOf = void 0;
+// eslint-disable-next-line import/no-extraneous-dependencies
+const allof_merge_1 = require("allof-merge");
 const clsx_1 = __importDefault(require("clsx"));
 const isEmpty_1 = __importDefault(require("lodash/isEmpty"));
 const createArrayBracket_1 = require("./createArrayBracket");
@@ -18,37 +20,16 @@ const createDetails_1 = require("./createDetails");
 const createDetailsSummary_1 = require("./createDetailsSummary");
 const schema_1 = require("./schema");
 const utils_1 = require("./utils");
-const jsonSchemaMergeAllOf = require("json-schema-merge-allof");
 let SCHEMA_TYPE;
 /**
  * Returns a merged representation of allOf array of schemas.
  */
 function mergeAllOf(allOf) {
-    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;
-    }, []);
-    return { mergedSchemas, mergedRequired };
+    const onMergeError = (msg) => {
+        console.warn(msg);
+    };
+    const mergedSchemas = (0, allof_merge_1.merge)(allOf, { onMergeError });
+    return mergedSchemas;
 }
 exports.mergeAllOf = mergeAllOf;
 /**
@@ -211,7 +192,7 @@ function createAdditionalProperties(schema) {
  * For handling items.
  */
 function createItems(schema) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
     if (((_a = schema.items) === null || _a === void 0 ? void 0 : _a.properties) !== undefined) {
         return [
             (0, createArrayBracket_1.createOpeningArrayBracket)(),
@@ -235,7 +216,7 @@ function createItems(schema) {
     }
     if (((_e = schema.items) === null || _e === void 0 ? void 0 : _e.allOf) !== undefined) {
         // TODO: figure out if and how we should pass merged required array
-        const { mergedSchemas, } = mergeAllOf((_f = schema.items) === null || _f === void 0 ? void 0 : _f.allOf);
+        const mergedSchemas = mergeAllOf(schema.items);
         // Handles combo anyOf/oneOf + properties
         if ((mergedSchemas.oneOf !== undefined ||
             mergedSchemas.anyOf !== undefined) &&
@@ -265,11 +246,11 @@ function createItems(schema) {
             ].flat();
         }
     }
-    if (((_g = schema.items) === null || _g === void 0 ? void 0 : _g.type) === "string" ||
-        ((_h = schema.items) === null || _h === void 0 ? void 0 : _h.type) === "number" ||
-        ((_j = schema.items) === null || _j === void 0 ? void 0 : _j.type) === "integer" ||
-        ((_k = schema.items) === null || _k === void 0 ? void 0 : _k.type) === "boolean" ||
-        ((_l = schema.items) === null || _l === void 0 ? void 0 : _l.type) === "object") {
+    if (((_f = schema.items) === null || _f === void 0 ? void 0 : _f.type) === "string" ||
+        ((_g = schema.items) === null || _g === void 0 ? void 0 : _g.type) === "number" ||
+        ((_h = schema.items) === null || _h === void 0 ? void 0 : _h.type) === "integer" ||
+        ((_j = schema.items) === null || _j === void 0 ? void 0 : _j.type) === "boolean" ||
+        ((_k = schema.items) === null || _k === void 0 ? void 0 : _k.type) === "object") {
         return [
             (0, createArrayBracket_1.createOpeningArrayBracket)(),
             createNodes(schema.items, SCHEMA_TYPE),
@@ -510,7 +491,7 @@ function createPropertyDiscriminator(name, schemaName, schema, discriminator, re
  * Creates the edges or "leaves" of a schema tree. Edges can branch into sub-nodes with createDetails().
  */
 function createEdges({ name, schema, required, discriminator, }) {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _e;
     if (SCHEMA_TYPE === "request") {
         if (schema.readOnly && schema.readOnly === true) {
             return undefined;
@@ -541,45 +522,40 @@ function createEdges({ name, schema, required, discriminator, }) {
     if (((_b = schema.items) === null || _b === void 0 ? void 0 : _b.anyOf) !== undefined || ((_c = schema.items) === null || _c === void 0 ? void 0 : _c.oneOf) !== undefined) {
         return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
-    if (schema.allOf !== undefined) {
-        const { mergedSchemas } = mergeAllOf(schema.allOf);
-        delete schema.allOf;
-        const combinedSchemas = { ...schema, ...mergedSchemas };
+    if (((_d = schema.items) === null || _d === void 0 ? void 0 : _d.allOf) !== undefined) {
+        const mergedSchemas = mergeAllOf(schema.items);
         if (SCHEMA_TYPE === "request") {
-            if (combinedSchemas.readOnly && combinedSchemas.readOnly === true) {
+            if (mergedSchemas.readOnly && mergedSchemas.readOnly === true) {
                 return undefined;
             }
         }
         if (SCHEMA_TYPE === "response") {
-            if (combinedSchemas.writeOnly && combinedSchemas.writeOnly === true) {
+            if (mergedSchemas.writeOnly && mergedSchemas.writeOnly === true) {
                 return undefined;
             }
         }
-        const mergedSchemaName = (0, schema_1.getSchemaName)(combinedSchemas);
-        if (name === "eventName") {
-            console.log(mergedSchemaName, combinedSchemas);
-        }
-        if (combinedSchemas.oneOf !== undefined ||
-            combinedSchemas.anyOf !== undefined) {
-            return createDetailsNode(name, mergedSchemaName, combinedSchemas, required, combinedSchemas.nullable);
+        const mergedSchemaName = (0, schema_1.getSchemaName)(mergedSchemas);
+        if (mergedSchemas.oneOf !== undefined ||
+            mergedSchemas.anyOf !== undefined) {
+            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, mergedSchemas.nullable);
         }
-        if (combinedSchemas.properties !== undefined) {
-            return createDetailsNode(name, mergedSchemaName, combinedSchemas, required, combinedSchemas.nullable);
+        if (mergedSchemas.properties !== undefined) {
+            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, mergedSchemas.nullable);
         }
-        if (combinedSchemas.additionalProperties !== undefined) {
-            return createDetailsNode(name, mergedSchemaName, combinedSchemas, required, combinedSchemas.nullable);
+        if (mergedSchemas.additionalProperties !== undefined) {
+            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, mergedSchemas.nullable);
         }
         // array of objects
-        if (((_d = mergedSchemas.items) === null || _d === void 0 ? void 0 : _d.properties) !== undefined) {
-            return createDetailsNode(name, mergedSchemaName, combinedSchemas, required, combinedSchemas.nullable);
+        if (((_e = mergedSchemas.items) === null || _e === void 0 ? void 0 : _e.properties) !== undefined) {
+            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, mergedSchemas.nullable);
         }
         return (0, utils_1.create)("SchemaItem", {
             collapsible: false,
             name,
             required: Array.isArray(required) ? required.includes(name) : required,
             schemaName: mergedSchemaName,
-            qualifierMessage: (0, schema_1.getQualifierMessage)(combinedSchemas),
-            schema: combinedSchemas,
+            qualifierMessage: (0, schema_1.getQualifierMessage)(mergedSchemas),
+            schema: mergedSchemas,
         });
     }
     // primitives and array of non-objects
@@ -625,7 +601,7 @@ function createNodes(schema, schemaType) {
         nodes.push(createItems(schema));
     }
     if (schema.allOf !== undefined) {
-        const { mergedSchemas } = mergeAllOf(schema.allOf);
+        const mergedSchemas = mergeAllOf(schema);
         if (mergedSchemas.oneOf !== undefined ||
             mergedSchemas.anyOf !== undefined) {
             nodes.push(createAnyOneOf(mergedSchemas));

package/lib/markdown/createStatusCodes.d.ts

@@ -5,8 +5,5 @@ interface Props {
     label?: string;
     responses: ApiItem["responses"];
 }
-export declare function createResponseExamples(responseExamples: any, mimeType: string): string[];
-export declare function createResponseExample(responseExample: any, mimeType: string): string;
-export declare function createExampleFromSchema(schema: any, mimeType: string): string | undefined;
-export declare function createStatusCodes({ label, id, responses }: Props): string | undefined;
+export declare function createStatusCodes({ id, label, responses }: Props): string[];
 export {};