docusaurus-plugin-openapi-docs 1.1.3 → 1.1.6

package/lib/sidebars/index.d.ts

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

package/lib/sidebars/index.js

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "1.1.3",
+  "version": "1.1.6",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -67,5 +67,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "4897267289b035aed8155f6001e14c80ba9003a8"
+  "gitHead": "fbac87dcd52678751a3fe73ab416e4778e77bbb1"
 }

package/src/markdown/createRequestBodyDetails.ts

@@ -5,13 +5,20 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { createSchemaDetails } from "./createSchemaDetails";
+import { MediaTypeObject } from "../openapi/types";
+import { createRequestSchema } from "./createRequestSchema";
 
 interface Props {
   title: string;
-  body: any;
+  body: {
+    content?: {
+      [key: string]: MediaTypeObject;
+    };
+    description?: string;
+    required?: boolean;
+  };
 }
 
-export function createRequestBodyDetails({ title, body }: Props) {
-  return createSchemaDetails({ title, body });
+export function createRequestBodyDetails({ title, body }: Props): any {
+  return createRequestSchema({ title, body });
 }