docusaurus-theme-openapi-docs 4.5.0 → 4.6.0

package/lib/theme/ResponseSchema/index.js

@@ -13,6 +13,7 @@ var __importDefault =
 Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = __importDefault(require("react"));
 const BrowserOnly_1 = __importDefault(require("@docusaurus/BrowserOnly"));
+const Translate_1 = require("@docusaurus/Translate");
 const Details_1 = __importDefault(require("@theme/Details"));
 const Markdown_1 = __importDefault(require("@theme/Markdown"));
 const MimeTabs_1 = __importDefault(require("@theme/MimeTabs")); // Assume these components exist
@@ -21,6 +22,7 @@ const Schema_1 = __importDefault(require("@theme/Schema"));
 const SchemaTabs_1 = __importDefault(require("@theme/SchemaTabs"));
 const SkeletonLoader_1 = __importDefault(require("@theme/SkeletonLoader"));
 const TabItem_1 = __importDefault(require("@theme/TabItem"));
+const translationIds_1 = require("@theme/translationIds");
 const ResponseSchemaComponent = ({ title, body, style }) => {
   if (
     body === undefined ||
@@ -37,105 +39,118 @@ const ResponseSchemaComponent = ({ title, body, style }) => {
       MimeTabs_1.default,
       { className: "openapi-tabs__mime", schemaType: "response" },
       mimeTypes.map((mimeType) => {
-        const responseExamples = body.content[mimeType].examples;
-        const responseExample = body.content[mimeType].example;
-        const firstBody =
-          body.content[mimeType].schema ?? body.content[mimeType];
+        const mediaTypeObject = body.content?.[mimeType];
+        const responseExamples = mediaTypeObject?.examples;
+        const responseExample = mediaTypeObject?.example;
+        const firstBody = mediaTypeObject?.schema;
         if (
-          firstBody === undefined &&
-          responseExample === undefined &&
-          responseExamples === undefined
+          !firstBody ||
+          (firstBody.properties &&
+            Object.keys(firstBody.properties).length === 0)
         ) {
-          return undefined;
-        }
-        if (firstBody) {
           return (
             // @ts-ignore
             react_1.default.createElement(
               TabItem_1.default,
               { key: mimeType, label: mimeType, value: mimeType },
               react_1.default.createElement(
-                SchemaTabs_1.default,
-                { className: "openapi-tabs__schema" },
+                "div",
+                null,
+                (0, Translate_1.translate)({
+                  id: translationIds_1.OPENAPI_SCHEMA.NO_SCHEMA,
+                  message: "No schema",
+                })
+              )
+            )
+          );
+        }
+        return (
+          // @ts-ignore
+          react_1.default.createElement(
+            TabItem_1.default,
+            { key: mimeType, label: mimeType, value: mimeType },
+            react_1.default.createElement(
+              SchemaTabs_1.default,
+              { className: "openapi-tabs__schema" },
+              react_1.default.createElement(
+                TabItem_1.default,
+                { key: title, label: title, value: title },
                 react_1.default.createElement(
-                  TabItem_1.default,
-                  { key: title, label: title, value: title },
-                  react_1.default.createElement(
-                    Details_1.default,
-                    {
-                      className: "openapi-markdown__details response",
-                      "data-collapsed": false,
-                      open: true,
-                      style: style,
-                      summary: react_1.default.createElement(
-                        react_1.default.Fragment,
+                  Details_1.default,
+                  {
+                    className: "openapi-markdown__details response",
+                    "data-collapsed": false,
+                    open: true,
+                    style: style,
+                    summary: react_1.default.createElement(
+                      react_1.default.Fragment,
+                      null,
+                      react_1.default.createElement(
+                        "summary",
                         null,
                         react_1.default.createElement(
-                          "summary",
-                          null,
-                          react_1.default.createElement(
-                            "strong",
-                            {
-                              className:
-                                "openapi-markdown__details-summary-response",
-                            },
-                            title,
-                            body.required === true &&
-                              react_1.default.createElement(
-                                "span",
-                                { className: "openapi-schema__required" },
-                                "required"
-                              )
-                          )
-                        )
-                      ),
-                    },
-                    react_1.default.createElement(
-                      "div",
-                      { style: { textAlign: "left", marginLeft: "1rem" } },
-                      body.description &&
-                        react_1.default.createElement(
-                          "div",
+                          "strong",
                           {
-                            style: { marginTop: "1rem", marginBottom: "1rem" },
+                            className:
+                              "openapi-markdown__details-summary-response",
                           },
-                          react_1.default.createElement(
-                            Markdown_1.default,
-                            null,
-                            body.description
-                          )
+                          title,
+                          body.required === true &&
+                            react_1.default.createElement(
+                              "span",
+                              { className: "openapi-schema__required" },
+                              (0, Translate_1.translate)({
+                                id: translationIds_1.OPENAPI_SCHEMA_ITEM
+                                  .REQUIRED,
+                                message: "required",
+                              })
+                            )
                         )
+                      )
                     ),
-                    react_1.default.createElement(
-                      "ul",
-                      { style: { marginLeft: "1rem" } },
-                      react_1.default.createElement(Schema_1.default, {
-                        schema: firstBody,
-                        schemaType: "response",
-                      })
-                    )
+                  },
+                  react_1.default.createElement(
+                    "div",
+                    { style: { textAlign: "left", marginLeft: "1rem" } },
+                    body.description &&
+                      react_1.default.createElement(
+                        "div",
+                        { style: { marginTop: "1rem", marginBottom: "1rem" } },
+                        react_1.default.createElement(
+                          Markdown_1.default,
+                          null,
+                          body.description
+                        )
+                      )
+                  ),
+                  react_1.default.createElement(
+                    "ul",
+                    { style: { marginLeft: "1rem" } },
+                    react_1.default.createElement(Schema_1.default, {
+                      schema: firstBody,
+                      schemaType: "response",
+                    })
                   )
-                ),
-                firstBody &&
-                  (0, ResponseExamples_1.ExampleFromSchema)({
-                    schema: firstBody,
-                    mimeType: mimeType,
-                  }),
-                responseExamples &&
-                  (0, ResponseExamples_1.ResponseExamples)({
-                    responseExamples,
-                    mimeType,
-                  }),
-                responseExample &&
-                  (0, ResponseExamples_1.ResponseExample)({
-                    responseExample,
-                    mimeType,
-                  })
-              )
+                )
+              ),
+              firstBody &&
+                (0, ResponseExamples_1.ExampleFromSchema)({
+                  schema: firstBody,
+                  mimeType: mimeType,
+                }),
+              responseExamples &&
+                (0, ResponseExamples_1.ResponseExamples)({
+                  responseExamples,
+                  mimeType,
+                }),
+              responseExample &&
+                (0, ResponseExamples_1.ResponseExample)({
+                  responseExample,
+                  mimeType,
+                })
             )
-          );
-        }
-        return undefined;
+          )
+        );
       })
     );
   }

package/lib/theme/Schema/index.js

@@ -12,6 +12,7 @@ var __importDefault =
   };
 Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = __importDefault(require("react"));
+const Translate_1 = require("@docusaurus/Translate");
 const ArrayBrackets_1 = require("@theme/ArrayBrackets");
 const Details_1 = __importDefault(require("@theme/Details"));
 const DiscriminatorTabs_1 = __importDefault(
@@ -21,6 +22,7 @@ const Markdown_1 = __importDefault(require("@theme/Markdown"));
 const SchemaItem_1 = __importDefault(require("@theme/SchemaItem"));
 const SchemaTabs_1 = __importDefault(require("@theme/SchemaTabs"));
 const TabItem_1 = __importDefault(require("@theme/TabItem"));
+const translationIds_1 = require("@theme/translationIds");
 // eslint-disable-next-line import/no-extraneous-dependencies
 const allof_merge_1 = require("allof-merge");
 const clsx_1 = __importDefault(require("clsx"));
@@ -77,25 +79,48 @@ const Summary = ({ name, schemaName, schema, required }) => {
         react_1.default.createElement(
           "span",
           { className: "openapi-schema__nullable" },
-          "nullable"
+          (0, Translate_1.translate)({
+            id: translationIds_1.OPENAPI_SCHEMA_ITEM.NULLABLE,
+            message: "nullable",
+          })
         ),
       isRequired &&
         react_1.default.createElement(
           "span",
           { className: "openapi-schema__required" },
-          "required"
+          (0, Translate_1.translate)({
+            id: translationIds_1.OPENAPI_SCHEMA_ITEM.REQUIRED,
+            message: "required",
+          })
         ),
       deprecated &&
         react_1.default.createElement(
           "span",
           { className: "openapi-schema__deprecated" },
-          "deprecated"
+          (0, Translate_1.translate)({
+            id: translationIds_1.OPENAPI_SCHEMA_ITEM.DEPRECATED,
+            message: "deprecated",
+          })
         )
     )
   );
 };
 const AnyOneOf = ({ schema, schemaType }) => {
-  const type = schema.oneOf ? "oneOf" : "anyOf";
+  const key = schema.oneOf ? "oneOf" : "anyOf";
+  const type = schema.oneOf
+    ? (0, Translate_1.translate)({
+        id: translationIds_1.OPENAPI_SCHEMA_ITEM.ONE_OF,
+        message: "oneOf",
+      })
+    : (0, Translate_1.translate)({
+        id: translationIds_1.OPENAPI_SCHEMA_ITEM.ANY_OF,
+        message: "anyOf",
+      });
+  // Generate a unique ID for this anyOf/oneOf to prevent tab value collisions
+  const uniqueId = react_1.default.useMemo(
+    () => Math.random().toString(36).substring(7),
+    []
+  );
   return react_1.default.createElement(
     react_1.default.Fragment,
     null,
@@ -106,19 +131,39 @@ const AnyOneOf = ({ schema, schemaType }) => {
     ),
     react_1.default.createElement(
       SchemaTabs_1.default,
-      null,
-      schema[type]?.map((anyOneSchema, index) => {
-        const label = anyOneSchema.title || anyOneSchema.type;
+      { groupId: `schema-${uniqueId}`, lazy: true },
+      schema[key]?.map((anyOneSchema, index) => {
+        // Use getSchemaName to include format info (e.g., "string<date-time>")
+        const computedSchemaName = (0, schema_1.getSchemaName)(anyOneSchema);
+        // Determine label for the tab
+        // Prefer explicit title, then computed schema name, then raw type
+        let label =
+          anyOneSchema.title || computedSchemaName || anyOneSchema.type;
+        if (!label) {
+          if (anyOneSchema.oneOf) {
+            label = (0, Translate_1.translate)({
+              id: translationIds_1.OPENAPI_SCHEMA_ITEM.ONE_OF,
+              message: "oneOf",
+            });
+          } else if (anyOneSchema.anyOf) {
+            label = (0, Translate_1.translate)({
+              id: translationIds_1.OPENAPI_SCHEMA_ITEM.ANY_OF,
+              message: "anyOf",
+            });
+          } else {
+            label = `Option ${index + 1}`;
+          }
+        }
         return (
           // @ts-ignore
           react_1.default.createElement(
             TabItem_1.default,
-            { key: index, label: label, value: `${index}-item-properties` },
+            { key: index, label: label, value: `${uniqueId}-${index}-item` },
             (isPrimitive(anyOneSchema) || anyOneSchema.const) &&
               react_1.default.createElement(SchemaItem_1.default, {
                 collapsible: false,
                 name: undefined,
-                schemaName: anyOneSchema.type,
+                schemaName: computedSchemaName,
                 qualifierMessage: (0, schema_1.getQualifierMessage)(
                   anyOneSchema
                 ),
@@ -134,7 +179,7 @@ const AnyOneOf = ({ schema, schemaType }) => {
               react_1.default.createElement(SchemaItem_1.default, {
                 collapsible: false,
                 name: undefined,
-                schemaName: anyOneSchema.type,
+                schemaName: computedSchemaName,
                 qualifierMessage: (0, schema_1.getQualifierMessage)(
                   anyOneSchema
                 ),
@@ -142,7 +187,7 @@ const AnyOneOf = ({ schema, schemaType }) => {
                 discriminator: false,
                 children: null,
               }),
-            anyOneSchema.type === "object" &&
+            (anyOneSchema.type === "object" || !anyOneSchema.type) &&
               anyOneSchema.properties &&
               react_1.default.createElement(Properties, {
                 schema: anyOneSchema,
@@ -262,7 +307,10 @@ const PropertyDiscriminator = ({
             react_1.default.createElement(
               "span",
               { className: "openapi-schema__required" },
-              "required"
+              (0, Translate_1.translate)({
+                id: translationIds_1.OPENAPI_SCHEMA_ITEM.REQUIRED,
+                message: "required",
+              })
             )
         ),
         react_1.default.createElement(
@@ -615,7 +663,7 @@ const SchemaEdge = ({ name, schema, required, discriminator, schemaType }) => {
       schemaType: schemaType,
     });
   }
-  if (schema.items?.anyOf || schema.items?.oneOf) {
+  if (schema.items?.anyOf || schema.items?.oneOf || schema.items?.allOf) {
     return react_1.default.createElement(SchemaNodeDetails, {
       name: name,
       schemaName: schemaName,
@@ -656,9 +704,7 @@ const SchemaEdge = ({ name, schema, required, discriminator, schemaType }) => {
       return react_1.default.createElement(SchemaNodeDetails, {
         name: name,
         schemaName: mergedSchemaName,
-        required: Array.isArray(mergedSchemas.required)
-          ? mergedSchemas.required.includes(name)
-          : mergedSchemas.required,
+        required: Array.isArray(required) ? required.includes(name) : required,
         nullable: mergedSchemas.nullable,
         schema: mergedSchemas,
         schemaType: schemaType,
@@ -668,21 +714,17 @@ const SchemaEdge = ({ name, schema, required, discriminator, schemaType }) => {
       return react_1.default.createElement(SchemaNodeDetails, {
         name: name,
         schemaName: mergedSchemaName,
-        required: Array.isArray(mergedSchemas.required)
-          ? mergedSchemas.required.includes(name)
-          : mergedSchemas.required,
+        required: Array.isArray(required) ? required.includes(name) : required,
         nullable: mergedSchemas.nullable,
         schema: mergedSchemas,
         schemaType: schemaType,
       });
     }
     if (mergedSchemas.items?.properties) {
-      react_1.default.createElement(SchemaNodeDetails, {
+      return react_1.default.createElement(SchemaNodeDetails, {
         name: name,
         schemaName: mergedSchemaName,
-        required: Array.isArray(mergedSchemas.required)
-          ? mergedSchemas.required.includes(name)
-          : mergedSchemas.required,
+        required: Array.isArray(required) ? required.includes(name) : required,
         nullable: mergedSchemas.nullable,
         schema: mergedSchemas,
         schemaType: schemaType,
@@ -758,6 +800,47 @@ const SchemaNode = ({ schema, schemaType }) => {
   }
   // Handle allOf, oneOf, anyOf without discriminators
   if (schema.allOf) {
+    // Check if allOf contains multiple oneOf/anyOf items that should be rendered separately
+    const oneOfItems = schema.allOf.filter((item) => item.oneOf || item.anyOf);
+    const hasMultipleChoices = oneOfItems.length > 1;
+    if (hasMultipleChoices) {
+      // Render each oneOf/anyOf constraint first, then shared properties
+      const mergedSchemas = mergeAllOf(schema);
+      if (
+        (schemaType === "request" && mergedSchemas.readOnly) ||
+        (schemaType === "response" && mergedSchemas.writeOnly)
+      ) {
+        return null;
+      }
+      return react_1.default.createElement(
+        "div",
+        null,
+        schema.allOf.map((item, index) => {
+          if (item.oneOf || item.anyOf) {
+            return react_1.default.createElement(
+              "div",
+              { key: index },
+              react_1.default.createElement(AnyOneOf, {
+                schema: item,
+                schemaType: schemaType,
+              })
+            );
+          }
+          return null;
+        }),
+        mergedSchemas.properties &&
+          react_1.default.createElement(Properties, {
+            schema: mergedSchemas,
+            schemaType: schemaType,
+          }),
+        mergedSchemas.items &&
+          react_1.default.createElement(Items, {
+            schema: mergedSchemas,
+            schemaType: schemaType,
+          })
+      );
+    }
+    // For other allOf cases, use standard merge behavior
     const mergedSchemas = mergeAllOf(schema);
     if (
       (schemaType === "request" && mergedSchemas.readOnly) ||

package/lib/theme/SchemaItem/index.js

@@ -13,7 +13,10 @@ var __importDefault =
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = SchemaItem;
 const react_1 = __importDefault(require("react"));
+const Translate_1 = require("@docusaurus/Translate");
+const Example_1 = require("@theme/Example");
 const Markdown_1 = __importDefault(require("@theme/Markdown"));
+const translationIds_1 = require("@theme/translationIds");
 const clsx_1 = __importDefault(require("clsx"));
 const utils_1 = require("../../markdown/utils");
 const transformEnumDescriptions = (enumDescriptions) => {
@@ -24,7 +27,15 @@ const transformEnumDescriptions = (enumDescriptions) => {
 };
 const getEnumDescriptionMarkdown = (enumDescriptions) => {
   if (enumDescriptions?.length) {
-    return `| Enum Value | Description |
+    const enumValue = (0, Translate_1.translate)({
+      id: translationIds_1.OPENAPI_SCHEMA_ITEM.ENUM_VALUE,
+      message: "Enum Value",
+    });
+    const description = (0, Translate_1.translate)({
+      id: translationIds_1.OPENAPI_SCHEMA_ITEM.ENUM_DESCRIPTION,
+      message: "Description",
+    });
+    return `| ${enumValue} | ${description} |
 | ---- | ----- |
 ${enumDescriptions
   .map((desc) => {
@@ -49,6 +60,7 @@ function SchemaItem(props) {
   let schemaDescription;
   let defaultValue;
   let example;
+  let examples;
   let nullable;
   let enumDescriptions = [];
   let constValue;
@@ -58,6 +70,7 @@ function SchemaItem(props) {
     enumDescriptions = transformEnumDescriptions(schema["x-enumDescriptions"]);
     defaultValue = schema.default;
     example = schema.example;
+    examples = schema.examples;
     nullable =
       schema.nullable ||
       (Array.isArray(schema.type) && schema.type.includes("null")); // support JSON Schema nullable
@@ -69,21 +82,30 @@ function SchemaItem(props) {
       react_1.default.createElement(
         "span",
         { className: "openapi-schema__required" },
-        "required"
+        (0, Translate_1.translate)({
+          id: translationIds_1.OPENAPI_SCHEMA_ITEM.REQUIRED,
+          message: "required",
+        })
       )
   );
   const renderDeprecated = (0, utils_1.guard)(deprecated, () =>
     react_1.default.createElement(
       "span",
       { className: "openapi-schema__deprecated" },
-      "deprecated"
+      (0, Translate_1.translate)({
+        id: translationIds_1.OPENAPI_SCHEMA_ITEM.DEPRECATED,
+        message: "deprecated",
+      })
     )
   );
   const renderNullable = (0, utils_1.guard)(nullable, () =>
     react_1.default.createElement(
       "span",
       { className: "openapi-schema__nullable" },
-      "nullable"
+      (0, Translate_1.translate)({
+        id: translationIds_1.OPENAPI_SCHEMA_ITEM.NULLABLE,
+        message: "nullable",
+      })
     )
   );
   const renderEnumDescriptions = (0, utils_1.guard)(
@@ -120,7 +142,15 @@ function SchemaItem(props) {
         return react_1.default.createElement(
           "div",
           null,
-          react_1.default.createElement("strong", null, "Default value: "),
+          react_1.default.createElement(
+            "strong",
+            null,
+            (0, Translate_1.translate)({
+              id: translationIds_1.OPENAPI_SCHEMA_ITEM.DEFAULT_VALUE,
+              message: "Default value:",
+            }),
+            " "
+          ),
           react_1.default.createElement(
             "span",
             null,
@@ -131,7 +161,15 @@ function SchemaItem(props) {
       return react_1.default.createElement(
         "div",
         null,
-        react_1.default.createElement("strong", null, "Default value: "),
+        react_1.default.createElement(
+          "strong",
+          null,
+          (0, Translate_1.translate)({
+            id: translationIds_1.OPENAPI_SCHEMA_ITEM.DEFAULT_VALUE,
+            message: "Default value:",
+          }),
+          " "
+        ),
         react_1.default.createElement(
           "span",
           null,
@@ -145,40 +183,21 @@ function SchemaItem(props) {
     }
     return undefined;
   }
-  function renderExample() {
-    if (example !== undefined) {
-      if (typeof example === "string") {
-        return react_1.default.createElement(
-          "div",
-          null,
-          react_1.default.createElement("strong", null, "Example: "),
-          react_1.default.createElement(
-            "span",
-            null,
-            react_1.default.createElement("code", null, example)
-          )
-        );
-      }
-      return react_1.default.createElement(
-        "div",
-        null,
-        react_1.default.createElement("strong", null, "Example: "),
-        react_1.default.createElement(
-          "span",
-          null,
-          react_1.default.createElement("code", null, JSON.stringify(example))
-        )
-      );
-    }
-    return undefined;
-  }
   function renderConstValue() {
     if (constValue !== undefined) {
       if (typeof constValue === "string") {
         return react_1.default.createElement(
           "div",
           null,
-          react_1.default.createElement("strong", null, "Constant value: "),
+          react_1.default.createElement(
+            "strong",
+            null,
+            (0, Translate_1.translate)({
+              id: translationIds_1.OPENAPI_SCHEMA_ITEM.CONSTANT_VALUE,
+              message: "Constant value:",
+            }),
+            " "
+          ),
           react_1.default.createElement(
             "span",
             null,
@@ -189,7 +208,15 @@ function SchemaItem(props) {
       return react_1.default.createElement(
         "div",
         null,
-        react_1.default.createElement("strong", null, "Constant value: "),
+        react_1.default.createElement(
+          "strong",
+          null,
+          (0, Translate_1.translate)({
+            id: translationIds_1.OPENAPI_SCHEMA_ITEM.CONSTANT_VALUE,
+            message: "Constant value:",
+          }),
+          " "
+        ),
         react_1.default.createElement(
           "span",
           null,
@@ -236,7 +263,8 @@ function SchemaItem(props) {
     renderQualifierMessage,
     renderConstValue(),
     renderDefaultValue(),
-    renderExample(),
+    react_1.default.createElement(Example_1.Example, { example: example }),
+    react_1.default.createElement(Example_1.Example, { examples: examples }),
     collapsibleSchemaContent ?? collapsibleSchemaContent
   );
   return react_1.default.createElement(

package/lib/theme/SchemaTabs/index.js

@@ -141,7 +141,10 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
   };
   return react_1.default.createElement(
     "div",
-    { className: "openapi-tabs__schema-tabs-container" },
+    {
+      className: "openapi-tabs__schema-tabs-container",
+      style: { marginBottom: "1rem" },
+    },
     showTabArrows &&
       react_1.default.createElement("button", {
         className: "openapi-tabs__arrow left",