docusaurus-plugin-openapi-docs 0.0.0-572 → 0.0.0-574

package/lib/markdown/createRequestSchema.js

@@ -373,7 +373,7 @@ function createItems(schema) {
 //     }),
 //   });
 // }
-function createDetailsNode(name, schemaName, schema, required) {
+function createDetailsNode(name, schemaName, schema, required, nullable) {
     return (0, utils_1.create)("SchemaItem", {
         collapsible: true,
         className: "schemaItem",
@@ -387,7 +387,8 @@ function createDetailsNode(name, schemaName, schema, required) {
                                 style: { opacity: "0.6" },
                                 children: ` ${schemaName}`,
                             }),
-                            (0, utils_1.guard)(schema.nullable && schema.nullable === true, () => [
+                            (0, utils_1.guard)((schema.nullable && schema.nullable === true) ||
+                                (nullable && nullable === true), () => [
                                 (0, utils_1.create)("strong", {
                                     style: {
                                         fontSize: "var(--ifm-code-font-size)",
@@ -498,24 +499,24 @@ function createEdges({ name, schema, required, discriminator, }) {
         return createPropertyDiscriminator(name, "string", schema, discriminator, required);
     }
     if (schema.oneOf !== undefined || schema.anyOf !== undefined) {
-        return createDetailsNode(name, schemaName, schema, required);
+        return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
     if (schema.allOf !== undefined) {
         const { mergedSchemas, required, } = mergeAllOf(schema.allOf);
         const mergedSchemaName = (0, schema_1.getSchemaName)(mergedSchemas);
         if (mergedSchemas.oneOf !== undefined ||
             mergedSchemas.anyOf !== undefined) {
-            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
         }
         if (mergedSchemas.properties !== undefined) {
-            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
         }
         if (mergedSchemas.additionalProperties !== undefined) {
-            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
         }
         // array of objects
         if (((_a = mergedSchemas.items) === null || _a === void 0 ? void 0 : _a.properties) !== undefined) {
-            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
         }
         if (mergedSchemas.readOnly && mergedSchemas.readOnly === true) {
             return undefined;
@@ -530,17 +531,17 @@ function createEdges({ name, schema, required, discriminator, }) {
         });
     }
     if (schema.properties !== undefined) {
-        return createDetailsNode(name, schemaName, schema, required);
+        return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
     if (schema.additionalProperties !== undefined) {
-        return createDetailsNode(name, schemaName, schema, required);
+        return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
     // array of objects
     if (((_b = schema.items) === null || _b === void 0 ? void 0 : _b.properties) !== undefined) {
-        return createDetailsNode(name, schemaName, schema, required);
+        return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
     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);
+        return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
     if (schema.readOnly && schema.readOnly === true) {
         return undefined;
@@ -610,9 +611,10 @@ function createNodes(schema) {
     }
     // Unknown node/schema type should return undefined
     // So far, haven't seen this hit in testing
-    return undefined;
+    return "any";
 }
 function createRequestSchema({ title, body, ...rest }) {
+    var _a;
     if (body === undefined ||
         body.content === undefined ||
         Object.keys(body).length === 0 ||
@@ -681,7 +683,7 @@ function createRequestSchema({ title, body, ...rest }) {
         });
     }
     const randomFirstKey = Object.keys(body.content)[0];
-    const firstBody = body.content[randomFirstKey].schema;
+    const firstBody = (_a = body.content[randomFirstKey].schema) !== null && _a !== void 0 ? _a : body.content[randomFirstKey];
     if (firstBody === undefined) {
         return undefined;
     }

package/lib/markdown/createResponseSchema.js

@@ -374,7 +374,7 @@ function createItems(schema) {
 //     }),
 //   });
 // }
-function createDetailsNode(name, schemaName, schema, required) {
+function createDetailsNode(name, schemaName, schema, required, nullable) {
     return (0, utils_1.create)("SchemaItem", {
         collapsible: true,
         className: "schemaItem",
@@ -388,7 +388,8 @@ function createDetailsNode(name, schemaName, schema, required) {
                                 style: { opacity: "0.6" },
                                 children: ` ${schemaName}`,
                             }),
-                            (0, utils_1.guard)(schema.nullable && schema.nullable === true, () => [
+                            (0, utils_1.guard)((schema.nullable && schema.nullable === true) ||
+                                (nullable && nullable === true), () => [
                                 (0, utils_1.create)("strong", {
                                     style: {
                                         fontSize: "var(--ifm-code-font-size)",
@@ -499,24 +500,24 @@ function createEdges({ name, schema, required, discriminator, }) {
         return createPropertyDiscriminator(name, "string", schema, discriminator, required);
     }
     if (schema.oneOf !== undefined || schema.anyOf !== undefined) {
-        return createDetailsNode(name, schemaName, schema, required);
+        return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
     if (schema.allOf !== undefined) {
         const { mergedSchemas, required, } = mergeAllOf(schema.allOf);
         const mergedSchemaName = (0, schema_1.getSchemaName)(mergedSchemas);
         if (mergedSchemas.oneOf !== undefined ||
             mergedSchemas.anyOf !== undefined) {
-            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
         }
         if (mergedSchemas.properties !== undefined) {
-            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
         }
         if (mergedSchemas.additionalProperties !== undefined) {
-            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
         }
         // array of objects
         if (((_a = mergedSchemas.items) === null || _a === void 0 ? void 0 : _a.properties) !== undefined) {
-            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+            return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
         }
         if (mergedSchemas.writeOnly && mergedSchemas.writeOnly === true) {
             return undefined;
@@ -531,17 +532,17 @@ function createEdges({ name, schema, required, discriminator, }) {
         });
     }
     if (schema.properties !== undefined) {
-        return createDetailsNode(name, schemaName, schema, required);
+        return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
     if (schema.additionalProperties !== undefined) {
-        return createDetailsNode(name, schemaName, schema, required);
+        return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
     // array of objects
     if (((_b = schema.items) === null || _b === void 0 ? void 0 : _b.properties) !== undefined) {
-        return createDetailsNode(name, schemaName, schema, required);
+        return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
     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);
+        return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
     if (schema.writeOnly && schema.writeOnly === true) {
         return undefined;
@@ -613,7 +614,7 @@ function createNodes(schema) {
     }
     // Unknown node/schema type should return undefined
     // So far, haven't seen this hit in testing
-    return undefined;
+    return "any";
 }
 function createResponseSchema({ title, body, ...rest }) {
     if (body === undefined ||
@@ -628,9 +629,10 @@ function createResponseSchema({ title, body, ...rest }) {
         return (0, utils_1.create)("MimeTabs", {
             schemaType: "response",
             children: mimeTypes.map((mimeType) => {
+                var _a;
                 const responseExamples = body.content[mimeType].examples;
                 const responseExample = body.content[mimeType].example;
-                const firstBody = body.content[mimeType].schema;
+                const firstBody = (_a = body.content[mimeType].schema) !== null && _a !== void 0 ? _a : body.content[mimeType];
                 if (firstBody === undefined &&
                     responseExample === undefined &&
                     responseExamples === undefined) {

package/lib/openapi/utils/loadAndResolveSpec.js

@@ -114,6 +114,19 @@ async function loadAndResolveSpec(specUrlOrObject) {
     // Force dereference ?
     // bundleOpts["dereference"] = true;
     const { bundle: { parsed }, } = await (0, openapi_core_1.bundle)(bundleOpts);
+    //Pre-processing before resolving JSON refs
+    if (parsed.components) {
+        for (let [component, type] of Object.entries(parsed.components)) {
+            if (component === "schemas") {
+                for (let [schemaKey, schemaValue] of Object.entries(type)) {
+                    const title = schemaValue["title"];
+                    if (!title) {
+                        schemaValue.title = schemaKey;
+                    }
+                }
+            }
+        }
+    }
     const resolved = await resolveJsonRefs(parsed);
     // Force serialization and replace circular $ref pointers
     // @ts-ignore

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-572",
+  "version": "0.0.0-574",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -68,5 +68,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "2dbf8d2c4a044df1d44eba705d794f51c8709c0f"
+  "gitHead": "a0e1aa8a02e04184438688baeb587e6e92df312e"
 }

package/src/markdown/createRequestSchema.ts

@@ -436,7 +436,8 @@ function createDetailsNode(
   name: string,
   schemaName: string,
   schema: SchemaObject,
-  required: string[] | boolean
+  required: string[] | boolean,
+  nullable: boolean | unknown
 ): any {
   return create("SchemaItem", {
     collapsible: true,
@@ -451,15 +452,19 @@ function createDetailsNode(
                 style: { opacity: "0.6" },
                 children: ` ${schemaName}`,
               }),
-              guard(schema.nullable && schema.nullable === true, () => [
-                create("strong", {
-                  style: {
-                    fontSize: "var(--ifm-code-font-size)",
-                    color: "var(--openapi-nullable)",
-                  },
-                  children: " nullable",
-                }),
-              ]),
+              guard(
+                (schema.nullable && schema.nullable === true) ||
+                  (nullable && nullable === true),
+                () => [
+                  create("strong", {
+                    style: {
+                      fontSize: "var(--ifm-code-font-size)",
+                      color: "var(--openapi-nullable)",
+                    },
+                    children: " nullable",
+                  }),
+                ]
+              ),
               guard(
                 Array.isArray(required)
                   ? required.includes(name)
@@ -604,7 +609,13 @@ function createEdges({
   }
 
   if (schema.oneOf !== undefined || schema.anyOf !== undefined) {
-    return createDetailsNode(name, schemaName, schema, required);
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
   }
 
   if (schema.allOf !== undefined) {
@@ -619,20 +630,44 @@ function createEdges({
       mergedSchemas.oneOf !== undefined ||
       mergedSchemas.anyOf !== undefined
     ) {
-      return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+      return createDetailsNode(
+        name,
+        mergedSchemaName,
+        mergedSchemas,
+        required,
+        schema.nullable
+      );
     }
 
     if (mergedSchemas.properties !== undefined) {
-      return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+      return createDetailsNode(
+        name,
+        mergedSchemaName,
+        mergedSchemas,
+        required,
+        schema.nullable
+      );
     }
 
     if (mergedSchemas.additionalProperties !== undefined) {
-      return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+      return createDetailsNode(
+        name,
+        mergedSchemaName,
+        mergedSchemas,
+        required,
+        schema.nullable
+      );
     }
 
     // array of objects
     if (mergedSchemas.items?.properties !== undefined) {
-      return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+      return createDetailsNode(
+        name,
+        mergedSchemaName,
+        mergedSchemas,
+        required,
+        schema.nullable
+      );
     }
 
     if (mergedSchemas.readOnly && mergedSchemas.readOnly === true) {
@@ -650,20 +685,44 @@ function createEdges({
   }
 
   if (schema.properties !== undefined) {
-    return createDetailsNode(name, schemaName, schema, required);
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
   }
 
   if (schema.additionalProperties !== undefined) {
-    return createDetailsNode(name, schemaName, schema, required);
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
   }
 
   // array of objects
   if (schema.items?.properties !== undefined) {
-    return createDetailsNode(name, schemaName, schema, required);
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
   }
 
   if (schema.items?.anyOf !== undefined || schema.items?.oneOf !== undefined) {
-    return createDetailsNode(name, schemaName, schema, required);
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
   }
 
   if (schema.readOnly && schema.readOnly === true) {
@@ -751,7 +810,7 @@ function createNodes(schema: SchemaObject): any {
 
   // Unknown node/schema type should return undefined
   // So far, haven't seen this hit in testing
-  return undefined;
+  return "any";
 }
 
 interface Props {
@@ -840,7 +899,8 @@ export function createRequestSchema({ title, body, ...rest }: Props) {
   }
 
   const randomFirstKey = Object.keys(body.content)[0];
-  const firstBody = body.content[randomFirstKey].schema;
+  const firstBody: any =
+    body.content[randomFirstKey].schema ?? body.content![randomFirstKey];
 
   if (firstBody === undefined) {
     return undefined;

package/src/markdown/createResponseSchema.ts

@@ -442,7 +442,8 @@ function createDetailsNode(
   name: string,
   schemaName: string,
   schema: SchemaObject,
-  required: string[] | boolean
+  required: string[] | boolean,
+  nullable: boolean | unknown
 ): any {
   return create("SchemaItem", {
     collapsible: true,
@@ -457,15 +458,19 @@ function createDetailsNode(
                 style: { opacity: "0.6" },
                 children: ` ${schemaName}`,
               }),
-              guard(schema.nullable && schema.nullable === true, () => [
-                create("strong", {
-                  style: {
-                    fontSize: "var(--ifm-code-font-size)",
-                    color: "var(--openapi-nullable)",
-                  },
-                  children: " nullable",
-                }),
-              ]),
+              guard(
+                (schema.nullable && schema.nullable === true) ||
+                  (nullable && nullable === true),
+                () => [
+                  create("strong", {
+                    style: {
+                      fontSize: "var(--ifm-code-font-size)",
+                      color: "var(--openapi-nullable)",
+                    },
+                    children: " nullable",
+                  }),
+                ]
+              ),
               guard(
                 Array.isArray(required)
                   ? required.includes(name)
@@ -610,7 +615,13 @@ function createEdges({
   }
 
   if (schema.oneOf !== undefined || schema.anyOf !== undefined) {
-    return createDetailsNode(name, schemaName, schema, required);
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
   }
 
   if (schema.allOf !== undefined) {
@@ -625,20 +636,44 @@ function createEdges({
       mergedSchemas.oneOf !== undefined ||
       mergedSchemas.anyOf !== undefined
     ) {
-      return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+      return createDetailsNode(
+        name,
+        mergedSchemaName,
+        mergedSchemas,
+        required,
+        schema.nullable
+      );
     }
 
     if (mergedSchemas.properties !== undefined) {
-      return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+      return createDetailsNode(
+        name,
+        mergedSchemaName,
+        mergedSchemas,
+        required,
+        schema.nullable
+      );
     }
 
     if (mergedSchemas.additionalProperties !== undefined) {
-      return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+      return createDetailsNode(
+        name,
+        mergedSchemaName,
+        mergedSchemas,
+        required,
+        schema.nullable
+      );
     }
 
     // array of objects
     if (mergedSchemas.items?.properties !== undefined) {
-      return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
+      return createDetailsNode(
+        name,
+        mergedSchemaName,
+        mergedSchemas,
+        required,
+        schema.nullable
+      );
     }
 
     if (mergedSchemas.writeOnly && mergedSchemas.writeOnly === true) {
@@ -656,20 +691,44 @@ function createEdges({
   }
 
   if (schema.properties !== undefined) {
-    return createDetailsNode(name, schemaName, schema, required);
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
   }
 
   if (schema.additionalProperties !== undefined) {
-    return createDetailsNode(name, schemaName, schema, required);
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
   }
 
   // array of objects
   if (schema.items?.properties !== undefined) {
-    return createDetailsNode(name, schemaName, schema, required);
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
   }
 
   if (schema.items?.anyOf !== undefined || schema.items?.oneOf !== undefined) {
-    return createDetailsNode(name, schemaName, schema, required);
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
   }
 
   if (schema.writeOnly && schema.writeOnly === true) {
@@ -702,7 +761,6 @@ function createNodes(schema: SchemaObject): any {
 
   if (schema.allOf !== undefined) {
     const { mergedSchemas } = mergeAllOf(schema.allOf);
-
     if (mergedSchemas.properties !== undefined) {
       nodes.push(createProperties(mergedSchemas));
     }
@@ -760,7 +818,7 @@ function createNodes(schema: SchemaObject): any {
 
   // Unknown node/schema type should return undefined
   // So far, haven't seen this hit in testing
-  return undefined;
+  return "any";
 }
 
 interface Props {
@@ -794,7 +852,8 @@ export function createResponseSchema({ title, body, ...rest }: Props) {
       children: mimeTypes.map((mimeType: any) => {
         const responseExamples = body.content![mimeType].examples;
         const responseExample = body.content![mimeType].example;
-        const firstBody = body.content![mimeType].schema;
+        const firstBody: any =
+          body.content![mimeType].schema ?? body.content![mimeType];
 
         if (
           firstBody === undefined &&

package/src/openapi/utils/loadAndResolveSpec.ts

@@ -128,6 +128,21 @@ export async function loadAndResolveSpec(specUrlOrObject: object | string) {
   const {
     bundle: { parsed },
   } = await bundle(bundleOpts);
+
+  //Pre-processing before resolving JSON refs
+  if (parsed.components) {
+    for (let [component, type] of Object.entries(parsed.components) as any) {
+      if (component === "schemas") {
+        for (let [schemaKey, schemaValue] of Object.entries(type) as any) {
+          const title: string | undefined = schemaValue["title"];
+          if (!title) {
+            schemaValue.title = schemaKey;
+          }
+        }
+      }
+    }
+  }
+
   const resolved = await resolveJsonRefs(parsed);
 
   // Force serialization and replace circular $ref pointers