docusaurus-plugin-openapi-docs 0.0.0-418 → 0.0.0-421

package/lib/markdown/createSchemaDetails.d.ts

@@ -7,7 +7,7 @@ interface Props {
             [key: string]: MediaTypeObject;
         };
         description?: string;
-        required?: boolean;
+        required?: string[] | boolean;
     };
 }
 export declare function createSchemaDetails({ title, body, ...rest }: Props): string | undefined;

package/lib/markdown/createSchemaDetails.js

@@ -192,7 +192,8 @@ function createItems(schema) {
         return createAnyOneOf(schema.items);
     }
     if (((_e = schema.items) === null || _e === void 0 ? void 0 : _e.allOf) !== undefined) {
-        const { mergedSchemas } = mergeAllOf((_f = schema.items) === null || _f === void 0 ? void 0 : _f.allOf);
+        // TODO: figure out if and how we should pass merged required array
+        const { mergedSchemas, } = mergeAllOf((_f = schema.items) === null || _f === void 0 ? void 0 : _f.allOf);
         // Handles combo anyOf/oneOf + properties
         if ((mergedSchemas.oneOf !== undefined ||
             mergedSchemas.anyOf !== undefined) &&
@@ -331,7 +332,7 @@ function createDetailsNode(name, schemaName, schema, required) {
                                 style: { opacity: "0.6" },
                                 children: ` ${schemaName}`,
                             }),
-                            (0, utils_1.guard)(required, () => [
+                            (0, utils_1.guard)(schema.required && schema.required === true, () => [
                                 (0, utils_1.create)("strong", {
                                     style: {
                                         fontSize: "var(--ifm-code-font-size)",
@@ -427,6 +428,7 @@ function createPropertyDiscriminator(name, schemaName, schema, discriminator, re
 function createEdges({ name, schema, required, discriminator, }) {
     var _a, _b;
     const schemaName = (0, schema_1.getSchemaName)(schema);
+    // if (name === "id") console.log(name, schema, required);
     if (discriminator !== undefined && discriminator.propertyName === name) {
         return createPropertyDiscriminator(name, "string", schema, discriminator, required);
     }
@@ -453,7 +455,7 @@ function createEdges({ name, schema, required, discriminator, }) {
         return (0, utils_1.create)("SchemaItem", {
             collapsible: false,
             name,
-            required,
+            required: Array.isArray(required) ? required.includes(name) : required,
             schemaDescription: mergedSchemas.description,
             schemaName: schemaName,
             qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
@@ -474,7 +476,7 @@ function createEdges({ name, schema, required, discriminator, }) {
     return (0, utils_1.create)("SchemaItem", {
         collapsible: false,
         name,
-        required,
+        required: Array.isArray(required) ? required.includes(name) : required,
         schemaDescription: schema.description,
         schemaName: schemaName,
         qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
@@ -573,7 +575,7 @@ function createSchemaDetails({ title, body, ...rest }) {
                                             style: { opacity: "0.6" },
                                             children: ` array`,
                                         })),
-                                        (0, utils_1.guard)(body.required, () => [
+                                        (0, utils_1.guard)(body.required && body.required === true, () => [
                                             (0, utils_1.create)("strong", {
                                                 style: {
                                                     fontSize: "var(--ifm-code-font-size)",

package/lib/openapi/openapi.js

@@ -59,7 +59,7 @@ async function createPostmanCollection(openapiData) {
     return await jsonToCollection(data);
 }
 function createItems(openapiData, sidebarOptions) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
     // TODO: Find a better way to handle this
     let items = [];
     const infoId = (0, kebabCase_1.default)(openapiData.info.title);
@@ -100,8 +100,8 @@ function createItems(openapiData, sidebarOptions) {
             securitySchemes: (_b = openapiData.components) === null || _b === void 0 ? void 0 : _b.securitySchemes,
             info: {
                 ...openapiData.info,
-                tags: (_c = openapiData.tags) === null || _c === void 0 ? void 0 : _c.map((tagName) => { var _a; return getTagDisplayName(tagName.name, (_a = openapiData.tags) !== null && _a !== void 0 ? _a : []); }),
-                title: (_d = openapiData.info.title) !== null && _d !== void 0 ? _d : "Introduction",
+                tags: openapiData.tags,
+                title: (_c = openapiData.info.title) !== null && _c !== void 0 ? _c : "Introduction",
                 logo: openapiData.info["x-logo"],
                 darkLogo: openapiData.info["x-dark-logo"],
             },
@@ -111,18 +111,18 @@ function createItems(openapiData, sidebarOptions) {
     for (let [path, pathObject] of Object.entries(openapiData.paths)) {
         const { $ref, description, parameters, servers, summary, ...rest } = pathObject;
         for (let [method, operationObject] of Object.entries({ ...rest })) {
-            const title = (_f = (_e = operationObject.summary) !== null && _e !== void 0 ? _e : operationObject.operationId) !== null && _f !== void 0 ? _f : "Missing summary";
+            const title = (_e = (_d = operationObject.summary) !== null && _d !== void 0 ? _d : operationObject.operationId) !== null && _e !== void 0 ? _e : "Missing summary";
             if (operationObject.description === undefined) {
                 operationObject.description =
-                    (_h = (_g = operationObject.summary) !== null && _g !== void 0 ? _g : operationObject.operationId) !== null && _h !== void 0 ? _h : "";
+                    (_g = (_f = operationObject.summary) !== null && _f !== void 0 ? _f : operationObject.operationId) !== null && _g !== void 0 ? _g : "";
             }
             const baseId = operationObject.operationId
                 ? (0, kebabCase_1.default)(operationObject.operationId)
                 : (0, kebabCase_1.default)(operationObject.summary);
-            const servers = (_k = (_j = operationObject.servers) !== null && _j !== void 0 ? _j : pathObject.servers) !== null && _k !== void 0 ? _k : openapiData.servers;
-            const security = (_l = operationObject.security) !== null && _l !== void 0 ? _l : openapiData.security;
+            const servers = (_j = (_h = operationObject.servers) !== null && _h !== void 0 ? _h : pathObject.servers) !== null && _j !== void 0 ? _j : openapiData.servers;
+            const security = (_k = operationObject.security) !== null && _k !== void 0 ? _k : openapiData.security;
             // Add security schemes so we know how to handle security.
-            const securitySchemes = (_m = openapiData.components) === null || _m === void 0 ? void 0 : _m.securitySchemes;
+            const securitySchemes = (_l = openapiData.components) === null || _l === void 0 ? void 0 : _l.securitySchemes;
             // Make sure schemes are lowercase. See: https://github.com/cloud-annotations/docusaurus-plugin-openapi/issues/79
             if (securitySchemes) {
                 for (let securityScheme of Object.values(securitySchemes)) {
@@ -132,12 +132,12 @@ 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 = (_q = operationObject.requestBody) === null || _q === void 0 ? void 0 : _q.content;
+            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")) {
@@ -159,7 +159,7 @@ function createItems(openapiData, sidebarOptions) {
                 frontMatter: {},
                 api: {
                     ...defaults,
-                    tags: (_r = operationObject.tags) === null || _r === void 0 ? void 0 : _r.map((tagName) => { var _a; return getTagDisplayName(tagName, (_a = openapiData.tags) !== null && _a !== void 0 ? _a : []); }),
+                    tags: operationObject.tags,
                     method,
                     path,
                     servers,
@@ -259,7 +259,7 @@ async function processOpenapiFiles(files, sidebarOptions) {
         // Remove undefined tags due to transient parsing errors
         return x !== undefined;
     });
-    return [items, tags];
+    return [items, tags[0]];
 }
 exports.processOpenapiFiles = processOpenapiFiles;
 async function processOpenapiFile(openapiData, sidebarOptions) {

package/lib/openapi/types.d.ts

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

package/lib/sidebars/index.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.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": "0.0.0-418",
+  "version": "0.0.0-421",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -67,5 +67,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "67e537ef8240524a94e5cdb38220b2fd499c61e0"
+  "gitHead": "5ca3bcb461f9dad4a78d51fb7c3c59657528e24e"
 }

package/src/markdown/createSchemaDetails.ts

@@ -227,8 +227,12 @@ function createItems(schema: SchemaObject) {
   }
 
   if (schema.items?.allOf !== undefined) {
-    const { mergedSchemas }: { mergedSchemas: SchemaObject; required: any } =
-      mergeAllOf(schema.items?.allOf);
+    // TODO: figure out if and how we should pass merged required array
+    const {
+      mergedSchemas,
+    }: { mergedSchemas: SchemaObject; required: string[] } = mergeAllOf(
+      schema.items?.allOf
+    );
 
     // Handles combo anyOf/oneOf + properties
     if (
@@ -387,7 +391,7 @@ function createDetailsNode(
   name: string,
   schemaName: string,
   schema: SchemaObject,
-  required: any
+  required: string[] | boolean
 ): any {
   return create("SchemaItem", {
     collapsible: true,
@@ -402,7 +406,7 @@ function createDetailsNode(
                 style: { opacity: "0.6" },
                 children: ` ${schemaName}`,
               }),
-              guard(required, () => [
+              guard(schema.required && schema.required === true, () => [
                 create("strong", {
                   style: {
                     fontSize: "var(--ifm-code-font-size)",
@@ -446,7 +450,7 @@ function createPropertyDiscriminator(
   schemaName: string,
   schema: SchemaObject,
   discriminator: any,
-  required: any
+  required: string[] | boolean
 ): any {
   if (schema === undefined) {
     return undefined;
@@ -515,7 +519,7 @@ function createPropertyDiscriminator(
 interface EdgeProps {
   name: string;
   schema: SchemaObject;
-  required: boolean;
+  required: string[] | boolean;
   discriminator?: any | unknown;
 }
 
@@ -530,6 +534,8 @@ function createEdges({
 }: EdgeProps): any {
   const schemaName = getSchemaName(schema);
 
+  // if (name === "id") console.log(name, schema, required);
+
   if (discriminator !== undefined && discriminator.propertyName === name) {
     return createPropertyDiscriminator(
       name,
@@ -548,9 +554,8 @@ function createEdges({
     const {
       mergedSchemas,
       required,
-    }: { mergedSchemas: SchemaObject; required: any } = mergeAllOf(
-      schema.allOf
-    );
+    }: { mergedSchemas: SchemaObject; required: string[] | boolean } =
+      mergeAllOf(schema.allOf);
     const mergedSchemaName = getSchemaName(mergedSchemas);
 
     if (
@@ -576,7 +581,7 @@ function createEdges({
     return create("SchemaItem", {
       collapsible: false,
       name,
-      required,
+      required: Array.isArray(required) ? required.includes(name) : required,
       schemaDescription: mergedSchemas.description,
       schemaName: schemaName,
       qualifierMessage: getQualifierMessage(schema),
@@ -601,7 +606,7 @@ function createEdges({
   return create("SchemaItem", {
     collapsible: false,
     name,
-    required,
+    required: Array.isArray(required) ? required.includes(name) : required,
     schemaDescription: schema.description,
     schemaName: schemaName,
     qualifierMessage: getQualifierMessage(schema),
@@ -685,7 +690,7 @@ interface Props {
       [key: string]: MediaTypeObject;
     };
     description?: string;
-    required?: boolean;
+    required?: string[] | boolean;
   };
 }
 
@@ -734,7 +739,7 @@ export function createSchemaDetails({ title, body, ...rest }: Props) {
                         children: ` array`,
                       })
                     ),
-                    guard(body.required, () => [
+                    guard(body.required && body.required === true, () => [
                       create("strong", {
                         style: {
                           fontSize: "var(--ifm-code-font-size)",

package/src/openapi/openapi.ts

@@ -124,9 +124,7 @@ function createItems(
       securitySchemes: openapiData.components?.securitySchemes,
       info: {
         ...openapiData.info,
-        tags: openapiData.tags?.map((tagName) =>
-          getTagDisplayName(tagName.name!, openapiData.tags ?? [])
-        ),
+        tags: openapiData.tags,
         title: openapiData.info.title ?? "Introduction",
         logo: openapiData.info["x-logo"]! as any,
         darkLogo: openapiData.info["x-dark-logo"]! as any,
@@ -200,9 +198,7 @@ function createItems(
         frontMatter: {},
         api: {
           ...defaults,
-          tags: operationObject.tags?.map((tagName) =>
-            getTagDisplayName(tagName, openapiData.tags ?? [])
-          ),
+          tags: operationObject.tags,
           method,
           path,
           servers,
@@ -338,7 +334,7 @@ export async function processOpenapiFiles(
       // Remove undefined tags due to transient parsing errors
       return x !== undefined;
     });
-  return [items as ApiMetadata[], tags as TagObject[]];
+  return [items as ApiMetadata[], tags[0] as TagObject[]];
 }
 
 export async function processOpenapiFile(

package/src/openapi/types.ts

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

package/src/sidebars/index.ts

@@ -60,12 +60,20 @@ function groupByTags(
   });
 
   // TODO: make sure we only take the first tag
-  const apiTags = uniq(
+  const operationTags = uniq(
     apiItems
       .flatMap((item) => item.api.tags)
       .filter((item): item is string => !!item)
   );
 
+  // Only include operation tags that are globally defined
+  const apiTags: string[] = [];
+  tags.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, "");
@@ -107,7 +115,7 @@ function groupByTags(
       );
       const tagObject = tags.flat().find(
         (t) =>
-          (tag === t.name || tag === t["x-displayName"]) ?? {
+          tag === t.name ?? {
             name: tag,
             description: `${tag} Index`,
           }
@@ -148,7 +156,7 @@ function groupByTags(
 
       return {
         type: "category" as const,
-        label: tag,
+        label: tagObject?.["x-displayName"] ?? tag,
         link: linkConfig,
         collapsible: sidebarCollapsible,
         collapsed: sidebarCollapsed,