docusaurus-plugin-openapi-docs 1.1.2 → 1.1.5

package/lib/markdown/schema.js

@@ -54,19 +54,39 @@ function getQualifierMessage(schema) {
     if (!schema) {
         return undefined;
     }
-    if (schema.items) {
+    if (schema.items &&
+        schema.minItems === undefined &&
+        schema.maxItems === undefined) {
         return getQualifierMessage(schema.items);
     }
     let message = "**Possible values:** ";
     let qualifierGroups = [];
+    if (schema.items && schema.items.enum) {
+        if (schema.items.enum) {
+            qualifierGroups.push(`[${schema.items.enum.map((e) => `\`${e}\``).join(", ")}]`);
+        }
+    }
     if (schema.minLength || schema.maxLength) {
         let lengthQualifier = "";
-        if (schema.minLength) {
-            lengthQualifier += `${schema.minLength} ≤ `;
+        let minLength;
+        let maxLength;
+        if (schema.minLength && schema.minLength > 1) {
+            minLength = `\`>= ${schema.minLength} characters\``;
+        }
+        if (schema.minLength && schema.minLength === 1) {
+            minLength = `\`non-empty\``;
         }
-        lengthQualifier += "length";
         if (schema.maxLength) {
-            lengthQualifier += ` ≤ ${schema.maxLength}`;
+            maxLength = `\`<= ${schema.maxLength} characters\``;
+        }
+        if (minLength && !maxLength) {
+            lengthQualifier += minLength;
+        }
+        if (maxLength && !minLength) {
+            lengthQualifier += maxLength;
+        }
+        if (minLength && maxLength) {
+            lengthQualifier += `${minLength} and ${maxLength}`;
         }
         qualifierGroups.push(lengthQualifier);
     }
@@ -75,38 +95,54 @@ function getQualifierMessage(schema) {
         typeof schema.exclusiveMinimum === "number" ||
         typeof schema.exclusiveMaximum === "number") {
         let minmaxQualifier = "";
+        let minimum;
+        let maximum;
         if (typeof schema.exclusiveMinimum === "number") {
-            minmaxQualifier += `${schema.exclusiveMinimum} < `;
+            minimum = `\`> ${schema.exclusiveMinimum}\``;
         }
         else if (schema.minimum && !schema.exclusiveMinimum) {
-            minmaxQualifier += `${schema.minimum} ≤ `;
+            minimum = `\`>= ${schema.minimum}\``;
         }
         else if (schema.minimum && schema.exclusiveMinimum === true) {
-            minmaxQualifier += `${schema.minimum} < `;
+            minimum = `\`> ${schema.minimum}\``;
         }
-        minmaxQualifier += "value";
         if (typeof schema.exclusiveMaximum === "number") {
-            minmaxQualifier += ` < ${schema.exclusiveMaximum}`;
+            maximum = `\`< ${schema.exclusiveMaximum}\``;
         }
         else if (schema.maximum && !schema.exclusiveMaximum) {
-            minmaxQualifier += ` ≤ ${schema.maximum}`;
+            maximum = `\`<= ${schema.maximum}\``;
         }
         else if (schema.maximum && schema.exclusiveMaximum === true) {
-            minmaxQualifier += ` < ${schema.maximum}`;
+            maximum = `\`< ${schema.maximum}\``;
+        }
+        if (minimum && !maximum) {
+            minmaxQualifier += minimum;
+        }
+        if (maximum && !minimum) {
+            minmaxQualifier += maximum;
+        }
+        if (minimum && maximum) {
+            minmaxQualifier += `${minimum} and ${maximum}`;
         }
         qualifierGroups.push(minmaxQualifier);
     }
     if (schema.pattern) {
         qualifierGroups.push(`Value must match regular expression \`${schema.pattern}\``);
     }
+    // Check if discriminator mapping
+    const discriminator = schema;
+    if (discriminator.mapping) {
+        const values = Object.keys(discriminator.mapping);
+        qualifierGroups.push(`[${values.map((e) => `\`${e}\``).join(", ")}]`);
+    }
     if (schema.enum) {
         qualifierGroups.push(`[${schema.enum.map((e) => `\`${e}\``).join(", ")}]`);
     }
     if (schema.minItems) {
-        qualifierGroups.push(`items >= ${schema.minItems}`);
+        qualifierGroups.push(`\`>= ${schema.minItems}\``);
     }
     if (schema.maxItems) {
-        qualifierGroups.push(`items <= ${schema.maxItems}`);
+        qualifierGroups.push(`\`<= ${schema.maxItems}\``);
     }
     if (qualifierGroups.length === 0) {
         return undefined;

package/lib/markdown/schema.test.js

@@ -16,17 +16,17 @@ describe("getQualifierMessage", () => {
     // minLength + maxLength
     //
     it("should render minLength", () => {
-        const expected = "**Possible values:** 1 ≤ length";
+        const expected = "**Possible values:** `non-empty`";
         const actual = (0, schema_1.getQualifierMessage)({ minLength: 1 });
         expect(actual).toBe(expected);
     });
     it("should render maxLength", () => {
-        const expected = "**Possible values:** length ≤ 40";
+        const expected = "**Possible values:** `<= 40 characters`";
         const actual = (0, schema_1.getQualifierMessage)({ maxLength: 40 });
         expect(actual).toBe(expected);
     });
     it("should render minLength and maxLength", () => {
-        const expected = "**Possible values:** 1 ≤ length ≤ 40";
+        const expected = "**Possible values:** `non-empty` and `<= 40 characters`";
         const actual = (0, schema_1.getQualifierMessage)({ minLength: 1, maxLength: 40 });
         expect(actual).toBe(expected);
     });
@@ -39,7 +39,7 @@ describe("getQualifierMessage", () => {
         expect(actual).toBe(expected);
     });
     it("should render multiple string qualifiers", () => {
-        const expected = "**Possible values:** 1 ≤ length ≤ 40, Value must match regular expression `^[a-zA-Z0-9_-]*$`";
+        const expected = "**Possible values:** `non-empty` and `<= 40 characters`, Value must match regular expression `^[a-zA-Z0-9_-]*$`";
         const actual = (0, schema_1.getQualifierMessage)({
             minLength: 1,
             maxLength: 40,
@@ -59,42 +59,42 @@ describe("getQualifierMessage", () => {
     // minimum + maximum + exclusiveMinimum + exclusiveMaximum
     //
     it("should render minimum", () => {
-        const expected = "**Possible values:** 1 ≤ value";
+        const expected = "**Possible values:** `>= 1`";
         const actual = (0, schema_1.getQualifierMessage)({ minimum: 1 });
         expect(actual).toBe(expected);
     });
     it("should render maximum", () => {
-        const expected = "**Possible values:** value ≤ 40";
+        const expected = "**Possible values:** `<= 40`";
         const actual = (0, schema_1.getQualifierMessage)({ maximum: 40 });
         expect(actual).toBe(expected);
     });
     it("should render numeric exclusiveMinimum", () => {
-        const expected = "**Possible values:** 1 < value";
+        const expected = "**Possible values:** `> 1`";
         const actual = (0, schema_1.getQualifierMessage)({ exclusiveMinimum: 1 });
         expect(actual).toBe(expected);
     });
     it("should render numeric exclusiveMaximum", () => {
-        const expected = "**Possible values:** value < 40";
+        const expected = "**Possible values:** `< 40`";
         const actual = (0, schema_1.getQualifierMessage)({ exclusiveMaximum: 40 });
         expect(actual).toBe(expected);
     });
     it("should render boolean exclusiveMinimum", () => {
-        const expected = "**Possible values:** 1 < value";
+        const expected = "**Possible values:** `> 1`";
         const actual = (0, schema_1.getQualifierMessage)({ minimum: 1, exclusiveMinimum: true });
         expect(actual).toBe(expected);
     });
     it("should render boolean exclusiveMaximum", () => {
-        const expected = "**Possible values:** value < 40";
+        const expected = "**Possible values:** `< 40`";
         const actual = (0, schema_1.getQualifierMessage)({ maximum: 40, exclusiveMaximum: true });
         expect(actual).toBe(expected);
     });
     it("should render minimum when exclusiveMinimum is false", () => {
-        const expected = "**Possible values:** 1 ≤ value";
+        const expected = "**Possible values:** `>= 1`";
         const actual = (0, schema_1.getQualifierMessage)({ minimum: 1, exclusiveMinimum: false });
         expect(actual).toBe(expected);
     });
     it("should render maximum when exclusiveMaximum is false", () => {
-        const expected = "**Possible values:** value ≤ 40";
+        const expected = "**Possible values:** `<= 40`";
         const actual = (0, schema_1.getQualifierMessage)({
             maximum: 40,
             exclusiveMaximum: false,
@@ -102,12 +102,12 @@ describe("getQualifierMessage", () => {
         expect(actual).toBe(expected);
     });
     it("should render minimum and maximum", () => {
-        const expected = "**Possible values:** 1 ≤ value ≤ 40";
+        const expected = "**Possible values:** `>= 1` and `<= 40`";
         const actual = (0, schema_1.getQualifierMessage)({ minimum: 1, maximum: 40 });
         expect(actual).toBe(expected);
     });
     it("should render boolean exclusiveMinimum and maximum", () => {
-        const expected = "**Possible values:** 1 < value ≤ 40";
+        const expected = "**Possible values:** `> 1` and `<= 40`";
         const actual = (0, schema_1.getQualifierMessage)({
             minimum: 1,
             maximum: 40,
@@ -116,7 +116,7 @@ describe("getQualifierMessage", () => {
         expect(actual).toBe(expected);
     });
     it("should render minimum and boolean exclusiveMaximum", () => {
-        const expected = "**Possible values:** 1 ≤ value < 40";
+        const expected = "**Possible values:** `>= 1` and `< 40`";
         const actual = (0, schema_1.getQualifierMessage)({
             minimum: 1,
             maximum: 40,
@@ -125,7 +125,7 @@ describe("getQualifierMessage", () => {
         expect(actual).toBe(expected);
     });
     it("should render numeric exclusiveMinimum and maximum", () => {
-        const expected = "**Possible values:** 1 < value ≤ 40";
+        const expected = "**Possible values:** `> 1` and `<= 40`";
         const actual = (0, schema_1.getQualifierMessage)({
             exclusiveMinimum: 1,
             maximum: 40,
@@ -133,7 +133,7 @@ describe("getQualifierMessage", () => {
         expect(actual).toBe(expected);
     });
     it("should render minimum and numeric exclusiveMaximum", () => {
-        const expected = "**Possible values:** 1 ≤ value < 40";
+        const expected = "**Possible values:** `>= 1` and `< 40`";
         const actual = (0, schema_1.getQualifierMessage)({
             minimum: 1,
             exclusiveMaximum: 40,
@@ -141,7 +141,7 @@ describe("getQualifierMessage", () => {
         expect(actual).toBe(expected);
     });
     it("should render numeric exclusiveMinimum and boolean exclusiveMaximum", () => {
-        const expected = "**Possible values:** 1 < value < 40";
+        const expected = "**Possible values:** `> 1` and `< 40`";
         const actual = (0, schema_1.getQualifierMessage)({
             exclusiveMinimum: 1,
             maximum: 40,

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

@@ -16,7 +16,8 @@ const openapi_to_postmanv2_1 = __importDefault(require("@paloaltonetworks/openap
 const postman_collection_1 = __importDefault(require("@paloaltonetworks/postman-collection"));
 const chalk_1 = __importDefault(require("chalk"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
-const lodash_1 = require("lodash");
+const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
+const kebabCase_1 = __importDefault(require("lodash/kebabCase"));
 const index_1 = require("../index");
 const createExample_1 = require("./createExample");
 const loadAndResolveSpec_1 = require("./utils/loadAndResolveSpec");
@@ -41,7 +42,7 @@ function jsonToCollection(data) {
 async function createPostmanCollection(openapiData) {
     var _a, _b, _c, _d, _e, _f, _g, _h;
     // Create copy of openapiData
-    const data = Object.assign({}, openapiData);
+    const data = (0, cloneDeep_1.default)(openapiData);
     // Including `servers` breaks postman, so delete all of them.
     delete data.servers;
     for (let pathItemObject of Object.values(data.paths)) {
@@ -58,10 +59,10 @@ 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, lodash_1.kebabCase)(openapiData.info.title);
+    const infoId = (0, kebabCase_1.default)(openapiData.info.title);
     if ((sidebarOptions === null || sidebarOptions === void 0 ? void 0 : sidebarOptions.categoryLinkSource) === "tag") {
         // Only create an tag pages if categoryLinkSource set to tag.
         const tags = (_a = openapiData.tags) !== null && _a !== void 0 ? _a : [];
@@ -72,14 +73,13 @@ function createItems(openapiData, sidebarOptions) {
             .map((tag) => {
             var _a;
             const description = getTagDisplayName(tag.name, (_a = openapiData.tags) !== null && _a !== void 0 ? _a : []);
-            const tagId = (0, lodash_1.kebabCase)(tag.name);
+            const tagId = (0, kebabCase_1.default)(tag.name);
             const tagPage = {
                 type: "tag",
                 id: tagId,
                 unversionedId: tagId,
                 title: description !== null && description !== void 0 ? description : "",
                 description: description !== null && description !== void 0 ? description : "",
-                slug: "/" + tagId,
                 frontMatter: {},
                 tag: {
                     ...tag,
@@ -96,13 +96,14 @@ function createItems(openapiData, sidebarOptions) {
             unversionedId: infoId,
             title: openapiData.info.title,
             description: openapiData.info.description,
-            slug: "/" + infoId,
             frontMatter: {},
             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"],
             },
         };
         items.push(infoPage);
@@ -110,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, lodash_1.kebabCase)(operationObject.operationId)
-                : (0, lodash_1.kebabCase)(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;
+                ? (0, kebabCase_1.default)(operationObject.operationId)
+                : (0, kebabCase_1.default)(operationObject.summary);
+            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)) {
@@ -131,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 = {
@@ -144,11 +156,10 @@ function createItems(openapiData, sidebarOptions) {
                 unversionedId: baseId,
                 title: title,
                 description: description !== null && description !== void 0 ? description : "",
-                slug: "/" + baseId,
                 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,14 @@ export interface InfoObject {
     contact?: ContactObject;
     license?: LicenseObject;
     version: string;
-    tags?: String[];
+    tags?: TagObject[];
+    "x-logo"?: LogoObject;
+    "x-dark-logo"?: LogoObject;
+    logo?: LogoObject;
+    darkLogo?: LogoObject;
+}
+export interface LogoObject {
+    url?: string;
 }
 export interface ContactObject {
     name?: string;

package/lib/openapi/utils/loadAndResolveSpec.js

@@ -15,6 +15,7 @@ const openapi_core_1 = require("@redocly/openapi-core");
 const chalk_1 = __importDefault(require("chalk"));
 // @ts-ignore
 const swagger2openapi_1 = require("swagger2openapi");
+const OpenAPIParser_1 = require("./services/OpenAPIParser");
 function serializer(replacer, cycleReplacer) {
     var stack = [], keys = [];
     if (cycleReplacer === undefined)
@@ -24,6 +25,18 @@ function serializer(replacer, cycleReplacer) {
             return value.title ? `circular(${value.title})` : "circular()";
         };
     return function (key, value) {
+        // Resolve discriminator ref pointers
+        if ((value === null || value === void 0 ? void 0 : value.discriminator) !== undefined) {
+            const parser = new OpenAPIParser_1.OpenAPIParser(stack[0]);
+            for (let [k, v] of Object.entries(value.discriminator.mapping)) {
+                const discriminator = k;
+                if (typeof v === "string" && v.charAt(0) === "#") {
+                    const ref = v;
+                    const resolvedRef = parser.byRef(ref);
+                    value.discriminator.mapping[discriminator] = resolvedRef;
+                }
+            }
+        }
         if (stack.length > 0) {
             // @ts-ignore
             var thisPos = stack.indexOf(this);

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

@@ -9,6 +9,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
 const clsx_1 = __importDefault(require("clsx"));
 const lodash_1 = require("lodash");
 const uniq_1 = __importDefault(require("lodash/uniq"));
@@ -32,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, "");
@@ -65,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`,
             };
@@ -98,13 +107,13 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
                 type: "generated-index",
                 title: tag,
                 slug: label
-                    ? "/category/" + (0, lodash_1.kebabCase)(label) + "/" + (0, lodash_1.kebabCase)(tag)
-                    : "/category/" + (0, lodash_1.kebabCase)(tag),
+                    ? path_1.default.join("/category", basePath, (0, lodash_1.kebabCase)(label), (0, lodash_1.kebabCase)(tag))
+                    : path_1.default.join("/category", basePath, (0, lodash_1.kebabCase)(tag)),
             };
         }
         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/lib/types.d.ts

@@ -51,7 +51,7 @@ export interface ApiMetadataBase {
     description: string;
     source: string;
     sourceDirName: string;
-    slug: string;
+    slug?: string;
     permalink: string;
     sidebarPosition?: number;
     frontMatter: Record<string, unknown>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "1.1.2",
+  "version": "1.1.5",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -28,8 +28,8 @@
     "watch": "tsc --watch"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-rc.1",
-    "@docusaurus/types": "2.0.0-rc.1",
+    "@docusaurus/module-type-aliases": "2.0.1",
+    "@docusaurus/types": "2.0.1",
     "@types/fs-extra": "^9.0.13",
     "@types/js-yaml": "^4.0.5",
     "@types/json-pointer": "^1.0.31",
@@ -40,10 +40,10 @@
   },
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^9.0.9",
-    "@docusaurus/mdx-loader": "2.0.0-rc.1",
-    "@docusaurus/plugin-content-docs": "2.0.0-rc.1",
-    "@docusaurus/utils": "2.0.0-rc.1",
-    "@docusaurus/utils-validation": "2.0.0-rc.1",
+    "@docusaurus/mdx-loader": "2.0.1",
+    "@docusaurus/plugin-content-docs": "2.0.1",
+    "@docusaurus/utils": "2.0.1",
+    "@docusaurus/utils-validation": "2.0.1",
     "@paloaltonetworks/openapi-to-postmanv2": "3.1.0-hotfix.1",
     "@paloaltonetworks/postman-collection": "^4.1.0",
     "@redocly/openapi-core": "^1.0.0-beta.103",
@@ -67,5 +67,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "0c66efff6ff553647265abdc27d4ca847c6d8045"
+  "gitHead": "21d33582a9fcac2ddd23443497af910982b36dae"
 }

package/src/markdown/createLogo.ts

@@ -0,0 +1,21 @@
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+
+import { LogoObject } from "../openapi/types";
+import { create, guard } from "./utils";
+
+export function createLogo(
+  logo: LogoObject | undefined,
+  darkLogo: LogoObject | undefined
+) {
+  return guard(logo || darkLogo, () => [
+    create("ApiLogo", {
+      logo: logo,
+      darkLogo: darkLogo,
+    }),
+  ]);
+}