docusaurus-plugin-openapi-docs 3.0.0-beta.8 → 3.0.0

package/lib/markdown/createSchema.js

@@ -11,6 +11,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createNodes = exports.mergeAllOf = void 0;
 const clsx_1 = __importDefault(require("clsx"));
+const isEmpty_1 = __importDefault(require("lodash/isEmpty"));
 const createArrayBracket_1 = require("./createArrayBracket");
 const createDescription_1 = require("./createDescription");
 const createDetails_1 = require("./createDetails");
@@ -40,14 +41,14 @@ function mergeAllOf(allOf) {
         },
         ignoreAdditionalProperties: true,
     });
-    const required = allOf.reduce((acc, cur) => {
+    const mergedRequired = allOf.reduce((acc, cur) => {
         if (Array.isArray(cur.required)) {
             const next = [...acc, ...cur.required];
             return next;
         }
         return acc;
     }, []);
-    return { mergedSchemas, required };
+    return { mergedSchemas, mergedRequired };
 }
 exports.mergeAllOf = mergeAllOf;
 /**
@@ -116,6 +117,16 @@ function createAnyOneOf(schema) {
  */
 function createProperties(schema) {
     const discriminator = schema.discriminator;
+    if (Object.keys(schema.properties).length === 0) {
+        return (0, utils_1.create)("SchemaItem", {
+            collapsible: false,
+            name: "",
+            required: false,
+            schemaName: "object",
+            qualifierMessage: undefined,
+            schema: {},
+        });
+    }
     return Object.entries(schema.properties).map(([key, val]) => {
         return createEdges({
             name: key,
@@ -131,70 +142,52 @@ function createProperties(schema) {
  * For handling additionalProperties.
  */
 function createAdditionalProperties(schema) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+    var _a;
     const additionalProperties = schema.additionalProperties;
-    const type = additionalProperties === null || additionalProperties === void 0 ? void 0 : additionalProperties.type;
+    if (!additionalProperties)
+        return [];
     // Handle free-form objects
-    if (String(additionalProperties) === "true" && schema.type === "object") {
+    if (additionalProperties === true || (0, isEmpty_1.default)(additionalProperties)) {
         return (0, utils_1.create)("SchemaItem", {
             name: "property name*",
             required: false,
             schemaName: "any",
-            qualifierMessage: (0, schema_1.getQualifierMessage)(schema.additionalProperties),
+            qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
             schema: schema,
             collapsible: false,
             discriminator: false,
         });
     }
-    if ((type === "object" || type === "array") &&
-        ((additionalProperties === null || additionalProperties === void 0 ? void 0 : additionalProperties.properties) ||
-            (additionalProperties === null || additionalProperties === void 0 ? void 0 : additionalProperties.items) ||
-            (additionalProperties === null || additionalProperties === void 0 ? void 0 : additionalProperties.allOf) ||
-            (additionalProperties === null || additionalProperties === void 0 ? void 0 : additionalProperties.additionalProperties) ||
-            (additionalProperties === null || additionalProperties === void 0 ? void 0 : additionalProperties.oneOf) ||
-            (additionalProperties === null || additionalProperties === void 0 ? void 0 : additionalProperties.anyOf))) {
+    // objects, arrays, complex schemas
+    if (additionalProperties.properties ||
+        additionalProperties.items ||
+        additionalProperties.allOf ||
+        additionalProperties.additionalProperties ||
+        additionalProperties.oneOf ||
+        additionalProperties.anyOf) {
         const title = additionalProperties.title;
         const schemaName = (0, schema_1.getSchemaName)(additionalProperties);
         const required = (_a = schema.required) !== null && _a !== void 0 ? _a : false;
         return createDetailsNode("property name*", title !== null && title !== void 0 ? title : schemaName, additionalProperties, required, schema.nullable);
     }
-    if (((_b = schema.additionalProperties) === null || _b === void 0 ? void 0 : _b.type) === "string" ||
-        ((_c = schema.additionalProperties) === null || _c === void 0 ? void 0 : _c.type) === "object" ||
-        ((_d = schema.additionalProperties) === null || _d === void 0 ? void 0 : _d.type) === "boolean" ||
-        ((_e = schema.additionalProperties) === null || _e === void 0 ? void 0 : _e.type) === "integer" ||
-        ((_f = schema.additionalProperties) === null || _f === void 0 ? void 0 : _f.type) === "number") {
-        const additionalProperties = (_g = schema.additionalProperties) === null || _g === void 0 ? void 0 : _g.additionalProperties;
-        if (additionalProperties !== undefined) {
-            const type = (_j = (_h = schema.additionalProperties) === null || _h === void 0 ? void 0 : _h.additionalProperties) === null || _j === void 0 ? void 0 : _j.type;
-            const schemaName = (0, schema_1.getSchemaName)((_k = schema.additionalProperties) === null || _k === void 0 ? void 0 : _k.additionalProperties);
-            return (0, utils_1.create)("SchemaItem", {
-                name: "property name*",
-                required: false,
-                schemaName: schemaName !== null && schemaName !== void 0 ? schemaName : type,
-                qualifierMessage: (_l = schema.additionalProperties) !== null && _l !== void 0 ? _l : (0, schema_1.getQualifierMessage)(schema.additionalProperties),
-                schema: schema,
-                collapsible: false,
-                discriminator: false,
-            });
-        }
-        const schemaName = (0, schema_1.getSchemaName)(schema.additionalProperties);
+    // primitive types
+    if (additionalProperties.type === "string" ||
+        additionalProperties.type === "boolean" ||
+        additionalProperties.type === "integer" ||
+        additionalProperties.type === "number") {
+        const schemaName = (0, schema_1.getSchemaName)(additionalProperties);
         return (0, utils_1.create)("SchemaItem", {
             name: "property name*",
             required: false,
             schemaName: schemaName,
             qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
-            schema: schema.additionalProperties,
+            schema: additionalProperties,
             collapsible: false,
             discriminator: false,
         });
     }
-    return Object.entries(schema.additionalProperties).map(([key, val]) => createEdges({
-        name: key,
-        schema: val,
-        required: Array.isArray(schema.required)
-            ? schema.required.includes(key)
-            : false,
-    }));
+    // unknown
+    return [];
 }
 /**
  * For handling items.
@@ -483,6 +476,16 @@ function createPropertyDiscriminator(name, schemaName, schema, discriminator, re
  */
 function createEdges({ name, schema, required, discriminator, }) {
     var _a, _b, _c, _d;
+    if (SCHEMA_TYPE === "request") {
+        if (schema.readOnly && schema.readOnly === true) {
+            return undefined;
+        }
+    }
+    if (SCHEMA_TYPE === "response") {
+        if (schema.writeOnly && schema.writeOnly === true) {
+            return undefined;
+        }
+    }
     const schemaName = (0, schema_1.getSchemaName)(schema);
     if (discriminator !== undefined && discriminator.propertyName === name) {
         return createPropertyDiscriminator(name, "string", schema, discriminator, required);
@@ -491,7 +494,17 @@ function createEdges({ name, schema, required, discriminator, }) {
         return createAnyOneOfProperty(name, schemaName, schema, required, schema.nullable);
     }
     if (schema.allOf !== undefined) {
-        const { mergedSchemas, required, } = mergeAllOf(schema.allOf);
+        const { mergedSchemas } = mergeAllOf(schema.allOf);
+        if (SCHEMA_TYPE === "request") {
+            if (mergedSchemas.readOnly && mergedSchemas.readOnly === true) {
+                return undefined;
+            }
+        }
+        if (SCHEMA_TYPE === "response") {
+            if (mergedSchemas.writeOnly && mergedSchemas.writeOnly === true) {
+                return undefined;
+            }
+        }
         const mergedSchemaName = (0, schema_1.getSchemaName)(mergedSchemas);
         if (mergedSchemas.oneOf !== undefined ||
             mergedSchemas.anyOf !== undefined) {
@@ -507,16 +520,6 @@ function createEdges({ name, schema, required, discriminator, }) {
         if (((_a = mergedSchemas.items) === null || _a === void 0 ? void 0 : _a.properties) !== undefined) {
             return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
         }
-        if (SCHEMA_TYPE === "request") {
-            if (mergedSchemas.readOnly && mergedSchemas.readOnly === true) {
-                return undefined;
-            }
-        }
-        if (SCHEMA_TYPE === "response") {
-            if (mergedSchemas.writeOnly && mergedSchemas.writeOnly === true) {
-                return undefined;
-            }
-        }
         return (0, utils_1.create)("SchemaItem", {
             collapsible: false,
             name,
@@ -539,16 +542,6 @@ function createEdges({ name, schema, required, discriminator, }) {
     if (((_c = schema.items) === null || _c === void 0 ? void 0 : _c.anyOf) !== undefined || ((_d = schema.items) === null || _d === void 0 ? void 0 : _d.oneOf) !== undefined) {
         return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
-    if (SCHEMA_TYPE === "request") {
-        if (schema.readOnly && schema.readOnly === true) {
-            return undefined;
-        }
-    }
-    if (SCHEMA_TYPE === "response") {
-        if (schema.writeOnly && schema.writeOnly === true) {
-            return undefined;
-        }
-    }
     // primitives and array of non-objects
     return (0, utils_1.create)("SchemaItem", {
         collapsible: false,
@@ -564,6 +557,16 @@ function createEdges({ name, schema, required, discriminator, }) {
  */
 function createNodes(schema, schemaType) {
     SCHEMA_TYPE = schemaType;
+    if (SCHEMA_TYPE === "request") {
+        if (schema.readOnly && schema.readOnly === true) {
+            return undefined;
+        }
+    }
+    if (SCHEMA_TYPE === "response") {
+        if (schema.writeOnly && schema.writeOnly === true) {
+            return undefined;
+        }
+    }
     const nodes = [];
     // if (schema.discriminator !== undefined) {
     //   return createDiscriminator(schema);
@@ -573,7 +576,10 @@ function createNodes(schema, schemaType) {
     }
     if (schema.allOf !== undefined) {
         const { mergedSchemas } = mergeAllOf(schema.allOf);
-        // allOf seems to always result in properties
+        if (mergedSchemas.oneOf !== undefined ||
+            mergedSchemas.anyOf !== undefined) {
+            nodes.push(createAnyOneOf(mergedSchemas));
+        }
         if (mergedSchemas.properties !== undefined) {
             nodes.push(createProperties(mergedSchemas));
         }

package/lib/markdown/createSchema.test.js

@@ -34,6 +34,7 @@ const createSchema_1 = require("./createSchema");
 describe("createNodes", () => {
     it("should create readable MODs for oneOf primitive properties", async () => {
         const schema = {
+            "x-tags": ["clown"],
             type: "object",
             properties: {
                 oneOfProperty: {
@@ -70,4 +71,80 @@ describe("createNodes", () => {
         };
         expect(await Promise.all((0, createSchema_1.createNodes)(schema, "request").map(async (md) => await prettier.format(md, { parser: "babel" })))).toMatchSnapshot();
     });
+    describe("additionalProperties", () => {
+        it.each([
+            [
+                {
+                    allOf: [
+                        {
+                            oneOf: [
+                                {
+                                    type: "object",
+                                    properties: {
+                                        type: {
+                                            type: "string",
+                                            enum: ["nose"],
+                                        },
+                                    },
+                                    required: ["type"],
+                                },
+                                {
+                                    type: "object",
+                                    properties: {
+                                        type: {
+                                            type: "string",
+                                            enum: ["mouth"],
+                                        },
+                                    },
+                                    required: ["type"],
+                                },
+                                {
+                                    type: "object",
+                                    properties: {
+                                        type: {
+                                            type: "string",
+                                            enum: ["eyes"],
+                                        },
+                                        default: {
+                                            type: "string",
+                                        },
+                                    },
+                                    required: ["type"],
+                                },
+                            ],
+                        },
+                        {
+                            type: "object",
+                            properties: {
+                                description: {
+                                    type: "string",
+                                    description: "Description of the body part.",
+                                },
+                            },
+                            required: ["description"],
+                        },
+                    ],
+                },
+            ],
+            [
+                {
+                    type: "array",
+                    items: { type: "object", properties: { a: "string", b: "number" } },
+                },
+            ],
+            [{ type: "string" }],
+            [{ type: "number" }],
+            [{ type: "integer" }],
+            [{ type: "boolean" }],
+            [false],
+            [true],
+            [{}],
+        ])("should handle additionalProperties: %p", async (additionalProperties) => {
+            const schema = {
+                type: "object",
+                additionalProperties,
+            };
+            expect(await Promise.all((0, createSchema_1.createNodes)(schema, "request").map(async (md) => await prettier.format(md, { parser: "babel" })))).toMatchSnapshot();
+        });
+    });
 });

package/lib/markdown/createStatusCodes.js

@@ -275,7 +275,7 @@ function createStatusCodes({ label, id, responses }) {
                                     responseHeaders &&
                                         (0, createDetails_1.createDetails)({
                                             className: "openapi-markdown__details",
-                                            "data-collaposed": true,
+                                            "data-collapsed": true,
                                             open: false,
                                             style: { textAlign: "left", marginBottom: "1rem" },
                                             children: [

package/lib/markdown/createVersionBadge.js

@@ -13,7 +13,7 @@ function createVersionBadge(version) {
         (0, utils_1.create)("span", {
             className: "theme-doc-version-badge badge badge--secondary",
             children: `Version: ${escape(version)}`,
-        }),
+        }, { inline: true }),
         `\n\n`,
     ]);
 }

package/lib/markdown/utils.js

@@ -45,7 +45,7 @@ exports.render = render;
 exports.lessThan = /<=?(?!(=|button|\s?\/button|code|\s?\/code|details|\s?\/details|summary|\s?\/summary|hr|\s?\/hr|br|\s?\/br|span|\s?\/span|strong|\s?\/strong|small|\s?\/small|table|\s?\/table|thead|\s?\/thead|tbody|\s?\/tbody|td|\s?\/td|tr|\s?\/tr|th|\s?\/th|h1|\s?\/h1|h2|\s?\/h2|h3|\s?\/h3|h4|\s?\/h4|h5|\s?\/h5|h6|\s?\/h6|title|\s?\/title|p|\s?\/p|em|\s?\/em|b|\s?\/b|i|\s?\/i|u|\s?\/u|strike|\s?\/strike|bold|\s?\/bold|a|\s?\/a|table|\s?\/table|li|\s?\/li|ol|\s?\/ol|ul|\s?\/ul|img|\s?\/img|svg|\s?\/svg|div|\s?\/div|center|\s?\/center))/gu;
 exports.greaterThan = /(?<!(button|code|details|summary|hr|br|span|strong|small|table|thead|tbody|td|tr|th|h1|h2|h3|h4|h5|h6|title|p|em|b|i|u|strike|bold|a|li|ol|ul|img|svg|div|center|\/|\s|"|'))>/gu;
 exports.codeFence = /`{1,3}[\s\S]*?`{1,3}/g;
-exports.curlyBrackets = /([{|}])/g;
+exports.curlyBrackets = /([{}])/g;
 exports.codeBlock = /(^```.*[\s\S]*?```$|`[^`].+?`)/gm;
 function clean(value) {
     if (!value) {

package/lib/openapi/openapi.js

@@ -12,14 +12,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getTagDisplayName = exports.processOpenapiFile = exports.processOpenapiFiles = exports.readOpenapiFiles = void 0;
 const path_1 = __importDefault(require("path"));
 const utils_1 = require("@docusaurus/utils");
-const openapi_to_postmanv2_1 = __importDefault(require("@paloaltonetworks/openapi-to-postmanv2"));
-const postman_collection_1 = __importDefault(require("@paloaltonetworks/postman-collection"));
 const chalk_1 = __importDefault(require("chalk"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
 const kebabCase_1 = __importDefault(require("lodash/kebabCase"));
 const unionBy_1 = __importDefault(require("lodash/unionBy"));
 const uniq_1 = __importDefault(require("lodash/uniq"));
+const openapi_to_postmanv2_1 = __importDefault(require("openapi-to-postmanv2"));
+const postman_collection_1 = __importDefault(require("postman-collection"));
 const createRequestExample_1 = require("./createRequestExample");
 const loadAndResolveSpec_1 = require("./utils/loadAndResolveSpec");
 const index_1 = require("../index");
@@ -61,7 +61,7 @@ async function createPostmanCollection(openapiData) {
     return await jsonToCollection(data);
 }
 function createItems(openapiData, options, sidebarOptions) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6;
     // TODO: Find a better way to handle this
     let items = [];
     const infoIdSpaces = openapiData.info.title.replace(" ", "-").toLowerCase();
@@ -324,42 +324,47 @@ function createItems(openapiData, options, sidebarOptions) {
             items.push(apiPage);
         }
     }
-    if ((options === null || options === void 0 ? void 0 : options.showSchemas) === true) {
+    if ((options === null || options === void 0 ? void 0 : options.showSchemas) === true ||
+        Object.entries((_1 = (_0 = openapiData === null || openapiData === void 0 ? void 0 : openapiData.components) === null || _0 === void 0 ? void 0 : _0.schemas) !== null && _1 !== void 0 ? _1 : {})
+            .flatMap(([_, s]) => s["x-tags"])
+            .filter((item) => !!item).length > 0) {
         // Gather schemas
-        for (let [schema, schemaObject] of Object.entries((_1 = (_0 = openapiData === null || openapiData === void 0 ? void 0 : openapiData.components) === null || _0 === void 0 ? void 0 : _0.schemas) !== null && _1 !== void 0 ? _1 : {})) {
-            const baseIdSpaces = (_3 = (_2 = schemaObject === null || schemaObject === void 0 ? void 0 : schemaObject.title) === null || _2 === void 0 ? void 0 : _2.replace(" ", "-").toLowerCase()) !== null && _3 !== void 0 ? _3 : "";
-            const baseId = (0, kebabCase_1.default)(baseIdSpaces);
-            const schemaDescription = schemaObject.description;
-            let splitDescription;
-            if (schemaDescription) {
-                splitDescription = schemaDescription.match(/[^\r\n]+/g);
-            }
-            const schemaPage = {
-                type: "schema",
-                id: baseId,
-                infoId: infoId !== null && infoId !== void 0 ? infoId : "",
-                unversionedId: baseId,
-                title: schemaObject.title
-                    ? schemaObject.title.replace(/((?:^|[^\\])(?:\\{2})*)"/g, "$1'")
-                    : schema,
-                description: schemaObject.description
-                    ? schemaObject.description.replace(/((?:^|[^\\])(?:\\{2})*)"/g, "$1'")
-                    : "",
-                frontMatter: {
-                    description: splitDescription
-                        ? splitDescription[0]
-                            .replace(/((?:^|[^\\])(?:\\{2})*)"/g, "$1'")
-                            .replace(/\s+$/, "")
+        for (let [schema, schemaObject] of Object.entries((_3 = (_2 = openapiData === null || openapiData === void 0 ? void 0 : openapiData.components) === null || _2 === void 0 ? void 0 : _2.schemas) !== null && _3 !== void 0 ? _3 : {})) {
+            if ((options === null || options === void 0 ? void 0 : options.showSchemas) === true || schemaObject["x-tags"]) {
+                const baseIdSpaces = (_5 = (_4 = schemaObject === null || schemaObject === void 0 ? void 0 : schemaObject.title) === null || _4 === void 0 ? void 0 : _4.replace(" ", "-").toLowerCase()) !== null && _5 !== void 0 ? _5 : "";
+                const baseId = (0, kebabCase_1.default)(baseIdSpaces);
+                const schemaDescription = schemaObject.description;
+                let splitDescription;
+                if (schemaDescription) {
+                    splitDescription = schemaDescription.match(/[^\r\n]+/g);
+                }
+                const schemaPage = {
+                    type: "schema",
+                    id: baseId,
+                    infoId: infoId !== null && infoId !== void 0 ? infoId : "",
+                    unversionedId: baseId,
+                    title: schemaObject.title
+                        ? schemaObject.title.replace(/((?:^|[^\\])(?:\\{2})*)"/g, "$1'")
+                        : schema,
+                    description: schemaObject.description
+                        ? schemaObject.description.replace(/((?:^|[^\\])(?:\\{2})*)"/g, "$1'")
                         : "",
-                },
-                schema: schemaObject,
-            };
-            items.push(schemaPage);
+                    frontMatter: {
+                        description: splitDescription
+                            ? splitDescription[0]
+                                .replace(/((?:^|[^\\])(?:\\{2})*)"/g, "$1'")
+                                .replace(/\s+$/, "")
+                            : "",
+                    },
+                    schema: schemaObject,
+                };
+                items.push(schemaPage);
+            }
         }
     }
     if ((sidebarOptions === null || sidebarOptions === void 0 ? void 0 : sidebarOptions.categoryLinkSource) === "tag") {
         // Get global tags
-        const tags = (_4 = openapiData.tags) !== null && _4 !== void 0 ? _4 : [];
+        const tags = (_6 = openapiData.tags) !== null && _6 !== void 0 ? _6 : [];
         // Get operation tags
         const apiItems = items.filter((item) => {
             return item.type === "api";

package/lib/openapi/openapi.test.js

@@ -17,6 +17,7 @@ const _1 = require(".");
 describe("openapi", () => {
     describe("readOpenapiFiles", () => {
         it("readOpenapiFiles", async () => {
+            var _a, _b;
             const results = await (0, _1.readOpenapiFiles)((0, utils_1.posixPath)(path_1.default.join(__dirname, "__fixtures__/examples")));
             const categoryMeta = results.find((x) => x.source.endsWith("_category_.json"));
             expect(categoryMeta).toBeFalsy();
@@ -26,6 +27,7 @@ describe("openapi", () => {
             expect(yaml === null || yaml === void 0 ? void 0 : yaml.sourceDirName).toBe(".");
             expect(yaml === null || yaml === void 0 ? void 0 : yaml.data.tags).toBeDefined();
             expect(yaml === null || yaml === void 0 ? void 0 : yaml.data["x-tagGroups"]).toBeDefined();
+            expect((_b = (_a = yaml === null || yaml === void 0 ? void 0 : yaml.data.components) === null || _a === void 0 ? void 0 : _a.schemas) === null || _b === void 0 ? void 0 : _b.HelloString["x-tags"]).toBeDefined();
         });
     });
 });

package/lib/openapi/types.d.ts

@@ -269,7 +269,7 @@ export type SchemaObject = Omit<JSONSchema, "type" | "allOf" | "oneOf" | "anyOf"
     not?: SchemaObject;
     items?: SchemaObject;
     properties?: Map<SchemaObject>;
-    additionalProperties?: Map<SchemaObject>;
+    additionalProperties?: boolean | SchemaObject;
     nullable?: boolean;
     discriminator?: DiscriminatorObject;
     readOnly?: boolean;
@@ -278,6 +278,7 @@ export type SchemaObject = Omit<JSONSchema, "type" | "allOf" | "oneOf" | "anyOf"
     externalDocs?: ExternalDocumentationObject;
     example?: any;
     deprecated?: boolean;
+    "x-tags"?: string[];
 };
 export type SchemaObjectWithRef = Omit<JSONSchema, "type" | "allOf" | "oneOf" | "anyOf" | "not" | "items" | "properties" | "additionalProperties"> & {
     type?: "string" | "number" | "integer" | "boolean" | "object" | "array";

package/lib/options.js

@@ -22,6 +22,7 @@ const markdownGenerators = utils_validation_1.Joi.object({
 });
 exports.OptionsSchema = utils_validation_1.Joi.object({
     id: utils_validation_1.Joi.string().required(),
+    docsPlugin: utils_validation_1.Joi.string(),
     docsPluginId: utils_validation_1.Joi.string().required(),
     config: utils_validation_1.Joi.object()
         .pattern(/^/, utils_validation_1.Joi.object({
@@ -35,6 +36,7 @@ exports.OptionsSchema = utils_validation_1.Joi.object({
         sidebarOptions: sidebarOptions,
         markdownGenerators: markdownGenerators,
         showSchemas: utils_validation_1.Joi.boolean(),
+        disableCompression: utils_validation_1.Joi.boolean(),
         version: utils_validation_1.Joi.string().when("versions", {
             is: utils_validation_1.Joi.exist(),
             then: utils_validation_1.Joi.required(),
@@ -52,6 +54,7 @@ exports.OptionsSchema = utils_validation_1.Joi.object({
             outputDir: utils_validation_1.Joi.string().required(),
             label: utils_validation_1.Joi.string().required(),
             baseUrl: utils_validation_1.Joi.string().required(),
+            downloadUrl: utils_validation_1.Joi.string(),
         })),
     }))
         .required(),

package/lib/sidebars/index.js

@@ -24,7 +24,7 @@ function isSchemaItem(item) {
     return item.type === "schema";
 }
 function groupByTags(items, sidebarOptions, options, tags, docPath) {
-    let { outputDir, label } = options;
+    let { outputDir, label, showSchemas } = options;
     // Remove trailing slash before proceeding
     outputDir = outputDir.replace(/\/$/, "");
     const { sidebarCollapsed, sidebarCollapsible, customProps, categoryLinkSource, } = sidebarOptions;
@@ -43,16 +43,21 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
     const operationTags = (0, uniq_1.default)(apiItems
         .flatMap((item) => item.api.tags)
         .filter((item) => !!item));
-    // Combine globally defined tags with operation tags
-    // Only include global tag if referenced in operation tags
+    const schemaTags = (0, uniq_1.default)(schemaItems
+        .flatMap((item) => item.schema["x-tags"])
+        .filter((item) => !!item));
+    // Combine globally defined tags with operation and schema tags
+    // Only include global tag if referenced in operation/schema tags
     let apiTags = [];
     tags.flat().forEach((tag) => {
         // Should we also check x-displayName?
-        if (operationTags.includes(tag.name)) {
+        if (operationTags.includes(tag.name) || schemaTags.includes(tag.name)) {
             apiTags.push(tag.name);
         }
     });
-    apiTags = (0, uniq_1.default)(apiTags.concat(operationTags));
+    if (sidebarOptions.groupPathsBy !== "tagGroup") {
+        apiTags = (0, uniq_1.default)(apiTags.concat(operationTags, schemaTags));
+    }
     const basePath = docPath
         ? outputDir.split(docPath)[1].replace(/^\/+/g, "")
         : outputDir.slice(outputDir.indexOf("/", 1)).replace(/^\/+/g, "");
@@ -68,7 +73,7 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
             }, item.api.method)
             : (0, clsx_1.default)({
                 "menu__list-item--deprecated": item.schema.deprecated,
-            });
+            }, "schema");
         return {
             type: "doc",
             id: basePath === "" || undefined ? `${id}` : `${basePath}/${id}`,
@@ -126,15 +131,15 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
                     : (0, utils_1.posixPath)(path_1.default.join("/category", basePath, (0, lodash_1.kebabCase)(tag))),
             };
         }
+        const taggedApiItems = apiItems.filter((item) => { var _a; return !!((_a = item.api.tags) === null || _a === void 0 ? void 0 : _a.includes(tag)); });
+        const taggedSchemaItems = schemaItems.filter((item) => { var _a; return !!((_a = item.schema["x-tags"]) === null || _a === void 0 ? void 0 : _a.includes(tag)); });
         return {
             type: "category",
             label: (_a = tagObject === null || tagObject === void 0 ? void 0 : tagObject["x-displayName"]) !== null && _a !== void 0 ? _a : tag,
             link: linkConfig,
             collapsible: sidebarCollapsible,
             collapsed: sidebarCollapsed,
-            items: apiItems
-                .filter((item) => { var _a; return !!((_a = item.api.tags) === null || _a === void 0 ? void 0 : _a.includes(tag)); })
-                .map(createDocItem),
+            items: [...taggedSchemaItems, ...taggedApiItems].map(createDocItem),
         };
     })
         .filter((item) => item.items.length > 0); // Filter out any categories with no items.
@@ -157,14 +162,16 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
         ];
     }
     let schemas = [];
-    if (schemaItems.length > 0) {
+    if (showSchemas && schemaItems.length > 0) {
         schemas = [
             {
                 type: "category",
                 label: "Schemas",
                 collapsible: sidebarCollapsible,
                 collapsed: sidebarCollapsed,
-                items: schemaItems.map(createDocItem),
+                items: schemaItems
+                    .filter(({ schema }) => !schema["x-tags"])
+                    .map(createDocItem),
             },
         ];
     }
@@ -178,7 +185,9 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
 function generateSidebarSlice(sidebarOptions, options, api, tags, docPath, tagGroups) {
     let sidebarSlice = [];
     if (sidebarOptions.groupPathsBy === "tagGroup") {
+        let schemasGroup = [];
         tagGroups === null || tagGroups === void 0 ? void 0 : tagGroups.forEach((tagGroup) => {
+            var _a;
             //filter tags only included in group
             const filteredTags = [];
             tags[0].forEach((tag) => {
@@ -193,8 +202,18 @@ function generateSidebarSlice(sidebarOptions, options, api, tags, docPath, tagGr
                 collapsed: true,
                 items: groupByTags(api, sidebarOptions, options, [filteredTags], docPath),
             };
+            if (options.showSchemas) {
+                // For the first tagGroup, save the generated "Schemas" category for later.
+                if (schemasGroup.length === 0) {
+                    schemasGroup = (_a = groupCategory.items) === null || _a === void 0 ? void 0 : _a.filter((item) => item.type === "category" && item.label === "Schemas");
+                }
+                // Remove the "Schemas" category from every `groupCategory`.
+                groupCategory.items = groupCategory.items.filter((item) => "label" in item ? item.label !== "Schemas" : true);
+            }
             sidebarSlice.push(groupCategory);
         });
+        // Add `schemasGroup` to the end of the sidebar.
+        sidebarSlice.push(...schemasGroup);
     }
     else if (sidebarOptions.groupPathsBy === "tag") {
         sidebarSlice = groupByTags(api, sidebarOptions, options, tags, docPath);

package/lib/types.d.ts

@@ -1,8 +1,9 @@
-import type Request from "@paloaltonetworks/postman-collection";
+import type Request from "postman-collection";
 import { InfoObject, OperationObject, SchemaObject, SecuritySchemeObject, TagObject } from "./openapi/types";
 export type { PropSidebarItemCategory, SidebarItemLink, PropSidebar, PropSidebarItem, } from "@docusaurus/plugin-content-docs-types";
 export interface PluginOptions {
     id?: string;
+    docsPlugin?: string;
     docsPluginId: string;
     config: {
         [key: string]: APIOptions;
@@ -25,6 +26,7 @@ export interface APIOptions {
     proxy?: string;
     markdownGenerators?: MarkdownGenerator;
     showSchemas?: boolean;
+    disableCompression?: boolean;
 }
 export interface MarkdownGenerator {
     createApiPageMD?: (pageData: ApiPageMetadata) => string;
@@ -46,6 +48,7 @@ export interface APIVersionOptions {
     outputDir: string;
     label: string;
     baseUrl: string;
+    downloadUrl?: string;
 }
 export interface LoadedContent {
     loadedApi: ApiMetadata[];