docusaurus-plugin-openapi-docs 1.0.1 → 1.0.2

package/README.md

@@ -110,12 +110,13 @@ Here is an example of properly configuring your `docusaurus.config.js` file for
 
 `sidebarOptions` can be configured with the following options:
 
-| Name                 | Type      | Default | Description                                                                                                                         |
-| -------------------- | --------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------- |
-| `groupPathsBy`       | `string`  | `null`  | Organize and group sidebar slice by specified option. Note: Currently, `groupPathsBy` only contains support for grouping by "tags". |
-| `sidebarCollapsible` | `boolean` | `true`  | Whether sidebar categories are collapsible by default.                                                                              |
-| `sidebarCollapsed`   | `boolean` | `true`  | Whether sidebar categories are collapsed by default.                                                                                |
-| `customProps`        | `object`  | `null`  | Additional props for customizing a sidebar item.                                                                                    |
+| Name                 | Type      | Default | Description                                                                                                                                                                                                                                                                                                                                                                                                                                          |
+| -------------------- | --------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `groupPathsBy`       | `string`  | `null`  | Organize and group sidebar slice by specified option. Note: Currently, `groupPathsBy` only contains support for grouping by "tags".                                                                                                                                                                                                                                                                                                                  |
+| `categoryLinkSource` | `string`  | `null`  | Defines what source to use for rendering category link pages when grouping paths by tag. <br/></br>The supported options are as follows: <br/></br> `tag`: Sets the category link config type to `generated-index` and uses the tag description as the link config description. <br/><br/>`info`: Sets the category link config type to `doc` and renders the `info` section as the category link (recommended only for multi/micro-spec scenarios). |
+| `sidebarCollapsible` | `boolean` | `true`  | Whether sidebar categories are collapsible by default.                                                                                                                                                                                                                                                                                                                                                                                               |
+| `sidebarCollapsed`   | `boolean` | `true`  | Whether sidebar categories are collapsed by default.                                                                                                                                                                                                                                                                                                                                                                                                 |
+| `customProps`        | `object`  | `null`  | Additional props for customizing a sidebar item.                                                                                                                                                                                                                                                                                                                                                                                                     |
 
 > Note: You may optionally configure a `sidebarOptions`. In doing so, an individual `sidebar.js` slice with the configured options will be generated within the respective `outputDir`.
 

package/lib/index.js

@@ -25,7 +25,7 @@ function pluginOpenAPI(context, options) {
         const contentPath = path_1.default.resolve(siteDir, specPath);
         try {
             const openapiFiles = await (0, openapi_1.readOpenapiFiles)(contentPath, {});
-            const loadedApi = await (0, openapi_1.processOpenapiFiles)(openapiFiles);
+            const [loadedApi, tags] = await (0, openapi_1.processOpenapiFiles)(openapiFiles);
             if (!fs_1.default.existsSync(outputDir)) {
                 try {
                     fs_1.default.mkdirSync(outputDir, { recursive: true });
@@ -38,7 +38,7 @@ function pluginOpenAPI(context, options) {
             // TODO: figure out better way to set default
             if (Object.keys(sidebarOptions !== null && sidebarOptions !== void 0 ? sidebarOptions : {}).length > 0) {
                 const sidebarSlice = (0, sidebars_1.default)(sidebarOptions, // TODO: find a better way to handle null
-                options, loadedApi);
+                options, loadedApi, tags);
                 const sidebarSliceTemplate = template
                     ? fs_1.default.readFileSync(template).toString()
                     : `module.exports = {{{slice}}};`;
@@ -59,7 +59,12 @@ function pluginOpenAPI(context, options) {
                 ? fs_1.default.readFileSync(template).toString()
                 : `---
 id: {{{id}}}
+{{^api}}
+sidebar_label: Introduction
+{{/api}}
+{{#api}}
 sidebar_label: {{{title}}}
+{{/api}}
 {{^api}}
 sidebar_position: 0
 {{/api}}
@@ -76,6 +81,23 @@ sidebar_class_name: "{{{api.method}}} api-method"
 ---
 
 {{{markdown}}}
+      `;
+            const infoMdTemplate = template
+                ? fs_1.default.readFileSync(template).toString()
+                : `---
+id: {{{id}}}
+sidebar_label: {{{title}}}
+hide_title: true
+---
+
+{{{markdown}}}
+
+\`\`\`mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+<DocCardList items={useCurrentSidebarCategory().items}/>
+\`\`\`
       `;
             loadedApi.map(async (item) => {
                 const markdown = item.type === "api" ? (0, markdown_1.createApiPageMD)(item) : (0, markdown_1.createInfoPageMD)(item);
@@ -84,6 +106,7 @@ sidebar_class_name: "{{{api.method}}} api-method"
                     item.json = JSON.stringify(item.api);
                 }
                 const view = (0, mustache_1.render)(mdTemplate, item);
+                const utils = (0, mustache_1.render)(infoMdTemplate, item);
                 if (item.type === "api") {
                     if (!fs_1.default.existsSync(`${outputDir}/${item.id}.api.mdx`)) {
                         try {
@@ -97,13 +120,15 @@ sidebar_class_name: "{{{api.method}}} api-method"
                 }
                 // TODO: determine if we actually want/need this
                 if (item.type === "info") {
-                    if (!fs_1.default.existsSync(`${outputDir}/index.api.mdx`)) {
+                    if (!fs_1.default.existsSync(`${outputDir}/${item.id}.info.mdx`)) {
                         try {
-                            fs_1.default.writeFileSync(`${outputDir}/index.api.mdx`, view, "utf8");
-                            console.log(chalk_1.default.green(`Successfully created "${outputDir}/index.api.mdx"`));
+                            (sidebarOptions === null || sidebarOptions === void 0 ? void 0 : sidebarOptions.categoryLinkSource) === "info" // Only use utils template if set to "info"
+                                ? fs_1.default.writeFileSync(`${outputDir}/${item.id}.info.mdx`, utils, "utf8")
+                                : fs_1.default.writeFileSync(`${outputDir}/${item.id}.info.mdx`, view, "utf8");
+                            console.log(chalk_1.default.green(`Successfully created "${outputDir}/${item.id}.info.mdx"`));
                         }
                         catch (err) {
-                            console.error(chalk_1.default.red(`Failed to write "${outputDir}/index.api.mdx"`), chalk_1.default.yellow(err));
+                            console.error(chalk_1.default.red(`Failed to write "${outputDir}/${item.id}.info.mdx"`), chalk_1.default.yellow(err));
                         }
                     }
                 }
@@ -119,7 +144,7 @@ sidebar_class_name: "{{{api.method}}} api-method"
     async function cleanApiDocs(options) {
         const { outputDir } = options;
         const apiDir = path_1.default.join(siteDir, outputDir);
-        const apiMdxFiles = await (0, utils_1.Globby)(["*.api.mdx"], {
+        const apiMdxFiles = await (0, utils_1.Globby)(["*.api.mdx", "*.info.mdx"], {
             cwd: path_1.default.resolve(apiDir),
         });
         const sidebarFile = await (0, utils_1.Globby)(["sidebar.js"], {

package/lib/markdown/createContactInfo.d.ts

@@ -0,0 +1,2 @@
+import { ContactObject } from "../openapi/types";
+export declare function createContactInfo(contact: ContactObject): string;

package/lib/markdown/createContactInfo.js

@@ -0,0 +1,49 @@
+"use strict";
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createContactInfo = void 0;
+const utils_1 = require("./utils");
+function createContactInfo(contact) {
+    if (!contact || !Object.keys(contact).length)
+        return "";
+    const { name, url, email } = contact;
+    return (0, utils_1.create)("div", {
+        style: {
+            display: "flex",
+            flexDirection: "column",
+            marginBottom: "var(--ifm-paragraph-margin-bottom)",
+        },
+        children: [
+            (0, utils_1.create)("h3", {
+                style: {
+                    marginBottom: "0.25rem",
+                },
+                children: "Contact",
+            }),
+            (0, utils_1.create)("span", {
+                children: [
+                    (0, utils_1.guard)(name, () => `${name}: `),
+                    (0, utils_1.guard)(email, () => (0, utils_1.create)("a", {
+                        href: `mailto:${email}`,
+                        children: `${email}`,
+                    })),
+                ],
+            }),
+            (0, utils_1.guard)(url, () => (0, utils_1.create)("span", {
+                children: [
+                    "URL: ",
+                    (0, utils_1.create)("a", {
+                        href: `${url}`,
+                        children: `${url}`,
+                    }),
+                ],
+            })),
+        ],
+    });
+}
+exports.createContactInfo = createContactInfo;

package/lib/markdown/createLicense.d.ts

@@ -0,0 +1,2 @@
+import { LicenseObject } from "../openapi/types";
+export declare function createLicense(license: LicenseObject): string;

package/lib/markdown/createLicense.js

@@ -0,0 +1,33 @@
+"use strict";
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLicense = void 0;
+const utils_1 = require("./utils");
+function createLicense(license) {
+    if (!license || !Object.keys(license).length)
+        return "";
+    const { name, url } = license;
+    return (0, utils_1.create)("div", {
+        style: {
+            marginBottom: "var(--ifm-paragraph-margin-bottom)",
+        },
+        children: [
+            (0, utils_1.create)("h3", {
+                style: {
+                    marginBottom: "0.25rem",
+                },
+                children: "License",
+            }),
+            (0, utils_1.guard)(url, () => (0, utils_1.create)("a", {
+                href: url,
+                children: name !== null && name !== void 0 ? name : url,
+            })),
+        ],
+    });
+}
+exports.createLicense = createLicense;

package/lib/markdown/createSchemaDetails.js

@@ -185,7 +185,10 @@ function createRowsRoot({ schema }) {
     });
 }
 function createSchemaDetails({ title, body, ...rest }) {
-    if (body === undefined || body.content === undefined) {
+    if (body === undefined ||
+        body.content === undefined ||
+        Object.keys(body).length === 0 ||
+        Object.keys(body.content).length === 0) {
         return undefined;
     }
     // TODO:

package/lib/markdown/createStatusCodes.js

@@ -20,7 +20,7 @@ function createStatusCodes({ responses }) {
     }
     return (0, utils_1.create)("div", {
         children: [
-            (0, utils_1.create)("Tabs", {
+            (0, utils_1.create)("ApiTabs", {
                 children: codes.map((code) => {
                     return (0, utils_1.create)("TabItem", {
                         label: code,

package/lib/markdown/createTermsOfService.d.ts

@@ -0,0 +1 @@
+export declare function createTermsOfService(termsOfService: string | undefined): string;

package/lib/markdown/createTermsOfService.js

@@ -0,0 +1,32 @@
+"use strict";
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTermsOfService = void 0;
+const utils_1 = require("./utils");
+function createTermsOfService(termsOfService) {
+    if (!termsOfService)
+        return "";
+    return (0, utils_1.create)("div", {
+        style: {
+            marginBottom: "var(--ifm-paragraph-margin-bottom)",
+        },
+        children: [
+            (0, utils_1.create)("h3", {
+                style: {
+                    marginBottom: "0.25rem",
+                },
+                children: "Terms of Service",
+            }),
+            (0, utils_1.create)("a", {
+                href: `${termsOfService}`,
+                children: termsOfService,
+            }),
+        ],
+    });
+}
+exports.createTermsOfService = createTermsOfService;

package/lib/markdown/index.d.ts

@@ -1,3 +1,3 @@
 import { ApiPageMetadata, InfoPageMetadata } from "../types";
 export declare function createApiPageMD({ title, api: { deprecated, "x-deprecated-description": deprecatedDescription, description, parameters, requestBody, responses, }, }: ApiPageMetadata): string;
-export declare function createInfoPageMD({ info: { title, version, description }, }: InfoPageMetadata): string;
+export declare function createInfoPageMD({ info: { title, version, description, contact, license, termsOfService }, }: InfoPageMetadata): string;

package/lib/markdown/index.js

@@ -8,18 +8,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createInfoPageMD = exports.createApiPageMD = void 0;
 const lodash_1 = require("lodash");
+const createContactInfo_1 = require("./createContactInfo");
 const createDeprecationNotice_1 = require("./createDeprecationNotice");
 const createDescription_1 = require("./createDescription");
+const createLicense_1 = require("./createLicense");
 const createParamsDetails_1 = require("./createParamsDetails");
 const createRequestBodyDetails_1 = require("./createRequestBodyDetails");
 const createStatusCodes_1 = require("./createStatusCodes");
+const createTermsOfService_1 = require("./createTermsOfService");
 const createVersionBadge_1 = require("./createVersionBadge");
 const utils_1 = require("./utils");
 function createApiPageMD({ title, api: { deprecated, "x-deprecated-description": deprecatedDescription, description, parameters, requestBody, responses, }, }) {
     return (0, utils_1.render)([
         `import ParamsItem from "@theme/ParamsItem";\n`,
         `import SchemaItem from "@theme/SchemaItem"\n`,
-        `import Tabs from "@theme/Tabs";\n`,
+        `import ApiTabs from "@theme/ApiTabs";\n`,
         `import TabItem from "@theme/TabItem";\n\n`,
         `## ${(0, lodash_1.escape)(title)}\n\n`,
         (0, createDeprecationNotice_1.createDeprecationNotice)({ deprecated, description: deprecatedDescription }),
@@ -33,11 +36,14 @@ function createApiPageMD({ title, api: { deprecated, "x-deprecated-description":
     ]);
 }
 exports.createApiPageMD = createApiPageMD;
-function createInfoPageMD({ info: { title, version, description }, }) {
+function createInfoPageMD({ info: { title, version, description, contact, license, termsOfService }, }) {
     return (0, utils_1.render)([
         (0, createVersionBadge_1.createVersionBadge)(version),
         `# ${(0, lodash_1.escape)(title)}\n\n`,
         (0, createDescription_1.createDescription)(description),
+        (0, createContactInfo_1.createContactInfo)(contact),
+        (0, createTermsOfService_1.createTermsOfService)(termsOfService),
+        (0, createLicense_1.createLicense)(license),
     ]);
 }
 exports.createInfoPageMD = createInfoPageMD;

package/lib/openapi/openapi.d.ts

@@ -1,11 +1,12 @@
 import { ApiMetadata } from "../types";
-import { OpenApiObjectWithRef } from "./types";
+import { OpenApiObjectWithRef, TagObject } from "./types";
 interface OpenApiFiles {
     source: string;
     sourceDirName: string;
     data: OpenApiObjectWithRef;
 }
 export declare function readOpenapiFiles(openapiPath: string, _options: {}): Promise<OpenApiFiles[]>;
-export declare function processOpenapiFiles(files: OpenApiFiles[]): Promise<ApiMetadata[]>;
-export declare function processOpenapiFile(openapiDataWithRefs: OpenApiObjectWithRef): Promise<ApiMetadata[]>;
+export declare function processOpenapiFiles(files: OpenApiFiles[]): Promise<[ApiMetadata[], TagObject[]]>;
+export declare function processOpenapiFile(openapiDataWithRefs: OpenApiObjectWithRef): Promise<[ApiMetadata[], TagObject[]]>;
+export declare function getTagDisplayName(tagName: string, tags: TagObject[]): string;
 export {};

package/lib/openapi/openapi.js

@@ -9,11 +9,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.processOpenapiFile = exports.processOpenapiFiles = exports.readOpenapiFiles = void 0;
+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"));
-// @ts-ignore
 const postman_collection_1 = __importDefault(require("@paloaltonetworks/postman-collection"));
 const chalk_1 = __importDefault(require("chalk"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
@@ -65,22 +64,24 @@ async function createPostmanCollection(openapiData) {
     return await jsonToCollection(data);
 }
 function createItems(openapiData) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
     // TODO: Find a better way to handle this
     let items = [];
     // Only create an info page if we have a description.
     if (openapiData.info.description) {
+        const infoId = (0, lodash_1.kebabCase)(openapiData.info.title);
         const infoPage = {
             type: "info",
-            id: "introduction",
-            unversionedId: "introduction",
-            title: "Introduction",
+            id: infoId,
+            unversionedId: infoId,
+            title: openapiData.info.title,
             description: openapiData.info.description,
-            slug: "/introduction",
+            slug: "/" + infoId,
             frontMatter: {},
             info: {
                 ...openapiData.info,
-                title: (_a = openapiData.info.title) !== null && _a !== void 0 ? _a : "Introduction",
+                tags: (_a = openapiData.tags) === null || _a === void 0 ? void 0 : _a.map((tagName) => { var _a; return getTagDisplayName(tagName.name, (_a = openapiData.tags) !== null && _a !== void 0 ? _a : []); }),
+                title: (_b = openapiData.info.title) !== null && _b !== void 0 ? _b : "Introduction",
             },
         };
         items.push(infoPage);
@@ -88,16 +89,16 @@ function createItems(openapiData) {
     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 = (_c = (_b = operationObject.summary) !== null && _b !== void 0 ? _b : operationObject.operationId) !== null && _c !== void 0 ? _c : "Missing summary";
+            const title = (_d = (_c = operationObject.summary) !== null && _c !== void 0 ? _c : operationObject.operationId) !== null && _d !== void 0 ? _d : "Missing summary";
             if (operationObject.description === undefined) {
                 operationObject.description =
-                    (_e = (_d = operationObject.summary) !== null && _d !== void 0 ? _d : operationObject.operationId) !== null && _e !== void 0 ? _e : "";
+                    (_f = (_e = operationObject.summary) !== null && _e !== void 0 ? _e : operationObject.operationId) !== null && _f !== void 0 ? _f : "";
             }
             const baseId = (0, lodash_1.kebabCase)(title);
-            const servers = (_g = (_f = operationObject.servers) !== null && _f !== void 0 ? _f : pathObject.servers) !== null && _g !== void 0 ? _g : openapiData.servers;
-            const security = (_h = operationObject.security) !== null && _h !== void 0 ? _h : openapiData.security;
+            const servers = (_h = (_g = operationObject.servers) !== null && _g !== void 0 ? _g : pathObject.servers) !== null && _h !== void 0 ? _h : openapiData.servers;
+            const security = (_j = operationObject.security) !== null && _j !== void 0 ? _j : openapiData.security;
             // Add security schemes so we know how to handle security.
-            const securitySchemes = (_j = openapiData.components) === null || _j === void 0 ? void 0 : _j.securitySchemes;
+            const securitySchemes = (_k = openapiData.components) === null || _k === void 0 ? void 0 : _k.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)) {
@@ -107,7 +108,7 @@ function createItems(openapiData) {
                 }
             }
             let jsonRequestBodyExample;
-            const body = (_l = (_k = operationObject.requestBody) === null || _k === void 0 ? void 0 : _k.content) === null || _l === void 0 ? void 0 : _l["application/json"];
+            const body = (_m = (_l = operationObject.requestBody) === null || _l === void 0 ? void 0 : _l.content) === null || _m === void 0 ? void 0 : _m["application/json"];
             if (body === null || body === void 0 ? void 0 : body.schema) {
                 jsonRequestBodyExample = (0, createExample_1.sampleFromSchema)(body.schema);
             }
@@ -123,7 +124,7 @@ function createItems(openapiData) {
                 frontMatter: {},
                 api: {
                     ...defaults,
-                    tags: (_m = operationObject.tags) === null || _m === void 0 ? void 0 : _m.map((tagName) => { var _a; return getTagDisplayName(tagName, (_a = openapiData.tags) !== null && _a !== void 0 ? _a : []); }),
+                    tags: (_o = operationObject.tags) === null || _o === void 0 ? void 0 : _o.map((tagName) => { var _a; return getTagDisplayName(tagName, (_a = openapiData.tags) !== null && _a !== void 0 ? _a : []); }),
                     method,
                     path,
                     servers,
@@ -142,7 +143,6 @@ function createItems(openapiData) {
  * Attach Postman Request objects to the corresponding ApiItems.
  */
 function bindCollectionToApiItems(items, postmanCollection) {
-    // @ts-ignore
     postmanCollection.forEachItem((item) => {
         const method = item.request.method.toLowerCase();
         const path = item.request.url
@@ -194,14 +194,23 @@ async function readOpenapiFiles(openapiPath, _options) {
 exports.readOpenapiFiles = readOpenapiFiles;
 async function processOpenapiFiles(files) {
     const promises = files.map(async (file) => {
-        const items = await processOpenapiFile(file.data);
-        return items.map((item) => ({
+        const processedFile = await processOpenapiFile(file.data);
+        const itemsObjectsArray = processedFile[0].map((item) => ({
             ...item,
         }));
+        const tags = processedFile[1];
+        return [itemsObjectsArray, tags];
     });
     const metadata = await Promise.all(promises);
-    const items = metadata.flat();
-    return items;
+    const items = metadata
+        .map(function (x) {
+        return x[0];
+    })
+        .flat();
+    const tags = metadata.map(function (x) {
+        return x[1];
+    });
+    return [items, tags];
 }
 exports.processOpenapiFiles = processOpenapiFiles;
 async function processOpenapiFile(openapiDataWithRefs) {
@@ -209,7 +218,11 @@ async function processOpenapiFile(openapiDataWithRefs) {
     const postmanCollection = await createPostmanCollection(openapiData);
     const items = createItems(openapiData);
     bindCollectionToApiItems(items, postmanCollection);
-    return items;
+    let tags = [];
+    if (openapiData.tags !== undefined) {
+        tags = openapiData.tags;
+    }
+    return [items, tags];
 }
 exports.processOpenapiFile = processOpenapiFile;
 // order for picking items as a display name of tags
@@ -231,3 +244,4 @@ function getTagDisplayName(tagName, tags) {
     // always default to the tagName
     return tagName;
 }
+exports.getTagDisplayName = getTagDisplayName;

package/lib/openapi/types.d.ts

@@ -29,6 +29,7 @@ export interface InfoObject {
     contact?: ContactObject;
     license?: LicenseObject;
     version: string;
+    tags?: String[];
 }
 export interface ContactObject {
     name?: string;
@@ -151,6 +152,7 @@ export interface ParameterObject {
     example?: any;
     examples?: Map<ExampleObject>;
     content?: Map<MediaTypeObject>;
+    param?: Object;
 }
 export interface ParameterObjectWithRef {
     name: string;
@@ -236,7 +238,7 @@ export interface LinkObject {
 export declare type HeaderObject = Omit<ParameterObject, "name" | "in">;
 export declare type HeaderObjectWithRef = Omit<ParameterObjectWithRef, "name" | "in">;
 export interface TagObject {
-    name: string;
+    name?: string;
     description?: string;
     externalDocs?: ExternalDocumentationObject;
     "x-displayName"?: string;
@@ -304,6 +306,8 @@ export interface HttpSecuritySchemeObject {
     description?: string;
     scheme: string;
     bearerFormat?: string;
+    name?: string;
+    in?: string;
 }
 export interface Oauth2SecuritySchemeObject {
     type: "oauth2";

package/lib/sidebars/index.d.ts

@@ -1,3 +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[]): ProcessedSidebar;
+export default function generateSidebarSlice(sidebarOptions: SidebarOptions, options: APIOptions, api: ApiMetadata[], tags: TagObject[]): ProcessedSidebar;

package/lib/sidebars/index.js

@@ -10,25 +10,29 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const clsx_1 = __importDefault(require("clsx"));
+const lodash_1 = require("lodash");
 const uniq_1 = __importDefault(require("lodash/uniq"));
 function isApiItem(item) {
     return item.type === "api";
 }
-function groupByTags(items, sidebarOptions, options) {
-    // TODO: Figure out how to handle these
-    // const intros = items.filter(isInfoItem).map((item) => {
-    //   return {
-    //     type: "link" as const,
-    //     label: item.title,
-    //     href: item.permalink,
-    //     docId: item.id,
-    //   };
-    // });
+function isInfoItem(item) {
+    return item.type === "info";
+}
+function groupByTags(items, sidebarOptions, options, tags) {
     const { outputDir } = options;
-    const { sidebarCollapsed, sidebarCollapsible, customProps } = sidebarOptions;
+    const { sidebarCollapsed, sidebarCollapsible, customProps, categoryLinkSource, } = sidebarOptions;
     const apiItems = items.filter(isApiItem);
+    const infoItems = items.filter(isInfoItem);
+    const intros = infoItems.map((item) => {
+        return {
+            id: item.id,
+            title: item.title,
+            description: item.description,
+            tags: item.info.tags,
+        };
+    });
     // TODO: make sure we only take the first tag
-    const tags = (0, uniq_1.default)(apiItems
+    const apiTags = (0, uniq_1.default)(apiItems
         .flatMap((item) => item.api.tags)
         .filter((item) => !!item));
     // TODO: optimize this or make it a function
@@ -51,11 +55,56 @@ function groupByTags(items, sidebarOptions, options) {
             }, item.api.method),
         };
     }
-    const tagged = tags
+    let rootIntroDoc = undefined;
+    if (infoItems.length === 1) {
+        const infoItem = infoItems[0];
+        const id = infoItem.id;
+        rootIntroDoc = {
+            type: "doc",
+            id: `${basePath}/${id}`,
+        };
+    }
+    const tagged = apiTags
         .map((tag) => {
+        // Map info object to tag
+        const infoObject = intros.find((i) => i.tags.includes(tag));
+        const tagObject = tags.flat().find((t) => {
+            var _a;
+            return (_a = (tag === t.name || tag === t["x-displayName"])) !== null && _a !== void 0 ? _a : {
+                name: tag,
+                description: `${tag} Index`,
+            };
+        });
+        // TODO: perhaps move this into a getLinkConfig() function
+        let linkConfig = undefined;
+        if (infoObject !== undefined && categoryLinkSource === "info") {
+            linkConfig = {
+                type: "doc",
+                id: `${basePath}/${infoObject.id}`,
+            };
+        }
+        // TODO: perhaps move this into a getLinkConfig() function
+        if (tagObject !== undefined && categoryLinkSource === "tag") {
+            const linkDescription = tagObject === null || tagObject === void 0 ? void 0 : tagObject.description;
+            linkConfig = {
+                type: "generated-index",
+                title: tag,
+                description: linkDescription,
+                slug: "/category/" + (0, lodash_1.kebabCase)(tag),
+            };
+        }
+        // Default behavior
+        if (categoryLinkSource === undefined) {
+            linkConfig = {
+                type: "generated-index",
+                title: tag,
+                slug: "/category/" + (0, lodash_1.kebabCase)(tag),
+            };
+        }
         return {
             type: "category",
             label: tag,
+            link: linkConfig,
             collapsible: sidebarCollapsible,
             collapsed: sidebarCollapsed,
             items: apiItems
@@ -64,25 +113,29 @@ function groupByTags(items, sidebarOptions, options) {
         };
     })
         .filter((item) => item.items.length > 0); // Filter out any categories with no items.
+    // TODO: determine how we want to handle these
     // const untagged = [
-    //   // TODO: determine if needed and how
     //   {
     //     type: "category" as const,
     //     label: "UNTAGGED",
-    //     // collapsible: options.sidebarCollapsible, TODO: add option
-    //     // collapsed: options.sidebarCollapsed, TODO: add option
+    //     collapsible: sidebarCollapsible,
+    //     collapsed: sidebarCollapsed,
     //     items: apiItems
-    //       //@ts-ignore
     //       .filter(({ api }) => api.tags === undefined || api.tags.length === 0)
     //       .map(createDocItem),
     //   },
     // ];
+    // Shift root intro doc to top of sidebar
+    // TODO: Add input validation for categoryLinkSource options
+    if (rootIntroDoc && categoryLinkSource !== "info") {
+        tagged.unshift(rootIntroDoc);
+    }
     return [...tagged];
 }
-function generateSidebarSlice(sidebarOptions, options, api) {
+function generateSidebarSlice(sidebarOptions, options, api, tags) {
     let sidebarSlice = [];
     if (sidebarOptions.groupPathsBy === "tags") {
-        sidebarSlice = groupByTags(api, sidebarOptions, options);
+        sidebarSlice = groupByTags(api, sidebarOptions, options, tags);
     }
     return sidebarSlice;
 }