docusaurus-theme-openapi-docs 4.5.1 → 4.7.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.d.ts

@@ -3,6 +3,12 @@ import { SchemaObject } from "docusaurus-plugin-openapi-docs/lib/openapi/types";
 interface SchemaProps {
     schema: SchemaObject;
     schemaType: "request" | "response";
+    /**
+     * Optional path identifier for tracking anyOf/oneOf selections.
+     * When provided, tab selections will be dispatched to Redux state
+     * to enable dynamic body example updates.
+     */
+    schemaPath?: string;
 }
 declare const SchemaNode: React.FC<SchemaProps>;
 export default SchemaNode;