docusaurus-plugin-openapi-docs 1.1.4 → 1.1.7

package/lib/markdown/createSchemaDetails.js

@@ -192,7 +192,8 @@ function createItems(schema) {
         return createAnyOneOf(schema.items);
     }
     if (((_e = schema.items) === null || _e === void 0 ? void 0 : _e.allOf) !== undefined) {
-        const { mergedSchemas } = mergeAllOf((_f = schema.items) === null || _f === void 0 ? void 0 : _f.allOf);
+        // 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);
         // Handles combo anyOf/oneOf + properties
         if ((mergedSchemas.oneOf !== undefined ||
             mergedSchemas.anyOf !== undefined) &&
@@ -331,7 +332,7 @@ function createDetailsNode(name, schemaName, schema, required) {
                                 style: { opacity: "0.6" },
                                 children: ` ${schemaName}`,
                             }),
-                            (0, utils_1.guard)(required, () => [
+                            (0, utils_1.guard)(schema.required && schema.required === true, () => [
                                 (0, utils_1.create)("strong", {
                                     style: {
                                         fontSize: "var(--ifm-code-font-size)",
@@ -427,6 +428,7 @@ function createPropertyDiscriminator(name, schemaName, schema, discriminator, re
 function createEdges({ name, schema, required, discriminator, }) {
     var _a, _b;
     const schemaName = (0, schema_1.getSchemaName)(schema);
+    // if (name === "id") console.log(name, schema, required);
     if (discriminator !== undefined && discriminator.propertyName === name) {
         return createPropertyDiscriminator(name, "string", schema, discriminator, required);
     }
@@ -453,7 +455,7 @@ function createEdges({ name, schema, required, discriminator, }) {
         return (0, utils_1.create)("SchemaItem", {
             collapsible: false,
             name,
-            required,
+            required: Array.isArray(required) ? required.includes(name) : required,
             schemaDescription: mergedSchemas.description,
             schemaName: schemaName,
             qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
@@ -474,7 +476,7 @@ function createEdges({ name, schema, required, discriminator, }) {
     return (0, utils_1.create)("SchemaItem", {
         collapsible: false,
         name,
-        required,
+        required: Array.isArray(required) ? required.includes(name) : required,
         schemaDescription: schema.description,
         schemaName: schemaName,
         qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
@@ -541,8 +543,71 @@ function createSchemaDetails({ title, body, ...rest }) {
         Object.keys(body.content).length === 0) {
         return undefined;
     }
-    // NOTE: We just pick a random content-type.
-    // How common is it to have multiple?
+    // Get all MIME types, including vendor-specific
+    const mimeTypes = Object.keys(body.content);
+    if (mimeTypes && mimeTypes.length > 1) {
+        return (0, utils_1.create)("MimeTabs", {
+            groupId: "mime-type",
+            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)({
+                            "data-collapsed": false,
+                            open: true,
+                            ...rest,
+                            children: [
+                                (0, createDetailsSummary_1.createDetailsSummary)({
+                                    style: { textAlign: "left" },
+                                    children: [
+                                        (0, utils_1.create)("strong", { 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 && body.required === true, () => [
+                                            (0, utils_1.create)("strong", {
+                                                style: {
+                                                    fontSize: "var(--ifm-code-font-size)",
+                                                    color: "var(--openapi-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: createNodes(firstBody),
+                                }),
+                            ],
+                        }),
+                    ],
+                });
+            }),
+        });
+    }
     const randomFirstKey = Object.keys(body.content)[0];
     const firstBody = body.content[randomFirstKey].schema;
     if (firstBody === undefined) {
@@ -554,46 +619,55 @@ function createSchemaDetails({ title, body, ...rest }) {
             return undefined;
         }
     }
-    // Root-level schema dropdown
-    return (0, createDetails_1.createDetails)({
-        "data-collapsed": false,
-        open: true,
-        ...rest,
+    return (0, utils_1.create)("MimeTabs", {
         children: [
-            (0, createDetailsSummary_1.createDetailsSummary)({
-                style: { textAlign: "left" },
+            (0, utils_1.create)("TabItem", {
+                label: randomFirstKey,
+                value: `${randomFirstKey}-schema`,
                 children: [
-                    (0, utils_1.create)("strong", { 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", {
-                            style: {
-                                fontSize: "var(--ifm-code-font-size)",
-                                color: "var(--openapi-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, createDetails_1.createDetails)({
+                        "data-collapsed": false,
+                        open: true,
+                        ...rest,
+                        children: [
+                            (0, createDetailsSummary_1.createDetailsSummary)({
+                                style: { textAlign: "left" },
+                                children: [
+                                    (0, utils_1.create)("strong", { 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", {
+                                            style: {
+                                                fontSize: "var(--ifm-code-font-size)",
+                                                color: "var(--openapi-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: createNodes(firstBody),
+                            }),
+                        ],
+                    }),
                 ],
             }),
-            (0, utils_1.create)("ul", {
-                style: { marginLeft: "1rem" },
-                children: createNodes(firstBody),
-            }),
         ],
     });
 }

package/lib/markdown/createStatusCodes.d.ts

@@ -2,5 +2,7 @@ import { ApiItem } from "../types";
 interface Props {
     responses: ApiItem["responses"];
 }
+export declare function createResponseExamples(responseExamples: any): string[];
+export declare function createResponseExample(responseExample: any): string;
 export declare function createStatusCodes({ responses }: Props): string | undefined;
 export {};

package/lib/markdown/createStatusCodes.js

@@ -6,11 +6,11 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createStatusCodes = void 0;
+exports.createStatusCodes = exports.createResponseExample = exports.createResponseExamples = void 0;
 const createDescription_1 = require("./createDescription");
 const createDetails_1 = require("./createDetails");
 const createDetailsSummary_1 = require("./createDetailsSummary");
-const createSchemaDetails_1 = require("./createSchemaDetails");
+const createResponseSchema_1 = require("./createResponseSchema");
 const utils_1 = require("./utils");
 const utils_2 = require("./utils");
 function createResponseHeaders(responseHeaders) {
@@ -57,17 +57,52 @@ function createResponseExamples(responseExamples) {
     return Object.entries(responseExamples).map(([exampleName, exampleValue]) => {
         const camelToSpaceName = exampleName.replace(/([A-Z])/g, " $1");
         let finalFormattedName = camelToSpaceName.charAt(0).toUpperCase() + camelToSpaceName.slice(1);
+        if (typeof exampleValue.value === "object") {
+            return (0, utils_1.create)("TabItem", {
+                label: `${finalFormattedName}`,
+                value: `${finalFormattedName}`,
+                children: [
+                    (0, utils_1.create)("ResponseSamples", {
+                        responseExample: JSON.stringify(exampleValue.value, null, 2),
+                    }),
+                ],
+            });
+        }
         return (0, utils_1.create)("TabItem", {
             label: `${finalFormattedName}`,
             value: `${finalFormattedName}`,
             children: [
                 (0, utils_1.create)("ResponseSamples", {
-                    responseExample: JSON.stringify(exampleValue.value, null, 2),
+                    responseExample: exampleValue.value,
                 }),
             ],
         });
     });
 }
+exports.createResponseExamples = createResponseExamples;
+function createResponseExample(responseExample) {
+    if (typeof responseExample === "object") {
+        return (0, utils_1.create)("TabItem", {
+            label: `Example`,
+            value: `Example`,
+            children: [
+                (0, utils_1.create)("ResponseSamples", {
+                    responseExample: JSON.stringify(responseExample, null, 2),
+                }),
+            ],
+        });
+    }
+    return (0, utils_1.create)("TabItem", {
+        label: `Example`,
+        value: `Example`,
+        children: [
+            (0, utils_1.create)("ResponseSamples", {
+                responseExample: responseExample,
+            }),
+        ],
+    });
+}
+exports.createResponseExample = createResponseExample;
 function createStatusCodes({ responses }) {
     if (responses === undefined) {
         return undefined;
@@ -79,11 +114,10 @@ function createStatusCodes({ responses }) {
     return (0, utils_1.create)("div", {
         children: [
             (0, utils_1.create)("ApiTabs", {
+                // TODO: determine if we should persist status code selection
+                // groupId: "api-tabs",
                 children: codes.map((code) => {
                     const responseHeaders = responses[code].headers;
-                    const responseContent = responses[code].content;
-                    const responseContentKey = responseContent && Object.keys(responseContent)[0];
-                    const responseExamples = responseContentKey && responseContent[responseContentKey].examples;
                     return (0, utils_1.create)("TabItem", {
                         label: code,
                         value: code,
@@ -91,62 +125,30 @@ function createStatusCodes({ responses }) {
                             (0, utils_1.create)("div", {
                                 children: (0, createDescription_1.createDescription)(responses[code].description),
                             }),
-                            (0, utils_2.guard)(responseExamples, () => (0, utils_1.create)("SchemaTabs", {
-                                children: [
-                                    (0, utils_1.create)("TabTtem", {
-                                        label: "Schema",
-                                        value: "Schema",
-                                        children: [
-                                            responseHeaders &&
-                                                (0, createDetails_1.createDetails)({
-                                                    "data-collaposed": false,
-                                                    open: true,
-                                                    style: { textAlign: "left" },
-                                                    children: [
-                                                        (0, createDetailsSummary_1.createDetailsSummary)({
-                                                            children: [
-                                                                (0, utils_1.create)("strong", {
-                                                                    children: "Response Headers",
-                                                                }),
-                                                            ],
-                                                        }),
-                                                        createResponseHeaders(responseHeaders),
-                                                    ],
-                                                }),
-                                            (0, utils_1.create)("div", {
-                                                children: (0, createSchemaDetails_1.createSchemaDetails)({
-                                                    title: "Schema",
-                                                    body: {
-                                                        content: responses[code].content,
-                                                    },
+                            responseHeaders &&
+                                (0, createDetails_1.createDetails)({
+                                    "data-collaposed": false,
+                                    open: true,
+                                    style: { textAlign: "left", marginBottom: "1rem" },
+                                    children: [
+                                        (0, createDetailsSummary_1.createDetailsSummary)({
+                                            children: [
+                                                (0, utils_1.create)("strong", {
+                                                    children: "Response Headers",
                                                 }),
-                                            }),
-                                        ],
-                                    }),
-                                    createResponseExamples(responseExamples),
-                                ],
-                            })),
-                            (0, utils_2.guard)(responseHeaders, () => (0, createDetails_1.createDetails)({
-                                "data-collaposed": false,
-                                open: true,
-                                style: { textAlign: "left" },
-                                children: [
-                                    (0, createDetailsSummary_1.createDetailsSummary)({
-                                        children: [
-                                            (0, utils_1.create)("strong", { children: "Response Headers" }),
-                                        ],
-                                    }),
-                                    createResponseHeaders(responseHeaders),
-                                ],
-                            })),
-                            (0, utils_2.guard)(!responseExamples, () => (0, utils_1.create)("div", {
-                                children: (0, createSchemaDetails_1.createSchemaDetails)({
+                                            ],
+                                        }),
+                                        createResponseHeaders(responseHeaders),
+                                    ],
+                                }),
+                            (0, utils_1.create)("div", {
+                                children: (0, createResponseSchema_1.createResponseSchema)({
                                     title: "Schema",
                                     body: {
                                         content: responses[code].content,
                                     },
                                 }),
-                            })),
+                            }),
                         ],
                     });
                 }),

package/lib/markdown/index.js

@@ -23,6 +23,7 @@ const utils_1 = require("./utils");
 function createApiPageMD({ title, api: { deprecated, "x-deprecated-description": deprecatedDescription, description, parameters, requestBody, responses, }, }) {
     return (0, utils_1.render)([
         `import ApiTabs from "@theme/ApiTabs";\n`,
+        `import MimeTabs from "@theme/MimeTabs";\n`,
         `import ParamsItem from "@theme/ParamsItem";\n`,
         `import ResponseSamples from "@theme/ResponseSamples";\n`,
         `import SchemaItem from "@theme/SchemaItem"\n`,
@@ -36,7 +37,10 @@ function createApiPageMD({ title, api: { deprecated, "x-deprecated-description":
         (0, createParamsDetails_1.createParamsDetails)({ parameters, type: "query" }),
         (0, createParamsDetails_1.createParamsDetails)({ parameters, type: "header" }),
         (0, createParamsDetails_1.createParamsDetails)({ parameters, type: "cookie" }),
-        (0, createRequestBodyDetails_1.createRequestBodyDetails)({ title: "Request Body", body: requestBody }),
+        (0, createRequestBodyDetails_1.createRequestBodyDetails)({
+            title: "Request Body",
+            body: requestBody,
+        }),
         (0, createStatusCodes_1.createStatusCodes)({ responses }),
     ]);
 }

package/lib/openapi/createExample.js

@@ -11,11 +11,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sampleFromSchema = void 0;
 const chalk_1 = __importDefault(require("chalk"));
+const createRequestSchema_1 = require("../markdown/createRequestSchema");
 const primitives = {
     string: {
         default: () => "string",
         email: () => "user@example.com",
         date: () => new Date().toISOString().substring(0, 10),
+        "date-time": () => new Date().toISOString().substring(0, 10),
         uuid: () => "3fa85f64-5717-4562-b3fc-2c963f66afa6",
         hostname: () => "example.com",
         ipv4: () => "198.51.100.42",
@@ -41,21 +43,15 @@ const sampleFromSchema = (schema = {}) => {
             return example;
         }
         if (allOf) {
-            // TODO: We are just assuming it will always be an object for now
-            let obj = {
-                type: "object",
-                properties: {},
-                required: [], // NOTE: We shouldn't need to worry about required
-            };
-            for (let item of allOf) {
-                if (item.properties) {
-                    obj.properties = {
-                        ...obj.properties,
-                        ...item.properties,
-                    };
+            const { mergedSchemas } = (0, createRequestSchema_1.mergeAllOf)(allOf);
+            if (mergedSchemas.properties) {
+                for (const [key, value] of Object.entries(mergedSchemas.properties)) {
+                    if (value.readOnly && value.readOnly === true) {
+                        delete mergedSchemas.properties[key];
+                    }
                 }
             }
-            return (0, exports.sampleFromSchema)(obj);
+            return (0, exports.sampleFromSchema)(mergedSchemas);
         }
         if (!type) {
             if (properties) {
@@ -71,6 +67,20 @@ const sampleFromSchema = (schema = {}) => {
         if (type === "object") {
             let obj = {};
             for (let [name, prop] of Object.entries(properties !== null && properties !== void 0 ? properties : {})) {
+                if (prop.properties) {
+                    for (const [key, value] of Object.entries(prop.properties)) {
+                        if (value.readOnly && value.readOnly === true) {
+                            delete prop.properties[key];
+                        }
+                    }
+                }
+                if (prop.items && prop.items.properties) {
+                    for (const [key, value] of Object.entries(prop.items.properties)) {
+                        if (value.readOnly && value.readOnly === true) {
+                            delete prop.items.properties[key];
+                        }
+                    }
+                }
                 if (prop.deprecated) {
                     continue;
                 }
@@ -93,6 +103,9 @@ const sampleFromSchema = (schema = {}) => {
             }
             return normalizeArray(schema.enum)[0];
         }
+        if (schema.readOnly && schema.readOnly === true) {
+            return undefined;
+        }
         return primitive(schema);
     }
     catch (err) {
@@ -106,7 +119,7 @@ function primitive(schema = {}) {
     if (type === undefined) {
         return;
     }
-    let fn = primitives[type].default;
+    let fn = schema.default ? () => schema.default : primitives[type].default;
     if (format !== undefined) {
         fn = primitives[type][format] || fn;
     }

package/lib/openapi/openapi.d.ts

@@ -6,7 +6,7 @@ interface OpenApiFiles {
     data: OpenApiObject;
 }
 export declare function readOpenapiFiles(openapiPath: string, options: APIOptions): Promise<OpenApiFiles[]>;
-export declare function processOpenapiFiles(files: OpenApiFiles[], sidebarOptions: SidebarOptions): Promise<[ApiMetadata[], TagObject[]]>;
+export declare function processOpenapiFiles(files: OpenApiFiles[], sidebarOptions: SidebarOptions): Promise<[ApiMetadata[], TagObject[][]]>;
 export declare function processOpenapiFile(openapiData: OpenApiObject, sidebarOptions: SidebarOptions): Promise<[ApiMetadata[], TagObject[]]>;
 export declare function getTagDisplayName(tagName: string, tags: TagObject[]): string;
 export {};

package/lib/openapi/openapi.js

@@ -59,7 +59,7 @@ async function createPostmanCollection(openapiData) {
     return await jsonToCollection(data);
 }
 function createItems(openapiData, sidebarOptions) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
     // TODO: Find a better way to handle this
     let items = [];
     const infoId = (0, kebabCase_1.default)(openapiData.info.title);
@@ -100,8 +100,8 @@ function createItems(openapiData, sidebarOptions) {
             securitySchemes: (_b = openapiData.components) === null || _b === void 0 ? void 0 : _b.securitySchemes,
             info: {
                 ...openapiData.info,
-                tags: (_c = openapiData.tags) === null || _c === void 0 ? void 0 : _c.map((tagName) => { var _a; return getTagDisplayName(tagName.name, (_a = openapiData.tags) !== null && _a !== void 0 ? _a : []); }),
-                title: (_d = openapiData.info.title) !== null && _d !== void 0 ? _d : "Introduction",
+                tags: openapiData.tags,
+                title: (_c = openapiData.info.title) !== null && _c !== void 0 ? _c : "Introduction",
                 logo: openapiData.info["x-logo"],
                 darkLogo: openapiData.info["x-dark-logo"],
             },
@@ -111,18 +111,18 @@ function createItems(openapiData, sidebarOptions) {
     for (let [path, pathObject] of Object.entries(openapiData.paths)) {
         const { $ref, description, parameters, servers, summary, ...rest } = pathObject;
         for (let [method, operationObject] of Object.entries({ ...rest })) {
-            const title = (_f = (_e = operationObject.summary) !== null && _e !== void 0 ? _e : operationObject.operationId) !== null && _f !== void 0 ? _f : "Missing summary";
+            const title = (_e = (_d = operationObject.summary) !== null && _d !== void 0 ? _d : operationObject.operationId) !== null && _e !== void 0 ? _e : "Missing summary";
             if (operationObject.description === undefined) {
                 operationObject.description =
-                    (_h = (_g = operationObject.summary) !== null && _g !== void 0 ? _g : operationObject.operationId) !== null && _h !== void 0 ? _h : "";
+                    (_g = (_f = operationObject.summary) !== null && _f !== void 0 ? _f : operationObject.operationId) !== null && _g !== void 0 ? _g : "";
             }
             const baseId = operationObject.operationId
                 ? (0, kebabCase_1.default)(operationObject.operationId)
                 : (0, kebabCase_1.default)(operationObject.summary);
-            const servers = (_k = (_j = operationObject.servers) !== null && _j !== void 0 ? _j : pathObject.servers) !== null && _k !== void 0 ? _k : openapiData.servers;
-            const security = (_l = operationObject.security) !== null && _l !== void 0 ? _l : openapiData.security;
+            const servers = (_j = (_h = operationObject.servers) !== null && _h !== void 0 ? _h : pathObject.servers) !== null && _j !== void 0 ? _j : openapiData.servers;
+            const security = (_k = operationObject.security) !== null && _k !== void 0 ? _k : openapiData.security;
             // Add security schemes so we know how to handle security.
-            const securitySchemes = (_m = openapiData.components) === null || _m === void 0 ? void 0 : _m.securitySchemes;
+            const securitySchemes = (_l = openapiData.components) === null || _l === void 0 ? void 0 : _l.securitySchemes;
             // Make sure schemes are lowercase. See: https://github.com/cloud-annotations/docusaurus-plugin-openapi/issues/79
             if (securitySchemes) {
                 for (let securityScheme of Object.values(securitySchemes)) {
@@ -132,10 +132,21 @@ function createItems(openapiData, sidebarOptions) {
                 }
             }
             let jsonRequestBodyExample;
-            const body = (_p = (_o = operationObject.requestBody) === null || _o === void 0 ? void 0 : _o.content) === null || _p === void 0 ? void 0 : _p["application/json"];
+            const body = (_o = (_m = operationObject.requestBody) === null || _m === void 0 ? void 0 : _m.content) === null || _o === void 0 ? void 0 : _o["application/json"];
             if (body === null || body === void 0 ? void 0 : body.schema) {
                 jsonRequestBodyExample = (0, createExample_1.sampleFromSchema)(body.schema);
             }
+            // Handle vendor JSON media types
+            const bodyContent = (_p = operationObject.requestBody) === null || _p === void 0 ? void 0 : _p.content;
+            if (bodyContent) {
+                const firstBodyContentKey = Object.keys(bodyContent)[0];
+                if (firstBodyContentKey.endsWith("+json")) {
+                    const firstBody = bodyContent[firstBodyContentKey];
+                    if (firstBody === null || firstBody === void 0 ? void 0 : firstBody.schema) {
+                        jsonRequestBodyExample = (0, createExample_1.sampleFromSchema)(firstBody.schema);
+                    }
+                }
+            }
             // TODO: Don't include summary temporarilly
             const { summary, ...defaults } = operationObject;
             const apiPage = {
@@ -148,7 +159,7 @@ function createItems(openapiData, sidebarOptions) {
                 frontMatter: {},
                 api: {
                     ...defaults,
-                    tags: (_q = operationObject.tags) === null || _q === void 0 ? void 0 : _q.map((tagName) => { var _a; return getTagDisplayName(tagName, (_a = openapiData.tags) !== null && _a !== void 0 ? _a : []); }),
+                    tags: operationObject.tags,
                     method,
                     path,
                     servers,

package/lib/openapi/types.d.ts

@@ -30,7 +30,7 @@ export interface InfoObject {
     contact?: ContactObject;
     license?: LicenseObject;
     version: string;
-    tags?: String[];
+    tags?: TagObject[];
     "x-logo"?: LogoObject;
     "x-dark-logo"?: LogoObject;
     logo?: LogoObject;

package/lib/sidebars/index.d.ts

@@ -1,4 +1,4 @@
 import { ProcessedSidebar } from "@docusaurus/plugin-content-docs/src/sidebars/types";
 import { TagObject } from "../openapi/types";
 import type { SidebarOptions, APIOptions, ApiMetadata } from "../types";
-export default function generateSidebarSlice(sidebarOptions: SidebarOptions, options: APIOptions, api: ApiMetadata[], tags: TagObject[], docPath: string): ProcessedSidebar;
+export default function generateSidebarSlice(sidebarOptions: SidebarOptions, options: APIOptions, api: ApiMetadata[], tags: TagObject[][], docPath: string): ProcessedSidebar;

package/lib/sidebars/index.js

@@ -33,9 +33,16 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
         };
     });
     // TODO: make sure we only take the first tag
-    const apiTags = (0, uniq_1.default)(apiItems
+    const operationTags = (0, uniq_1.default)(apiItems
         .flatMap((item) => item.api.tags)
         .filter((item) => !!item));
+    // Only include operation tags that are globally defined
+    const apiTags = [];
+    tags.flat().forEach((tag) => {
+        if (operationTags.includes(tag.name)) {
+            apiTags.push(tag.name);
+        }
+    });
     const basePath = docPath
         ? outputDir.split(docPath)[1].replace(/^\/+/g, "")
         : outputDir.slice(outputDir.indexOf("/", 1)).replace(/^\/+/g, "");
@@ -66,11 +73,12 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
     }
     const tagged = apiTags
         .map((tag) => {
+        var _a;
         // Map info object to tag
         const taggedInfoObject = intros.find((i) => i.tags ? i.tags.includes(tag) : undefined);
         const tagObject = tags.flat().find((t) => {
             var _a;
-            return (_a = (tag === t.name || tag === t["x-displayName"])) !== null && _a !== void 0 ? _a : {
+            return (_a = tag === t.name) !== null && _a !== void 0 ? _a : {
                 name: tag,
                 description: `${tag} Index`,
             };
@@ -105,7 +113,7 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
         }
         return {
             type: "category",
-            label: tag,
+            label: (_a = tagObject === null || tagObject === void 0 ? void 0 : tagObject["x-displayName"]) !== null && _a !== void 0 ? _a : tag,
             link: linkConfig,
             collapsible: sidebarCollapsible,
             collapsed: sidebarCollapsed,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "1.1.4",
+  "version": "1.1.7",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -66,6 +66,5 @@
   },
   "engines": {
     "node": ">=14"
-  },
-  "gitHead": "dadb0aa5d3516b3020ff1d94288efd6f136e02ba"
+  }
 }