docusaurus-plugin-openapi-docs 2.1.1 → 2.1.3

package/lib/markdown/createSchema.d.ts

@@ -4,7 +4,7 @@ import { SchemaObject } from "../openapi/types";
  */
 export declare function mergeAllOf(allOf: SchemaObject[]): {
     mergedSchemas: any;
-    required: any;
+    mergedRequired: any;
 };
 /**
  * Creates a hierarchical level of a schema tree. Nodes produce edges that can branch into sub-nodes with edges, recursively.

package/lib/markdown/createSchema.js

@@ -40,14 +40,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;
 /**
@@ -491,7 +491,7 @@ 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);
         const mergedSchemaName = (0, schema_1.getSchemaName)(mergedSchemas);
         if (mergedSchemas.oneOf !== undefined ||
             mergedSchemas.anyOf !== undefined) {
@@ -521,8 +521,8 @@ function createEdges({ name, schema, required, discriminator, }) {
             collapsible: false,
             name,
             required: Array.isArray(required) ? required.includes(name) : required,
-            schemaName: schemaName,
-            qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
+            schemaName: mergedSchemaName,
+            qualifierMessage: (0, schema_1.getQualifierMessage)(mergedSchemas),
             schema: mergedSchemas,
         });
     }
@@ -610,9 +610,16 @@ function createNodes(schema, schemaType) {
             style: {
                 marginTop: ".5rem",
                 marginBottom: ".5rem",
-                marginLeft: "1rem",
             },
-            children: (0, createDescription_1.createDescription)(schema.type),
+            children: [
+                (0, createDescription_1.createDescription)(schema.type),
+                (0, utils_1.guard)((0, schema_1.getQualifierMessage)(schema), (message) => (0, utils_1.create)("div", {
+                    style: {
+                        paddingTop: "1rem",
+                    },
+                    children: (0, createDescription_1.createDescription)(message),
+                })),
+            ],
         });
     }
     // handle circular references
@@ -621,9 +628,16 @@ function createNodes(schema, schemaType) {
             style: {
                 marginTop: ".5rem",
                 marginBottom: ".5rem",
-                marginLeft: "1rem",
             },
-            children: [(0, createDescription_1.createDescription)(schema)],
+            children: [
+                (0, createDescription_1.createDescription)(schema),
+                (0, utils_1.guard)((0, schema_1.getQualifierMessage)(schema), (message) => (0, utils_1.create)("div", {
+                    style: {
+                        paddingTop: "1rem",
+                    },
+                    children: (0, createDescription_1.createDescription)(message),
+                })),
+            ],
         });
     }
     // Unknown node/schema type should return undefined

package/lib/markdown/schema.js

@@ -35,6 +35,9 @@ function prettyName(schema, circular) {
         return (_d = (_c = schema.xml) === null || _c === void 0 ? void 0 : _c.name) !== null && _d !== void 0 ? _d : schema.type;
         // return schema.type;
     }
+    if (schema.title && schema.type) {
+        return `${schema.title} (${schema.type})`;
+    }
     return (_e = schema.title) !== null && _e !== void 0 ? _e : schema.type;
 }
 function getSchemaName(schema, circular) {

package/lib/sidebars/index.js

@@ -52,7 +52,7 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
             apiTags.push(tag.name);
         }
     });
-    // apiTags = uniq(apiTags.concat(operationTags));
+    apiTags = (0, uniq_1.default)(apiTags.concat(operationTags));
     const basePath = docPath
         ? outputDir.split(docPath)[1].replace(/^\/+/g, "")
         : outputDir.slice(outputDir.indexOf("/", 1)).replace(/^\/+/g, "");

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "2.1.1",
+  "version": "2.1.3",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -60,5 +60,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "4f4fe67483424356245c4ed9eae31f4cd3c7736a"
+  "gitHead": "3bca23ffd3bc51c3d7f4ebb3916e2ece8c823961"
 }

package/src/markdown/__snapshots__/createSchema.test.ts.snap

@@ -35,13 +35,7 @@ Array [
               Array [
             </div>
           </li>
-          <div
-            style={{
-              marginTop: \\".5rem\\",
-              marginBottom: \\".5rem\\",
-              marginLeft: \\"1rem\\",
-            }}
-          >
+          <div style={{ marginTop: \\".5rem\\", marginBottom: \\".5rem\\" }}>
             string
           </div>
           <li>
@@ -57,35 +51,17 @@ Array [
           </li>
         </TabItem>
         <TabItem label={\\"MOD3\\"} value={\\"2-item-properties\\"}>
-          <div
-            style={{
-              marginTop: \\".5rem\\",
-              marginBottom: \\".5rem\\",
-              marginLeft: \\"1rem\\",
-            }}
-          >
+          <div style={{ marginTop: \\".5rem\\", marginBottom: \\".5rem\\" }}>
             boolean
           </div>
         </TabItem>
         <TabItem label={\\"MOD4\\"} value={\\"3-item-properties\\"}>
-          <div
-            style={{
-              marginTop: \\".5rem\\",
-              marginBottom: \\".5rem\\",
-              marginLeft: \\"1rem\\",
-            }}
-          >
+          <div style={{ marginTop: \\".5rem\\", marginBottom: \\".5rem\\" }}>
             number
           </div>
         </TabItem>
         <TabItem label={\\"MOD5\\"} value={\\"4-item-properties\\"}>
-          <div
-            style={{
-              marginTop: \\".5rem\\",
-              marginBottom: \\".5rem\\",
-              marginLeft: \\"1rem\\",
-            }}
-          >
+          <div style={{ marginTop: \\".5rem\\", marginBottom: \\".5rem\\" }}>
             string
           </div>
         </TabItem>

package/src/markdown/createSchema.ts

@@ -44,7 +44,7 @@ export function mergeAllOf(allOf: SchemaObject[]) {
     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;
@@ -52,7 +52,7 @@ export function mergeAllOf(allOf: SchemaObject[]) {
     return acc;
   }, [] as any);
 
-  return { mergedSchemas, required };
+  return { mergedSchemas, mergedRequired };
 }
 
 /**
@@ -260,9 +260,8 @@ function createItems(schema: SchemaObject) {
     // TODO: figure out if and how we should pass merged required array
     const {
       mergedSchemas,
-    }: { mergedSchemas: SchemaObject; required: string[] } = mergeAllOf(
-      schema.items?.allOf
-    );
+    }: { mergedSchemas: SchemaObject; mergedRequired: string[] | boolean } =
+      mergeAllOf(schema.items?.allOf);
 
     // Handles combo anyOf/oneOf + properties
     if (
@@ -596,7 +595,6 @@ function createEdges({
   discriminator,
 }: EdgeProps): any {
   const schemaName = getSchemaName(schema);
-
   if (discriminator !== undefined && discriminator.propertyName === name) {
     return createPropertyDiscriminator(
       name,
@@ -618,13 +616,10 @@ function createEdges({
   }
 
   if (schema.allOf !== undefined) {
-    const {
-      mergedSchemas,
-      required,
-    }: { mergedSchemas: SchemaObject; required: string[] | boolean } =
-      mergeAllOf(schema.allOf);
+    const { mergedSchemas }: { mergedSchemas: SchemaObject } = mergeAllOf(
+      schema.allOf
+    );
     const mergedSchemaName = getSchemaName(mergedSchemas);
-
     if (
       mergedSchemas.oneOf !== undefined ||
       mergedSchemas.anyOf !== undefined
@@ -685,8 +680,8 @@ function createEdges({
       collapsible: false,
       name,
       required: Array.isArray(required) ? required.includes(name) : required,
-      schemaName: schemaName,
-      qualifierMessage: getQualifierMessage(schema),
+      schemaName: mergedSchemaName,
+      qualifierMessage: getQualifierMessage(mergedSchemas),
       schema: mergedSchemas,
     });
   }
@@ -817,9 +812,18 @@ export function createNodes(
       style: {
         marginTop: ".5rem",
         marginBottom: ".5rem",
-        marginLeft: "1rem",
       },
-      children: createDescription(schema.type),
+      children: [
+        createDescription(schema.type),
+        guard(getQualifierMessage(schema), (message) =>
+          create("div", {
+            style: {
+              paddingTop: "1rem",
+            },
+            children: createDescription(message),
+          })
+        ),
+      ],
     });
   }
 
@@ -829,9 +833,18 @@ export function createNodes(
       style: {
         marginTop: ".5rem",
         marginBottom: ".5rem",
-        marginLeft: "1rem",
       },
-      children: [createDescription(schema)],
+      children: [
+        createDescription(schema),
+        guard(getQualifierMessage(schema), (message) =>
+          create("div", {
+            style: {
+              paddingTop: "1rem",
+            },
+            children: createDescription(message),
+          })
+        ),
+      ],
     });
   }
 

package/src/markdown/schema.ts

@@ -40,6 +40,10 @@ function prettyName(schema: SchemaObject, circular?: boolean) {
     // return schema.type;
   }
 
+  if (schema.title && schema.type) {
+    return `${schema.title} (${schema.type})`;
+  }
+
   return schema.title ?? schema.type;
 }
 

package/src/sidebars/index.ts

@@ -87,7 +87,7 @@ function groupByTags(
       apiTags.push(tag.name!);
     }
   });
-  // apiTags = uniq(apiTags.concat(operationTags));
+  apiTags = uniq(apiTags.concat(operationTags));
 
   const basePath = docPath
     ? outputDir.split(docPath!)[1].replace(/^\/+/g, "")