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

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/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-419",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -67,5 +67,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "67e537ef8240524a94e5cdb38220b2fd499c61e0"
+  "gitHead": "c5df2d9c69e2d3881b329ba3586cbc3853ba553b"
 }

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)",