docusaurus-theme-openapi-docs 4.5.1 → 4.7.0

package/src/theme/ResponseExamples/index.tsx

@@ -7,9 +7,11 @@
 
 import React from "react";
 
+import { translate } from "@docusaurus/Translate";
 import CodeSamples from "@theme/CodeSamples";
 import Markdown from "@theme/Markdown";
 import TabItem from "@theme/TabItem";
+import { OPENAPI_RESPONSE_EXAMPLES } from "@theme/translationIds";
 import { sampleResponseFromSchema } from "docusaurus-plugin-openapi-docs/lib/openapi/createResponseExample";
 import format from "xml-formatter";
 
@@ -111,7 +113,13 @@ export const ResponseExample: React.FC<ResponseExampleProps> = ({
 
   return (
     // @ts-ignore
-    <TabItem label="Example" value="Example">
+    <TabItem
+      label={translate({
+        id: OPENAPI_RESPONSE_EXAMPLES.EXAMPLE,
+        message: "Example",
+      })}
+      value="Example"
+    >
       {responseExample.summary && (
         <Markdown className="openapi-example__summary">
           {responseExample.summary}
@@ -163,7 +171,13 @@ export const ExampleFromSchema: React.FC<ExampleFromSchemaProps> = ({
       }
       return (
         // @ts-ignore
-        <TabItem label="Example (auto)" value="Example (auto)">
+        <TabItem
+          label={translate({
+            id: OPENAPI_RESPONSE_EXAMPLES.AUTO_EXAMPLE,
+            message: "Example (auto)",
+          })}
+          value="Example (auto)"
+        >
           <CodeSamples example={xmlExample} language="xml" />
         </TabItem>
       );
@@ -176,7 +190,13 @@ export const ExampleFromSchema: React.FC<ExampleFromSchemaProps> = ({
   ) {
     return (
       // @ts-ignore
-      <TabItem label="Example (auto)" value="Example (auto)">
+      <TabItem
+        label={translate({
+          id: OPENAPI_RESPONSE_EXAMPLES.AUTO_EXAMPLE,
+          message: "Example (auto)",
+        })}
+        value="Example (auto)"
+      >
         <CodeSamples
           example={JSON.stringify(responseExample, null, 2)}
           language="json"

package/src/theme/ResponseSchema/index.tsx

@@ -8,6 +8,7 @@
 import React from "react";
 
 import BrowserOnly from "@docusaurus/BrowserOnly";
+import { translate } from "@docusaurus/Translate";
 import Details from "@theme/Details";
 import Markdown from "@theme/Markdown";
 import MimeTabs from "@theme/MimeTabs"; // Assume these components exist
@@ -20,6 +21,7 @@ import SchemaNode from "@theme/Schema";
 import SchemaTabs from "@theme/SchemaTabs";
 import SkeletonLoader from "@theme/SkeletonLoader";
 import TabItem from "@theme/TabItem";
+import { OPENAPI_SCHEMA, OPENAPI_SCHEMA_ITEM } from "@theme/translationIds";
 import { MediaTypeObject } from "docusaurus-plugin-openapi-docs/lib/openapi/types";
 
 interface Props {
@@ -54,76 +56,86 @@ const ResponseSchemaComponent: React.FC<Props> = ({
     return (
       <MimeTabs className="openapi-tabs__mime" schemaType="response">
         {mimeTypes.map((mimeType: any) => {
-          const responseExamples = body.content![mimeType].examples;
-          const responseExample = body.content![mimeType].example;
-          const firstBody: any =
-            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
               <TabItem key={mimeType} label={mimeType} value={mimeType}>
-                <SchemaTabs className="openapi-tabs__schema">
-                  {/* @ts-ignore */}
-                  <TabItem key={title} label={title} value={title}>
-                    <Details
-                      className="openapi-markdown__details response"
-                      data-collapsed={false}
-                      open={true}
-                      style={style}
-                      summary={
-                        <>
-                          <summary>
-                            <strong className="openapi-markdown__details-summary-response">
-                              {title}
-                              {body.required === true && (
-                                <span className="openapi-schema__required">
-                                  required
-                                </span>
-                              )}
-                            </strong>
-                          </summary>
-                        </>
-                      }
-                    >
-                      <div style={{ textAlign: "left", marginLeft: "1rem" }}>
-                        {body.description && (
-                          <div
-                            style={{ marginTop: "1rem", marginBottom: "1rem" }}
-                          >
-                            <Markdown>{body.description}</Markdown>
-                          </div>
-                        )}
-                      </div>
-                      <ul style={{ marginLeft: "1rem" }}>
-                        <SchemaNode schema={firstBody} schemaType="response" />
-                      </ul>
-                    </Details>
-                  </TabItem>
-                  {firstBody &&
-                    ExampleFromSchema({
-                      schema: firstBody,
-                      mimeType: mimeType,
-                    })}
-
-                  {responseExamples &&
-                    ResponseExamples({ responseExamples, mimeType })}
-
-                  {responseExample &&
-                    ResponseExample({ responseExample, mimeType })}
-                </SchemaTabs>
+                <div>
+                  {translate({
+                    id: OPENAPI_SCHEMA.NO_SCHEMA,
+                    message: "No schema",
+                  })}
+                </div>
               </TabItem>
             );
           }
-          return undefined;
+
+          return (
+            // @ts-ignore
+            <TabItem key={mimeType} label={mimeType} value={mimeType}>
+              <SchemaTabs className="openapi-tabs__schema">
+                {/* @ts-ignore */}
+                <TabItem key={title} label={title} value={title}>
+                  <Details
+                    className="openapi-markdown__details response"
+                    data-collapsed={false}
+                    open={true}
+                    style={style}
+                    summary={
+                      <>
+                        <summary>
+                          <strong className="openapi-markdown__details-summary-response">
+                            {title}
+                            {body.required === true && (
+                              <span className="openapi-schema__required">
+                                {translate({
+                                  id: OPENAPI_SCHEMA_ITEM.REQUIRED,
+                                  message: "required",
+                                })}
+                              </span>
+                            )}
+                          </strong>
+                        </summary>
+                      </>
+                    }
+                  >
+                    <div style={{ textAlign: "left", marginLeft: "1rem" }}>
+                      {body.description && (
+                        <div
+                          style={{ marginTop: "1rem", marginBottom: "1rem" }}
+                        >
+                          <Markdown>{body.description}</Markdown>
+                        </div>
+                      )}
+                    </div>
+                    <ul style={{ marginLeft: "1rem" }}>
+                      <SchemaNode schema={firstBody} schemaType="response" />
+                    </ul>
+                  </Details>
+                </TabItem>
+                {firstBody &&
+                  ExampleFromSchema({
+                    schema: firstBody,
+                    mimeType: mimeType,
+                  })}
+
+                {responseExamples &&
+                  ResponseExamples({ responseExamples, mimeType })}
+
+                {responseExample &&
+                  ResponseExample({ responseExample, mimeType })}
+              </SchemaTabs>
+            </TabItem>
+          );
         })}
       </MimeTabs>
     );