docusaurus-theme-openapi-docs 0.0.0-1054 → 0.0.0-1056

package/lib/theme/ParamsItem/index.js

@@ -12,16 +12,26 @@ var __importDefault =
   };
 Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = __importDefault(require("react"));
+const Translate_1 = require("@docusaurus/Translate");
 const Markdown_1 = __importDefault(require("@theme/Markdown"));
 const SchemaTabs_1 = __importDefault(require("@theme/SchemaTabs"));
 const TabItem_1 = __importDefault(require("@theme/TabItem"));
 /* eslint-disable import/no-extraneous-dependencies*/
 const clsx_1 = __importDefault(require("clsx"));
+const translationIds_1 = require("@theme/translationIds");
 const schema_1 = require("../../markdown/schema");
 const utils_1 = require("../../markdown/utils");
 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) => {
@@ -69,14 +79,20 @@ function ParamsItem({ param, ...rest }) {
     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 renderQualifier = (0, utils_1.guard)(
@@ -103,7 +119,15 @@ function ParamsItem({ param, ...rest }) {
         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,
@@ -114,7 +138,15 @@ function ParamsItem({ param, ...rest }) {
       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,
@@ -134,7 +166,15 @@ function ParamsItem({ param, ...rest }) {
       react_1.default.createElement(
         "div",
         null,
-        react_1.default.createElement("strong", null, "Example: "),
+        react_1.default.createElement(
+          "strong",
+          null,
+          (0, Translate_1.translate)({
+            id: translationIds_1.OPENAPI_SCHEMA_ITEM.EXAMPLE,
+            message: "Example:",
+          }),
+          " "
+        ),
         example
       )
   );
@@ -143,7 +183,14 @@ function ParamsItem({ param, ...rest }) {
     return react_1.default.createElement(
       react_1.default.Fragment,
       null,
-      react_1.default.createElement("strong", null, "Examples:"),
+      react_1.default.createElement(
+        "strong",
+        null,
+        (0, Translate_1.translate)({
+          id: translationIds_1.OPENAPI_SCHEMA_ITEM.EXAMPLES,
+          message: "Examples:",
+        })
+      ),
       react_1.default.createElement(
         SchemaTabs_1.default,
         null,
@@ -162,7 +209,15 @@ function ParamsItem({ param, ...rest }) {
               react_1.default.createElement(
                 "p",
                 null,
-                react_1.default.createElement("strong", null, "Description: "),
+                react_1.default.createElement(
+                  "strong",
+                  null,
+                  (0, Translate_1.translate)({
+                    id: translationIds_1.OPENAPI_SCHEMA_ITEM.DESCRIPTION,
+                    message: "Description:",
+                  }),
+                  " "
+                ),
                 react_1.default.createElement(
                   "span",
                   null,
@@ -172,7 +227,15 @@ function ParamsItem({ param, ...rest }) {
             react_1.default.createElement(
               "p",
               null,
-              react_1.default.createElement("strong", null, "Example: "),
+              react_1.default.createElement(
+                "strong",
+                null,
+                (0, Translate_1.translate)({
+                  id: translationIds_1.OPENAPI_SCHEMA_ITEM.EXAMPLE,
+                  message: "Example:",
+                }),
+                " "
+              ),
               react_1.default.createElement(
                 "code",
                 null,

package/lib/theme/RequestSchema/index.js

@@ -12,6 +12,8 @@ var __importDefault =
   };
 Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = __importDefault(require("react"));
+const Translate_1 = require("@docusaurus/Translate");
+const translationIds_1 = require("@theme/translationIds");
 const BrowserOnly_1 = __importDefault(require("@docusaurus/BrowserOnly"));
 const Details_1 = __importDefault(require("@theme/Details"));
 const Markdown_1 = __importDefault(require("@theme/Markdown"));
@@ -66,12 +68,18 @@ const RequestSchemaComponent = ({ title, body, style }) => {
                         className:
                           "openapi-markdown__details-summary-header-body",
                       },
-                      title,
+                      (0, Translate_1.translate)({
+                        id: translationIds_1.OPENAPI_REQUEST.BODY_TITLE,
+                        message: title,
+                      }),
                       body.required === true &&
                         react_1.default.createElement(
                           "span",
                           { className: "openapi-schema__required" },
-                          "required"
+                          (0, Translate_1.translate)({
+                            id: translationIds_1.OPENAPI_SCHEMA_ITEM.REQUIRED,
+                            message: "required",
+                          })
                         )
                     )
                   )
@@ -133,7 +141,10 @@ const RequestSchemaComponent = ({ title, body, style }) => {
               react_1.default.createElement(
                 "h3",
                 { className: "openapi-markdown__details-summary-header-body" },
-                title,
+                (0, Translate_1.translate)({
+                  id: translationIds_1.OPENAPI_REQUEST.BODY_TITLE,
+                  message: title,
+                }),
                 firstBody.type === "array" &&
                   react_1.default.createElement(
                     "span",
@@ -144,7 +155,10 @@ const RequestSchemaComponent = ({ title, body, style }) => {
                   react_1.default.createElement(
                     "strong",
                     { className: "openapi-schema__required" },
-                    "required"
+                    (0, Translate_1.translate)({
+                      id: translationIds_1.OPENAPI_SCHEMA_ITEM.REQUIRED,
+                      message: "required",
+                    })
                   )
               )
             )

package/lib/theme/ResponseExamples/index.js

@@ -17,9 +17,11 @@ exports.ExampleFromSchema =
     void 0;
 exports.json2xml = json2xml;
 const react_1 = __importDefault(require("react"));
+const Translate_1 = require("@docusaurus/Translate");
 const CodeSamples_1 = __importDefault(require("@theme/CodeSamples"));
 const Markdown_1 = __importDefault(require("@theme/Markdown"));
 const TabItem_1 = __importDefault(require("@theme/TabItem"));
+const translationIds_1 = require("@theme/translationIds");
 const createResponseExample_1 = require("docusaurus-plugin-openapi-docs/lib/openapi/createResponseExample");
 const xml_formatter_1 = __importDefault(require("xml-formatter"));
 function json2xml(o, tab) {
@@ -107,7 +109,13 @@ const ResponseExample = ({ responseExample, mimeType }) => {
     // @ts-ignore
     react_1.default.createElement(
       TabItem_1.default,
-      { label: "Example", value: "Example" },
+      {
+        label: (0, Translate_1.translate)({
+          id: translationIds_1.OPENAPI_RESPONSE_EXAMPLES.EXAMPLE,
+          message: "Example",
+        }),
+        value: "Example",
+      },
       responseExample.summary &&
         react_1.default.createElement(
           Markdown_1.default,
@@ -163,7 +171,13 @@ const ExampleFromSchema = ({ schema, mimeType }) => {
         // @ts-ignore
         react_1.default.createElement(
           TabItem_1.default,
-          { label: "Example (auto)", value: "Example (auto)" },
+          {
+            label: (0, Translate_1.translate)({
+              id: translationIds_1.OPENAPI_RESPONSE_EXAMPLES.AUTO_EXAMPLE,
+              message: "Example (auto)",
+            }),
+            value: "Example (auto)",
+          },
           react_1.default.createElement(CodeSamples_1.default, {
             example: xmlExample,
             language: "xml",
@@ -180,7 +194,13 @@ const ExampleFromSchema = ({ schema, mimeType }) => {
       // @ts-ignore
       react_1.default.createElement(
         TabItem_1.default,
-        { label: "Example (auto)", value: "Example (auto)" },
+        {
+          label: (0, Translate_1.translate)({
+            id: translationIds_1.OPENAPI_RESPONSE_EXAMPLES.AUTO_EXAMPLE,
+            message: "Example (auto)",
+          }),
+          value: "Example (auto)",
+        },
         react_1.default.createElement(CodeSamples_1.default, {
           example: JSON.stringify(responseExample, null, 2),
           language: "json",

package/lib/theme/ResponseSchema/index.js

@@ -12,6 +12,8 @@ var __importDefault =
   };
 Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = __importDefault(require("react"));
+const Translate_1 = require("@docusaurus/Translate");
+const translationIds_1 = require("@theme/translationIds");
 const BrowserOnly_1 = __importDefault(require("@docusaurus/BrowserOnly"));
 const Details_1 = __importDefault(require("@theme/Details"));
 const Markdown_1 = __importDefault(require("@theme/Markdown"));
@@ -84,7 +86,11 @@ const ResponseSchemaComponent = ({ title, body, style }) => {
                               react_1.default.createElement(
                                 "span",
                                 { className: "openapi-schema__required" },
-                                "required"
+                                (0, Translate_1.translate)({
+                                  id: translationIds_1.OPENAPI_SCHEMA_ITEM
+                                    .REQUIRED,
+                                  message: "required",
+                                })
                               )
                           )
                         )

package/lib/theme/Schema/index.js

@@ -12,6 +12,8 @@ var __importDefault =
   };
 Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = __importDefault(require("react"));
+const Translate_1 = require("@docusaurus/Translate");
+const translationIds_1 = require("@theme/translationIds");
 const ArrayBrackets_1 = require("@theme/ArrayBrackets");
 const Details_1 = __importDefault(require("@theme/Details"));
 const DiscriminatorTabs_1 = __importDefault(
@@ -77,25 +79,43 @@ 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",
+      });
   return react_1.default.createElement(
     react_1.default.Fragment,
     null,
@@ -107,7 +127,7 @@ const AnyOneOf = ({ schema, schemaType }) => {
     react_1.default.createElement(
       SchemaTabs_1.default,
       null,
-      schema[type]?.map((anyOneSchema, index) => {
+      schema[key]?.map((anyOneSchema, index) => {
         const label = anyOneSchema.title || anyOneSchema.type;
         return (
           // @ts-ignore
@@ -262,7 +282,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(

package/lib/theme/SchemaItem/index.js

@@ -15,6 +15,8 @@ exports.default = SchemaItem;
 const react_1 = __importDefault(require("react"));
 const Markdown_1 = __importDefault(require("@theme/Markdown"));
 const clsx_1 = __importDefault(require("clsx"));
+const Translate_1 = require("@docusaurus/Translate");
+const translationIds_1 = require("@theme/translationIds");
 const utils_1 = require("../../markdown/utils");
 const transformEnumDescriptions = (enumDescriptions) => {
   if (enumDescriptions) {
@@ -24,7 +26,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) => {
@@ -69,21 +79,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 +139,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 +158,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,
@@ -151,7 +186,15 @@ function SchemaItem(props) {
         return react_1.default.createElement(
           "div",
           null,
-          react_1.default.createElement("strong", null, "Example: "),
+          react_1.default.createElement(
+            "strong",
+            null,
+            (0, Translate_1.translate)({
+              id: translationIds_1.OPENAPI_SCHEMA_ITEM.EXAMPLE,
+              message: "Example:",
+            }),
+            " "
+          ),
           react_1.default.createElement(
             "span",
             null,
@@ -162,7 +205,15 @@ function SchemaItem(props) {
       return react_1.default.createElement(
         "div",
         null,
-        react_1.default.createElement("strong", null, "Example: "),
+        react_1.default.createElement(
+          "strong",
+          null,
+          (0, Translate_1.translate)({
+            id: translationIds_1.OPENAPI_SCHEMA_ITEM.EXAMPLE,
+            message: "Example:",
+          }),
+          " "
+        ),
         react_1.default.createElement(
           "span",
           null,
@@ -178,7 +229,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,
@@ -189,7 +248,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,

package/lib/theme/StatusCodes/index.js

@@ -12,12 +12,14 @@ var __importDefault =
   };
 Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = __importDefault(require("react"));
+const Translate_1 = require("@docusaurus/Translate");
 const ApiTabs_1 = __importDefault(require("@theme/ApiTabs"));
 const Details_1 = __importDefault(require("@theme/Details"));
 const Markdown_1 = __importDefault(require("@theme/Markdown"));
 const ResponseHeaders_1 = __importDefault(require("@theme/ResponseHeaders"));
 const ResponseSchema_1 = __importDefault(require("@theme/ResponseSchema"));
 const TabItem_1 = __importDefault(require("@theme/TabItem"));
+const translationIds_1 = require("@theme/translationIds");
 const StatusCodes = ({ label, id, responses }) => {
   if (!responses) return null;
   const codes = Object.keys(responses);
@@ -61,7 +63,11 @@ const StatusCodes = ({ label, id, responses }) => {
                   react_1.default.createElement(
                     "strong",
                     null,
-                    "Response Headers"
+                    (0, Translate_1.translate)({
+                      id: translationIds_1.OPENAPI_STATUS_CODES
+                        .RESPONSE_HEADERS,
+                      message: "Response Headers",
+                    })
                   )
                 ),
               },
@@ -70,7 +76,10 @@ const StatusCodes = ({ label, id, responses }) => {
               })
             ),
           react_1.default.createElement(ResponseSchema_1.default, {
-            title: "Schema",
+            title: (0, Translate_1.translate)({
+              id: translationIds_1.OPENAPI_STATUS_CODES.SCHEMA_TITLE,
+              message: "Schema",
+            }),
             body: { content: response.content },
           })
         )

package/lib/theme/translationIds.d.ts

@@ -0,0 +1,83 @@
+export declare const OPENAPI_RESPONSE: {
+    TITLE: string;
+    CLEAR: string;
+    PLACEHOLDER: string;
+    HEADERS_TAB: string;
+};
+export declare const OPENAPI_TABS: {
+    RESPONSES_LABEL: string;
+};
+export declare const OPENAPI_REQUEST: {
+    BODY_TITLE: string;
+    ACCEPT_TITLE: string;
+    SEND_BUTTON: string;
+    REQUIRED_LABEL: string;
+    REQUEST_TITLE: string;
+    COLLAPSE_ALL: string;
+    EXPAND_ALL: string;
+    BASE_URL_TITLE: string;
+    AUTH_TITLE: string;
+    PARAMETERS_TITLE: string;
+    FETCHING_MESSAGE: string;
+    CONNECTION_FAILED: string;
+};
+export declare const OPENAPI_SERVER: {
+    EDIT_BUTTON: string;
+    HIDE_BUTTON: string;
+};
+export declare const OPENAPI_PARAM_OPTIONS: {
+    SHOW_OPTIONAL: string;
+    HIDE_OPTIONAL: string;
+};
+export declare const OPENAPI_FORM_FILE_UPLOAD: {
+    CLEAR_BUTTON: string;
+};
+export declare const OPENAPI_FORM: {
+    FIELD_REQUIRED: string;
+};
+export declare const OPENAPI_AUTH: {
+    BEARER_TOKEN: string;
+    USERNAME: string;
+    PASSWORD: string;
+    SECURITY_SCHEME: string;
+};
+export declare const OPENAPI_RESPONSE_EXAMPLES: {
+    EXAMPLE: string;
+    AUTO_EXAMPLE: string;
+};
+export declare const OPENAPI_BODY: {
+    EXAMPLE_FROM_SCHEMA: string;
+};
+export declare const OPENAPI_STATUS_CODES: {
+    RESPONSE_HEADERS: string;
+    SCHEMA_TITLE: string;
+};
+export declare const OPENAPI_SCHEMA_ITEM: {
+    REQUIRED: string;
+    DEPRECATED: string;
+    NULLABLE: string;
+    DEFAULT_VALUE: string;
+    EXAMPLE: string;
+    EXAMPLES: string;
+    DESCRIPTION: string;
+    CONSTANT_VALUE: string;
+    ENUM_VALUE: string;
+    ENUM_DESCRIPTION: string;
+    POSSIBLE_VALUES: string;
+    ONE_OF: string;
+    ANY_OF: string;
+};
+export declare const OPENAPI_PARAMS_DETAILS: {
+    PARAMETERS_TITLE: string;
+};
+export declare const OPENAPI_SECURITY_SCHEMES: {
+    NAME: string;
+    TYPE: string;
+    SCOPES: string;
+    IN: string;
+    FLOWS: string;
+    DESCRIPTION: string;
+    SCHEME: string;
+    BEARER_FORMAT: string;
+    OPEN_ID_CONNECT_URL: string;
+};