docusaurus-plugin-openapi-docs 3.0.1 → 3.0.2

package/src/markdown/createSchema.ts

@@ -66,6 +66,7 @@ function createAnyOneOf(schema: SchemaObject): any {
       create("span", {
         className: "badge badge--info",
         children: type,
+        style: { marginBottom: "1rem" },
       }),
       create("SchemaTabs", {
         children: schema[type]!.map((anyOneSchema, index) => {
@@ -74,6 +75,25 @@ function createAnyOneOf(schema: SchemaObject): any {
             : `MOD${index + 1}`;
           const anyOneChildren = [];
 
+          if (anyOneSchema.description) {
+            anyOneChildren.push(
+              create("div", {
+                style: { marginTop: ".5rem", marginBottom: ".5rem" },
+                className: "openapi-schema__summary",
+                children: createDescription(anyOneSchema.description),
+              })
+            );
+          }
+
+          if (
+            anyOneSchema.type === "object" &&
+            !anyOneSchema.properties &&
+            !anyOneSchema.allOf &&
+            !anyOneSchema.items
+          ) {
+            anyOneChildren.push(createNodes(anyOneSchema, SCHEMA_TYPE));
+          }
+
           if (anyOneSchema.properties !== undefined) {
             anyOneChildren.push(createProperties(anyOneSchema));
             delete anyOneSchema.properties;
@@ -415,79 +435,79 @@ function createDetailsNode(
 /**
  * For handling anyOf/oneOf properties.
  */
-function createAnyOneOfProperty(
-  name: string,
-  schemaName: string,
-  schema: SchemaObject,
-  required: string[] | boolean,
-  nullable: boolean | unknown
-): any {
-  return create("SchemaItem", {
-    collapsible: true,
-    className: "schemaItem",
-    children: [
-      createDetails({
-        className: "openapi-markdown__details",
-        children: [
-          createDetailsSummary({
-            children: [
-              create("strong", { children: name }),
-              create("span", {
-                style: { opacity: "0.6" },
-                children: ` ${schemaName}`,
-              }),
-              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)
-                  : required === true,
-                () => [
-                  create("strong", {
-                    style: {
-                      fontSize: "var(--ifm-code-font-size)",
-                      color: "var(--openapi-required)",
-                    },
-                    children: " required",
-                  }),
-                ]
-              ),
-            ],
-          }),
-          create("div", {
-            style: { marginLeft: "1rem" },
-            children: [
-              guard(getQualifierMessage(schema), (message) =>
-                create("div", {
-                  style: { marginTop: ".5rem", marginBottom: ".5rem" },
-                  children: createDescription(message),
-                })
-              ),
-              guard(schema.description, (description) =>
-                create("div", {
-                  style: { marginTop: ".5rem", marginBottom: ".5rem" },
-                  children: createDescription(description),
-                })
-              ),
-            ],
-          }),
-          createAnyOneOf(schema),
-        ],
-      }),
-    ],
-  });
-}
+// function createAnyOneOfProperty(
+//   name: string,
+//   schemaName: string,
+//   schema: SchemaObject,
+//   required: string[] | boolean,
+//   nullable: boolean | unknown
+// ): any {
+//   return create("SchemaItem", {
+//     collapsible: true,
+//     className: "schemaItem",
+//     children: [
+//       createDetails({
+//         className: "openapi-markdown__details",
+//         children: [
+//           createDetailsSummary({
+//             children: [
+//               create("strong", { children: name }),
+//               create("span", {
+//                 style: { opacity: "0.6" },
+//                 children: ` ${schemaName}`,
+//               }),
+//               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)
+//                   : required === true,
+//                 () => [
+//                   create("strong", {
+//                     style: {
+//                       fontSize: "var(--ifm-code-font-size)",
+//                       color: "var(--openapi-required)",
+//                     },
+//                     children: " required",
+//                   }),
+//                 ]
+//               ),
+//             ],
+//           }),
+//           create("div", {
+//             style: { marginLeft: "1rem" },
+//             children: [
+//               guard(getQualifierMessage(schema), (message) =>
+//                 create("div", {
+//                   style: { marginTop: ".5rem", marginBottom: ".5rem" },
+//                   children: createDescription(message),
+//                 })
+//               ),
+//               guard(schema.description, (description) =>
+//                 create("div", {
+//                   style: { marginTop: ".5rem", marginBottom: ".5rem" },
+//                   children: createDescription(description),
+//                 })
+//               ),
+//             ],
+//           }),
+//           createAnyOneOf(schema),
+//         ],
+//       }),
+//     ],
+//   });
+// }
 
 /**
  * For handling discriminators that map to a same-level property (like 'petType').
@@ -595,6 +615,7 @@ function createEdges({
   }
 
   const schemaName = getSchemaName(schema);
+
   if (discriminator !== undefined && discriminator.propertyName === name) {
     return createPropertyDiscriminator(
       name,
@@ -606,7 +627,48 @@ function createEdges({
   }
 
   if (schema.oneOf !== undefined || schema.anyOf !== undefined) {
-    return createAnyOneOfProperty(
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
+  }
+
+  if (schema.properties !== undefined) {
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
+  }
+
+  if (schema.additionalProperties !== undefined) {
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
+  }
+
+  // array of objects
+  if (schema.items?.properties !== undefined) {
+    return createDetailsNode(
+      name,
+      schemaName,
+      schema,
+      required,
+      schema.nullable
+    );
+  }
+
+  if (schema.items?.anyOf !== undefined || schema.items?.oneOf !== undefined) {
+    return createDetailsNode(
       name,
       schemaName,
       schema,
@@ -687,47 +749,6 @@ function createEdges({
     });
   }
 
-  if (schema.properties !== undefined) {
-    return createDetailsNode(
-      name,
-      schemaName,
-      schema,
-      required,
-      schema.nullable
-    );
-  }
-
-  if (schema.additionalProperties !== undefined) {
-    return createDetailsNode(
-      name,
-      schemaName,
-      schema,
-      required,
-      schema.nullable
-    );
-  }
-
-  // array of objects
-  if (schema.items?.properties !== undefined) {
-    return createDetailsNode(
-      name,
-      schemaName,
-      schema,
-      required,
-      schema.nullable
-    );
-  }
-
-  if (schema.items?.anyOf !== undefined || schema.items?.oneOf !== undefined) {
-    return createDetailsNode(
-      name,
-      schemaName,
-      schema,
-      required,
-      schema.nullable
-    );
-  }
-
   // primitives and array of non-objects
   return create("SchemaItem", {
     collapsible: false,
@@ -767,6 +788,19 @@ export function createNodes(
     nodes.push(createAnyOneOf(schema));
   }
 
+  if (schema.properties !== undefined) {
+    nodes.push(createProperties(schema));
+  }
+
+  if (schema.additionalProperties !== undefined) {
+    nodes.push(createAdditionalProperties(schema));
+  }
+
+  // TODO: figure out how to handle array of objects
+  if (schema.items !== undefined) {
+    nodes.push(createItems(schema));
+  }
+
   if (schema.allOf !== undefined) {
     const { mergedSchemas } = mergeAllOf(schema.allOf);
 
@@ -782,19 +816,6 @@ export function createNodes(
     }
   }
 
-  if (schema.properties !== undefined) {
-    nodes.push(createProperties(schema));
-  }
-
-  if (schema.additionalProperties !== undefined) {
-    nodes.push(createAdditionalProperties(schema));
-  }
-
-  // TODO: figure out how to handle array of objects
-  if (schema.items !== undefined) {
-    nodes.push(createItems(schema));
-  }
-
   if (nodes.length && nodes.length > 0) {
     return nodes.filter(Boolean).flat();
   }

package/src/markdown/createStatusCodes.ts

@@ -127,8 +127,9 @@ export function createResponseExamples(
           value: `${exampleName}`,
           children: [
             guard(exampleValue.summary, (summary) => [
-              create("Markdown", {
-                children: ` ${summary}`,
+              create("div", {
+                children: `${summary}`,
+                className: "openapi-example__summary",
               }),
             ]),
             create("ResponseSamples", {
@@ -143,8 +144,9 @@ export function createResponseExamples(
         value: `${exampleName}`,
         children: [
           guard(exampleValue.summary, (summary) => [
-            create("Markdown", {
-              children: ` ${summary}`,
+            create("div", {
+              children: `${summary}`,
+              className: "openapi-example__summary",
             }),
           ]),
           create("ResponseSamples", {
@@ -171,8 +173,9 @@ export function createResponseExample(responseExample: any, mimeType: string) {
       value: `Example`,
       children: [
         guard(responseExample.summary, (summary) => [
-          create("Markdown", {
-            children: ` ${summary}`,
+          create("div", {
+            children: `${summary}`,
+            className: "openapi-example__summary",
           }),
         ]),
         create("ResponseSamples", {
@@ -187,8 +190,9 @@ export function createResponseExample(responseExample: any, mimeType: string) {
     value: `Example`,
     children: [
       guard(responseExample.summary, (summary) => [
-        create("Markdown", {
-          children: ` ${summary}`,
+        create("div", {
+          children: `${summary}`,
+          className: "openapi-example__summary",
         }),
       ]),
       create("ResponseSamples", {

package/src/markdown/index.ts

@@ -76,7 +76,6 @@ export function createApiPageMD({
     `import ResponseSamples from "@theme/ResponseSamples";\n`,
     `import SchemaItem from "@theme/SchemaItem";\n`,
     `import SchemaTabs from "@theme/SchemaTabs";\n`,
-    `import Markdown from "@theme/Markdown";\n`,
     `import Heading from "@theme/Heading";\n`,
     `import OperationTabs from "@theme/OperationTabs";\n`,
     `import TabItem from "@theme/TabItem";\n\n`,

package/src/openapi/createRequestExample.ts

@@ -30,8 +30,8 @@ const primitives: Primitives = {
   string: {
     default: () => "string",
     email: () => "user@example.com",
-    date: () => new Date().toISOString().substring(0, 10),
-    "date-time": () => new Date().toISOString(),
+    date: () => "2024-07-29",
+    "date-time": () => "2024-07-29T15:51:28.071Z",
     uuid: () => "3fa85f64-5717-4562-b3fc-2c963f66afa6",
     hostname: () => "example.com",
     ipv4: () => "198.51.100.42",

package/src/openapi/createResponseExample.ts

@@ -30,8 +30,8 @@ const primitives: Primitives = {
   string: {
     default: () => "string",
     email: () => "user@example.com",
-    date: () => new Date().toISOString().substring(0, 10),
-    "date-time": () => new Date().toISOString(),
+    date: () => "2024-07-29",
+    "date-time": () => "2024-07-29T15:51:28.071Z",
     uuid: () => "3fa85f64-5717-4562-b3fc-2c963f66afa6",
     hostname: () => "example.com",
     ipv4: () => "198.51.100.42",