diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/__snapshots__/createSchema.test.ts.snap b/packages/docusaurus-plugin-openapi-docs/src/markdown/__snapshots__/createSchema.test.ts.snap index 3d4d9548d..7a93bdd73 100644 --- a/packages/docusaurus-plugin-openapi-docs/src/markdown/__snapshots__/createSchema.test.ts.snap +++ b/packages/docusaurus-plugin-openapi-docs/src/markdown/__snapshots__/createSchema.test.ts.snap @@ -13,7 +13,7 @@ Array [
- oneOf + oneOf @@ -399,7 +399,7 @@ Array [
- anyOf + anyOf @@ -408,7 +408,7 @@ Array [ className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }} > - oneOf + oneOf @@ -451,7 +451,7 @@ Array [
- anyOf + anyOf @@ -477,7 +477,7 @@ exports[`createNodes discriminator should handle basic discriminator with mappin Array [ "
- oneOf + oneOf @@ -554,7 +554,7 @@ exports[`createNodes discriminator should handle basic discriminator with oneOf Array [ "
- oneOf + oneOf @@ -612,7 +612,7 @@ exports[`createNodes discriminator should handle discriminator with additional p Array [ "
- oneOf + oneOf @@ -679,7 +679,7 @@ Array [ ", "
- oneOf + oneOf @@ -774,7 +774,7 @@ Array [ ", "
- oneOf + oneOf @@ -860,7 +860,7 @@ exports[`createNodes discriminator should handle discriminator with nested schem Array [ "
- oneOf + oneOf @@ -958,7 +958,7 @@ exports[`createNodes discriminator should handle discriminator with required pro Array [ "
- oneOf + oneOf @@ -1016,7 +1016,7 @@ exports[`createNodes discriminator should handle discriminator with required pro Array [ "
- oneOf + oneOf @@ -1093,7 +1093,7 @@ exports[`createNodes discriminator should handle discriminator with shared prope Array [ "
- oneOf + oneOf @@ -1160,7 +1160,7 @@ exports[`createNodes discriminator should handle discriminator with shared prope Array [ "
- oneOf + oneOf @@ -1255,7 +1255,7 @@ Array [
- oneOf + oneOf @@ -1345,7 +1345,7 @@ Array [
- oneOf + oneOf @@ -1365,7 +1365,7 @@ Array [ className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }} > - oneOf + oneOf @@ -1415,7 +1415,7 @@ Array [
- oneOf + oneOf @@ -1478,7 +1478,7 @@ Array [
- oneOf + oneOf @@ -1518,7 +1518,7 @@ Array [
- oneOf + oneOf @@ -1572,7 +1572,7 @@ Array [
- oneOf + oneOf diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/createRequestHeader.ts b/packages/docusaurus-plugin-openapi-docs/src/markdown/createRequestHeader.ts index 1b41c698f..80308d3c5 100644 --- a/packages/docusaurus-plugin-openapi-docs/src/markdown/createRequestHeader.ts +++ b/packages/docusaurus-plugin-openapi-docs/src/markdown/createRequestHeader.ts @@ -8,17 +8,18 @@ import { create } from "./utils"; export function createRequestHeader(header: string) { + const id = header.replace(" ", "-").toLowerCase(); return [ - create( - "Heading", - { - children: header, - id: header.replace(" ", "-").toLowerCase(), - as: "h2", - className: "openapi-tabs__heading", - }, - { inline: true } - ), + create("Heading", { + id, + as: "h2", + className: "openapi-tabs__heading", + children: [ + ``, + header, + "", + ], + }), `\n\n`, ]; } diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/createSchema.ts b/packages/docusaurus-plugin-openapi-docs/src/markdown/createSchema.ts index bea754db0..69f4561fe 100644 --- a/packages/docusaurus-plugin-openapi-docs/src/markdown/createSchema.ts +++ b/packages/docusaurus-plugin-openapi-docs/src/markdown/createSchema.ts @@ -40,11 +40,12 @@ export function mergeAllOf(allOf: SchemaObject) { */ function createAnyOneOf(schema: SchemaObject): any { const type = schema.oneOf ? "oneOf" : "anyOf"; + const translatedType = `${type}`; return create("div", { children: [ create("span", { className: "badge badge--info", - children: type, + children: translatedType, style: { marginBottom: "1rem" }, }), create("SchemaTabs", { @@ -375,7 +376,8 @@ function createDetailsNode( () => [ create("span", { className: "openapi-schema__required", - children: "required", + children: + 'required', }), ] ), @@ -530,7 +532,8 @@ function createPropertyDiscriminator( guard(required, () => [ create("span", { className: "openapi-schema__required", - children: "required", + children: + 'required', }), ]), ], diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/index.ts b/packages/docusaurus-plugin-openapi-docs/src/markdown/index.ts index 6588b3118..c80fa4952 100644 --- a/packages/docusaurus-plugin-openapi-docs/src/markdown/index.ts +++ b/packages/docusaurus-plugin-openapi-docs/src/markdown/index.ts @@ -66,6 +66,7 @@ export function createApiPageMD({ frontMatter, }: ApiPageMetadata) { return render([ + `import Translate from "@docusaurus/Translate";\n`, `import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";\n`, `import ParamsDetails from "@theme/ParamsDetails";\n`, `import RequestSchema from "@theme/RequestSchema";\n`, diff --git a/packages/docusaurus-theme-openapi-docs/src/markdown/schema.ts b/packages/docusaurus-theme-openapi-docs/src/markdown/schema.ts index 58f8cb487..ab7b48fd1 100644 --- a/packages/docusaurus-theme-openapi-docs/src/markdown/schema.ts +++ b/packages/docusaurus-theme-openapi-docs/src/markdown/schema.ts @@ -5,6 +5,8 @@ * LICENSE file in the root directory of this source tree. * ========================================================================== */ +import { translate } from "@docusaurus/Translate"; + import { SchemaObject } from "../types"; function prettyName(schema: SchemaObject, circular?: boolean) { @@ -72,7 +74,11 @@ export function getQualifierMessage(schema?: SchemaObject): string | undefined { return getQualifierMessage(schema.items); } - let message = "**Possible values:** "; + const possibleValues = translate({ + id: "theme.schema.possibleValues", + message: "Possible values:", + }); + let message = `**${possibleValues}** `; let qualifierGroups = []; diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Authorization/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Authorization/index.tsx index eccd7571c..16772f280 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Authorization/index.tsx +++ b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Authorization/index.tsx @@ -7,10 +7,12 @@ import React from "react"; +import { translate } from "@docusaurus/Translate"; import FormItem from "@theme/ApiExplorer/FormItem"; import FormSelect from "@theme/ApiExplorer/FormSelect"; import FormTextInput from "@theme/ApiExplorer/FormTextInput"; import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks"; +import { OPENAPI_AUTH } from "@theme/translationIds"; import { setAuthData, setSelectedAuth } from "./slice"; @@ -32,7 +34,12 @@ function Authorization() { return (
{optionKeys.length > 1 && ( - + { if (a.type === "http" && a.scheme === "bearer") { return ( - + ) => { @@ -67,9 +83,18 @@ function Authorization() { if (a.type === "oauth2") { return ( - + ) => { @@ -90,9 +115,17 @@ function Authorization() { if (a.type === "http" && a.scheme === "basic") { return ( - + ) => { const value = e.target.value; @@ -106,9 +139,17 @@ function Authorization() { }} /> - + ) => { diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Body/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Body/index.tsx index 36ba7151e..f21092452 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Body/index.tsx +++ b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Body/index.tsx @@ -7,6 +7,8 @@ import React from "react"; +import { translate } from "@docusaurus/Translate"; + import json2xml from "@theme/ApiExplorer/Body/json2xml"; import FormFileUpload from "@theme/ApiExplorer/FormFileUpload"; import FormItem from "@theme/ApiExplorer/FormItem"; @@ -17,6 +19,7 @@ import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks"; import Markdown from "@theme/Markdown"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; +import { OPENAPI_BODY, OPENAPI_REQUEST } from "@theme/translationIds"; import { RequestBodyObject } from "docusaurus-plugin-openapi-docs/src/openapi/types"; import format from "xml-formatter"; @@ -98,7 +101,10 @@ function Body({ return ( { if (file === undefined) { dispatch(clearRawBody()); @@ -302,7 +308,10 @@ function Body({ {/* @ts-ignore */} @@ -334,7 +343,10 @@ function Body({ {/* @ts-ignore */} diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/FormFileUpload/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/FormFileUpload/index.tsx index a221d10f2..386f2d7cf 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/FormFileUpload/index.tsx +++ b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/FormFileUpload/index.tsx @@ -7,7 +7,9 @@ import React, { useState } from "react"; +import { translate } from "@docusaurus/Translate"; import FloatingButton from "@theme/ApiExplorer/FloatingButton"; +import { OPENAPI_FORM_FILE_UPLOAD } from "@theme/translationIds"; import MagicDropzone from "react-magic-dropzone"; type PreviewFile = { preview: string } & File; @@ -102,7 +104,10 @@ function FormFileUpload({ placeholder, onChange }: Props) { setAndNotifyFile(undefined); }} > - Clear + {translate({ + id: OPENAPI_FORM_FILE_UPLOAD.CLEAR_BUTTON, + message: "Clear", + })} diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/FormItem/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/FormItem/index.tsx index 46c6e59c4..baa69ae6b 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/FormItem/index.tsx +++ b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/FormItem/index.tsx @@ -7,6 +7,9 @@ import React from "react"; +import { translate } from "@docusaurus/Translate"; +import { OPENAPI_SCHEMA_ITEM } from "@theme/translationIds"; + import clsx from "clsx"; export interface Props { @@ -24,7 +27,11 @@ function FormItem({ label, type, required, children, className }: Props) { )} {type && — {type}} - {required && required} + {required && ( + + {translate({ id: OPENAPI_SCHEMA_ITEM.REQUIRED, message: "required" })} + + )}
{children}
); diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/FormTextInput/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/FormTextInput/index.tsx index a429bb6db..31545a6fc 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/FormTextInput/index.tsx +++ b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/FormTextInput/index.tsx @@ -8,7 +8,9 @@ // @ts-nocheck import React from "react"; +import { translate } from "@docusaurus/Translate"; import { ErrorMessage } from "@hookform/error-message"; +import { OPENAPI_FORM } from "@theme/translationIds"; import clsx from "clsx"; import { useFormContext } from "react-hook-form"; @@ -41,7 +43,12 @@ function FormTextInput({ {paramName ? ( ( diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamArrayFormItem.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamArrayFormItem.tsx index b119cb4b4..dc1e8b9b5 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamArrayFormItem.tsx +++ b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamArrayFormItem.tsx @@ -7,12 +7,14 @@ import React, { useEffect, useState } from "react"; +import { translate } from "@docusaurus/Translate"; import { ErrorMessage } from "@hookform/error-message"; import { nanoid } from "@reduxjs/toolkit"; import FormSelect from "@theme/ApiExplorer/FormSelect"; import FormTextInput from "@theme/ApiExplorer/FormTextInput"; import { Param, setParam } from "@theme/ApiExplorer/ParamOptions/slice"; import { useTypedDispatch } from "@theme/ApiItem/hooks"; +import { OPENAPI_FORM } from "@theme/translationIds"; import { Controller, useFormContext } from "react-hook-form"; export interface ParamProps { @@ -121,7 +123,14 @@ export default function ParamArrayFormItem({ param }: ParamProps) { <> ( <> diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamBooleanFormItem.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamBooleanFormItem.tsx index 5774679f1..908a64635 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamBooleanFormItem.tsx +++ b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamBooleanFormItem.tsx @@ -7,10 +7,12 @@ import React from "react"; +import { translate } from "@docusaurus/Translate"; import { ErrorMessage } from "@hookform/error-message"; import FormSelect from "@theme/ApiExplorer/FormSelect"; import { Param, setParam } from "@theme/ApiExplorer/ParamOptions/slice"; import { useTypedDispatch } from "@theme/ApiItem/hooks"; +import { OPENAPI_FORM } from "@theme/translationIds"; import { Controller, useFormContext } from "react-hook-form"; export interface ParamProps { @@ -31,7 +33,14 @@ export default function ParamBooleanFormItem({ param }: ParamProps) { <> ( ( ( {showOptional - ? "Hide optional parameters" - : "Show optional parameters"} + ? translate({ + id: OPENAPI_PARAM_OPTIONS.HIDE_OPTIONAL, + message: "Hide optional parameters", + }) + : translate({ + id: OPENAPI_PARAM_OPTIONS.SHOW_OPTIONAL, + message: "Show optional parameters", + })}
{ - dispatch(setResponse("Fetching...")); + dispatch( + setResponse( + translate({ + id: OPENAPI_REQUEST.FETCHING_MESSAGE, + message: "Fetching...", + }) + ) + ); try { await delay(1200); const res = await makeRequest(postmanRequest, proxy, body); @@ -128,7 +138,14 @@ function Request({ item }: { item: ApiItem }) { } } catch (e) { console.log(e); - dispatch(setResponse("Connection failed")); + dispatch( + setResponse( + translate({ + id: OPENAPI_REQUEST.CONNECTION_FAILED, + message: "Connection failed", + }) + ) + ); dispatch(clearCode()); dispatch(clearHeaders()); } @@ -178,20 +195,31 @@ function Request({ item }: { item: ApiItem }) { onSubmit={methods.handleSubmit(onSubmit)} >
- Request + + {translate({ + id: OPENAPI_REQUEST.REQUEST_TITLE, + message: "Request", + })} + {allDetailsExpanded ? ( - Collapse all + {translate({ + id: OPENAPI_REQUEST.COLLAPSE_ALL, + message: "Collapse all", + })} ) : ( - Expand all + {translate({ + id: OPENAPI_REQUEST.EXPAND_ALL, + message: "Expand all", + })} )}
@@ -208,7 +236,10 @@ function Request({ item }: { item: ApiItem }) { setExpandServer(!expandServer); }} > - Base URL + {translate({ + id: OPENAPI_REQUEST.BASE_URL_TITLE, + message: "Base URL", + })} @@ -225,7 +256,7 @@ function Request({ item }: { item: ApiItem }) { setExpandAuth(!expandAuth); }} > - Auth + {translate({ id: OPENAPI_REQUEST.AUTH_TITLE, message: "Auth" })} @@ -244,7 +275,10 @@ function Request({ item }: { item: ApiItem }) { setExpandParams(!expandParams); }} > - Parameters + {translate({ + id: OPENAPI_REQUEST.PARAMETERS_TITLE, + message: "Parameters", + })} @@ -261,10 +295,14 @@ function Request({ item }: { item: ApiItem }) { setExpandBody(!expandBody); }} > - Body + {translate({ id: OPENAPI_REQUEST.BODY_TITLE, message: "Body" })} {requestBodyRequired && ( -  required +   + {translate({ + id: OPENAPI_REQUEST.REQUIRED_LABEL, + message: "required", + })} )} @@ -290,14 +328,20 @@ function Request({ item }: { item: ApiItem }) { setExpandAccept(!expandAccept); }} > - Accept + {translate({ + id: OPENAPI_REQUEST.ACCEPT_TITLE, + message: "Accept", + })} )} {showRequestButton && item.method !== "event" && ( )}
diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Response/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Response/index.tsx index 30b54dbc1..f5afd532e 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Response/index.tsx +++ b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Response/index.tsx @@ -9,10 +9,12 @@ import React from "react"; import { useDoc } from "@docusaurus/plugin-content-docs/client"; import { usePrismTheme } from "@docusaurus/theme-common"; +import { translate } from "@docusaurus/Translate"; import ApiCodeBlock from "@theme/ApiExplorer/ApiCodeBlock"; import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; +import { OPENAPI_RESPONSE } from "@theme/translationIds"; import clsx from "clsx"; import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types"; @@ -74,7 +76,9 @@ function Response({ item }: { item: ApiItem }) { return (
- Response + + {translate({ id: OPENAPI_RESPONSE.TITLE, message: "Response" })} + { @@ -83,7 +87,7 @@ function Response({ item }: { item: ApiItem }) { dispatch(clearHeaders()); }} > - Clear + {translate({ id: OPENAPI_RESPONSE.CLEAR, message: "Clear" })}
{prettyResponse || (

- Click the Send API Request button above and see - the response here! + {translate({ + id: OPENAPI_RESPONSE.PLACEHOLDER, + message: + "Click the Send API Request button above and see the response here!", + })}

)} {/* @ts-ignore */} - + {/* @ts-ignore */} ) : (

- Click the Send API Request button above and see the - response here! + {translate({ + id: OPENAPI_RESPONSE.PLACEHOLDER, + message: + "Click the Send API Request button above and see the response here!", + })}

)}
diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/SecuritySchemes/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/SecuritySchemes/index.tsx index 8a0dda94c..6b88a4bab 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/SecuritySchemes/index.tsx +++ b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/SecuritySchemes/index.tsx @@ -7,7 +7,11 @@ import React from "react"; +import { translate } from "@docusaurus/Translate"; +import { OPENAPI_SECURITY_SCHEMES } from "@theme/translationIds"; + import Link from "@docusaurus/Link"; +import { translate } from "@docusaurus/Translate"; import { useTypedSelector } from "@theme/ApiItem/hooks"; function SecuritySchemes(props: any) { @@ -26,7 +30,11 @@ function SecuritySchemes(props: any) {

- Authorization: {selectedAuth[0].name ?? selectedAuth[0].type} + {translate({ + id: "theme.authorization.label", + message: "Authorization:", + })}{" "} + {selectedAuth[0].name ?? selectedAuth[0].type}

{selectedAuth.map((auth: any) => { @@ -48,16 +56,31 @@ function SecuritySchemes(props: any) { }} > - name:{" "} + + {translate({ + id: OPENAPI_SECURITY_SCHEMES.NAME, + message: "name:", + })} + {" "} {name ?? key} - type: + + {translate({ + id: OPENAPI_SECURITY_SCHEMES.TYPE, + message: "type:", + })} + {" "} {type} {scopes && scopes.length > 0 && ( - scopes: + + {translate({ + id: OPENAPI_SECURITY_SCHEMES.SCOPES, + message: "scopes:", + })} + {" "} {auth.scopes.length > 0 ? auth.scopes.toString() : "[]"} @@ -66,7 +89,13 @@ function SecuritySchemes(props: any) { {Object.keys(rest).map((k, i) => { return ( - {k}: + + {translate({ + id: `theme.authorization.${k}`, + message: k, + })} + : + {typeof rest[k] === "object" ? JSON.stringify(rest[k], null, 2) : String(rest[k])} @@ -89,16 +118,31 @@ function SecuritySchemes(props: any) { }} > - name:{" "} + + {translate({ + id: OPENAPI_SECURITY_SCHEMES.NAME, + message: "name:", + })} + {" "} {name ?? key} - type: + + {translate({ + id: OPENAPI_SECURITY_SCHEMES.TYPE, + message: "type:", + })} + {" "} {type} {scopes && scopes.length > 0 && ( - scopes: + + {translate({ + id: OPENAPI_SECURITY_SCHEMES.SCOPES, + message: "scopes:", + })} + {" "} {auth.scopes.length > 0 ? auth.scopes.toString() : "[]"} @@ -107,7 +151,13 @@ function SecuritySchemes(props: any) { {Object.keys(rest).map((k, i) => { return ( - {k}: + + {translate({ + id: `theme.authorization.${k}`, + message: k, + })} + : + {typeof rest[k] === "object" ? JSON.stringify(rest[k], null, 2) : String(rest[k])} @@ -128,15 +178,30 @@ function SecuritySchemes(props: any) { }} > - name:{" "} + + {translate({ + id: OPENAPI_SECURITY_SCHEMES.NAME, + message: "name:", + })} + {" "} {auth.name ?? auth.key} - type: + + {translate({ + id: OPENAPI_SECURITY_SCHEMES.TYPE, + message: "type:", + })} + {" "} {auth.type} - in: + + {translate({ + id: OPENAPI_SECURITY_SCHEMES.IN, + message: "in:", + })} + {" "} {auth.in} @@ -156,16 +221,31 @@ function SecuritySchemes(props: any) { }} > - name:{" "} + + {translate({ + id: OPENAPI_SECURITY_SCHEMES.NAME, + message: "name:", + })} + {" "} {name ?? key} - type: + + {translate({ + id: OPENAPI_SECURITY_SCHEMES.TYPE, + message: "type:", + })} + {" "} {type} {scopes && scopes.length > 0 && ( - scopes: + + {translate({ + id: OPENAPI_SECURITY_SCHEMES.SCOPES, + message: "scopes:", + })} + {" "} {auth.scopes.length > 0 ? auth.scopes.toString() : "[]"} @@ -174,7 +254,13 @@ function SecuritySchemes(props: any) { {Object.keys(rest).map((k, i) => { return ( - {k}: + + {translate({ + id: `theme.authorization.${k}`, + message: k, + })} + : + {typeof rest[k] === "object" ? JSON.stringify(rest[k], null, 2) : String(rest[k])} @@ -198,16 +284,31 @@ function SecuritySchemes(props: any) { }} > - name:{" "} + + {translate({ + id: OPENAPI_SECURITY_SCHEMES.NAME, + message: "name:", + })} + {" "} {name ?? key} - type: + + {translate({ + id: OPENAPI_SECURITY_SCHEMES.TYPE, + message: "type:", + })} + {" "} {type} {scopes && scopes.length > 0 && ( - scopes: + + {translate({ + id: OPENAPI_SECURITY_SCHEMES.SCOPES, + message: "scopes:", + })} + {" "} {auth.scopes.length > 0 ? auth.scopes.toString() : "[]"} @@ -216,7 +317,13 @@ function SecuritySchemes(props: any) { {Object.keys(rest).map((k, i) => { return ( - {k}: + + {translate({ + id: `theme.authorization.${k}`, + message: k, + })} + : + {typeof rest[k] === "object" ? JSON.stringify(rest[k], null, 2) : String(rest[k])} @@ -226,7 +333,12 @@ function SecuritySchemes(props: any) { {flows && ( - flows: + + {translate({ + id: OPENAPI_SECURITY_SCHEMES.FLOWS, + message: "flows:", + })} + {" "} {JSON.stringify(flows, null, 2)} @@ -248,16 +360,31 @@ function SecuritySchemes(props: any) { }} > - name:{" "} + + {translate({ + id: OPENAPI_SECURITY_SCHEMES.NAME, + message: "name:", + })} + {" "} {name ?? key} - type: + + {translate({ + id: OPENAPI_SECURITY_SCHEMES.TYPE, + message: "type:", + })} + {" "} {type} {scopes && scopes.length > 0 && ( - scopes: + + {translate({ + id: OPENAPI_SECURITY_SCHEMES.SCOPES, + message: "scopes:", + })} + {" "} {auth.scopes.length > 0 ? auth.scopes.toString() : "[]"} @@ -266,7 +393,13 @@ function SecuritySchemes(props: any) { {Object.keys(rest).map((k, i) => { return ( - {k}: + + {translate({ + id: `theme.authorization.${k}`, + message: k, + })} + : + {typeof rest[k] === "object" ? JSON.stringify(rest[k], null, 2) : String(rest[k])} diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Server/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Server/index.tsx index c627d463a..0777a6adb 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Server/index.tsx +++ b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Server/index.tsx @@ -7,11 +7,13 @@ import React, { useState } from "react"; +import { translate } from "@docusaurus/Translate"; import FloatingButton from "@theme/ApiExplorer/FloatingButton"; import FormItem from "@theme/ApiExplorer/FormItem"; import FormSelect from "@theme/ApiExplorer/FormSelect"; import FormTextInput from "@theme/ApiExplorer/FormTextInput"; import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks"; +import { OPENAPI_SERVER } from "@theme/translationIds"; import { setServer, setServerVariable } from "./slice"; @@ -57,7 +59,10 @@ function Server() { } } return ( - setIsEditing(true)} label="Edit"> + setIsEditing(true)} + label={translate({ id: OPENAPI_SERVER.EDIT_BUTTON, message: "Edit" })} + > {url} @@ -68,7 +73,10 @@ function Server() { } return (
- setIsEditing(false)} label="Hide"> + setIsEditing(false)} + label={translate({ id: OPENAPI_SERVER.HIDE_BUTTON, message: "Hide" })} + > s.url)} diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiTabs/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ApiTabs/index.tsx index bcd309d77..7545069ae 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/ApiTabs/index.tsx +++ b/packages/docusaurus-theme-openapi-docs/src/theme/ApiTabs/index.tsx @@ -20,8 +20,10 @@ import { useTabs, } from "@docusaurus/theme-common/internal"; import { TabItemProps } from "@docusaurus/theme-common/lib/utils/tabsUtils"; +import { translate } from "@docusaurus/Translate"; import useIsBrowser from "@docusaurus/useIsBrowser"; import Heading from "@theme/Heading"; +import { OPENAPI_TABS } from "@theme/translationIds"; import clsx from "clsx"; export interface TabListProps extends TabProps { @@ -35,7 +37,10 @@ function TabList({ selectedValue, selectValue, tabValues, - label = "Responses", + label = translate({ + id: OPENAPI_TABS.RESPONSES_LABEL, + message: "Responses", + }), id = "responses", }: TabListProps & ReturnType) { const tabRefs: (HTMLLIElement | null)[] = []; diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ParamsDetails/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ParamsDetails/index.tsx index ad74e709f..e0beb13cb 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/ParamsDetails/index.tsx +++ b/packages/docusaurus-theme-openapi-docs/src/theme/ParamsDetails/index.tsx @@ -7,6 +7,9 @@ import React from "react"; +import { translate } from "@docusaurus/Translate"; +import { OPENAPI_PARAMS_DETAILS } from "@theme/translationIds"; + import BrowserOnly from "@docusaurus/BrowserOnly"; import Details from "@theme/Details"; import ParamsItem from "@theme/ParamsItem"; @@ -31,7 +34,13 @@ const ParamsDetailsComponent: React.FC = ({ parameters }) => { const summaryElement = (

- {`${type.charAt(0).toUpperCase() + type.slice(1)} Parameters`} + {translate( + { + id: OPENAPI_PARAMS_DETAILS.PARAMETERS_TITLE, + message: "{type} Parameters", + }, + { type: type.charAt(0).toUpperCase() + type.slice(1) } + )}

); diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ParamsItem/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ParamsItem/index.tsx index 863508e3e..351ba72c1 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/ParamsItem/index.tsx +++ b/packages/docusaurus-theme-openapi-docs/src/theme/ParamsItem/index.tsx @@ -7,11 +7,14 @@ import React from "react"; +import { translate } from "@docusaurus/Translate"; + import Markdown from "@theme/Markdown"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; /* eslint-disable import/no-extraneous-dependencies*/ import clsx from "clsx"; +import { OPENAPI_SCHEMA_ITEM } from "@theme/translationIds"; import { getQualifierMessage, getSchemaName } from "../../markdown/schema"; import { guard, toString } from "../../markdown/utils"; @@ -39,7 +42,15 @@ export interface Props { const getEnumDescriptionMarkdown = (enumDescriptions?: [string, string][]) => { if (enumDescriptions?.length) { - return `| Enum Value | Description | + const enumHeader = translate({ + id: "theme.enum.value", + message: "Enum Value", + }); + const descHeader = translate({ + id: "theme.enum.description", + message: "Description", + }); + return `| ${enumHeader} | ${descHeader} | | ---- | ----- | ${enumDescriptions .map((desc) => { @@ -87,11 +98,15 @@ function ParamsItem({ param, ...rest }: Props) { )); const renderSchemaRequired = guard(required, () => ( - required + + {translate({ id: OPENAPI_SCHEMA_ITEM.REQUIRED, message: "required" })} + )); const renderDeprecated = guard(deprecated, () => ( - deprecated + + {translate({ id: OPENAPI_SCHEMA_ITEM.DEPRECATED, message: "deprecated" })} + )); const renderQualifier = guard(getQualifierMessage(schema), (qualifier) => ( @@ -118,7 +133,12 @@ function ParamsItem({ param, ...rest }: Props) { if (typeof defaultValue === "string") { return (
- Default value: + + {translate({ + id: OPENAPI_SCHEMA_ITEM.DEFAULT_VALUE, + message: "Default value:", + })}{" "} + {defaultValue} @@ -127,7 +147,12 @@ function ParamsItem({ param, ...rest }: Props) { } return (
- Default value: + + {translate({ + id: OPENAPI_SCHEMA_ITEM.DEFAULT_VALUE, + message: "Default value:", + })}{" "} + {JSON.stringify(defaultValue)} @@ -139,7 +164,12 @@ function ParamsItem({ param, ...rest }: Props) { const renderExample = guard(toString(example), (example) => (
- Example: + + {translate({ + id: OPENAPI_SCHEMA_ITEM.EXAMPLE, + message: "Example:", + })}{" "} + {example}
)); @@ -148,7 +178,12 @@ function ParamsItem({ param, ...rest }: Props) { const exampleEntries = Object.entries(examples); return ( <> - Examples: + + {translate({ + id: OPENAPI_SCHEMA_ITEM.EXAMPLES, + message: "Examples:", + })} + {exampleEntries.map(([exampleName, exampleProperties]) => ( // @ts-ignore @@ -156,12 +191,22 @@ function ParamsItem({ param, ...rest }: Props) { {exampleProperties.summary &&

{exampleProperties.summary}

} {exampleProperties.description && (

- Description: + + {translate({ + id: OPENAPI_SCHEMA_ITEM.DESCRIPTION, + message: "Description:", + })}{" "} + {exampleProperties.description}

)}

- Example: + + {translate({ + id: OPENAPI_SCHEMA_ITEM.EXAMPLE, + message: "Example:", + })}{" "} + {exampleProperties.value}

diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/RequestSchema/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/RequestSchema/index.tsx index 9eeceb4bd..a4a057956 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/RequestSchema/index.tsx +++ b/packages/docusaurus-theme-openapi-docs/src/theme/RequestSchema/index.tsx @@ -7,7 +7,11 @@ import React from "react"; +import { translate } from "@docusaurus/Translate"; +import { OPENAPI_SCHEMA_ITEM } from "@theme/translationIds"; + 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 @@ -64,10 +68,16 @@ const RequestSchemaComponent: React.FC = ({ title, body, style }) => { <>

- {title} + {translate({ + id: `theme.RequestSchema.${title.toLowerCase()}`, + message: title, + })} {body.required === true && ( - required + {translate({ + id: OPENAPI_SCHEMA_ITEM.REQUIRED, + message: "required", + })} )}

@@ -114,13 +124,19 @@ const RequestSchemaComponent: React.FC = ({ title, body, style }) => { <>

- {title} + {translate({ + id: `theme.RequestSchema.${title.toLowerCase()}`, + message: title, + })} {firstBody.type === "array" && ( array )} {body.required && ( - required + {translate({ + id: OPENAPI_SCHEMA_ITEM.REQUIRED, + message: "required", + })} )}

diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ResponseExamples/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ResponseExamples/index.tsx index c0df5864e..6013f2136 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/ResponseExamples/index.tsx +++ b/packages/docusaurus-theme-openapi-docs/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 = ({ return ( // @ts-ignore - + {responseExample.summary && ( {responseExample.summary} @@ -163,7 +171,13 @@ export const ExampleFromSchema: React.FC = ({ } return ( // @ts-ignore - + ); @@ -176,7 +190,13 @@ export const ExampleFromSchema: React.FC = ({ ) { return ( // @ts-ignore - + = ({ {title} {body.required === true && ( - required + {translate({ + id: OPENAPI_SCHEMA_ITEM.REQUIRED, + message: "required", + })} )} diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/Schema/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/Schema/index.tsx index 3fd4dd6f2..af5406fce 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/Schema/index.tsx +++ b/packages/docusaurus-theme-openapi-docs/src/theme/Schema/index.tsx @@ -7,6 +7,7 @@ import React from "react"; +import { translate } from "@docusaurus/Translate"; import { ClosingArrayBracket, OpeningArrayBracket } from "@theme/ArrayBrackets"; import Details from "@theme/Details"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; @@ -91,7 +92,9 @@ const Summary: React.FC = ({ )} {nullable && nullable} {isRequired && ( - required + + {translate({ id: "theme.schema.required", message: "required" })} + )} {deprecated && ( deprecated @@ -109,10 +112,14 @@ interface SchemaProps { const AnyOneOf: React.FC = ({ schema, schemaType }) => { const type = schema.oneOf ? "oneOf" : "anyOf"; + const translatedType = translate({ + id: `theme.schema.${type}`, + message: type, + }); return ( <> - {type} + {translatedType} {schema[type]?.map((anyOneSchema: any, index: number) => { @@ -254,7 +261,12 @@ const PropertyDiscriminator: React.FC = ({ )} {required && } {required && ( - required + + {translate({ + id: "theme.schema.required", + message: "required", + })} + )}
diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/SchemaItem/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/SchemaItem/index.tsx index a77d1f3ee..5486579a2 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/SchemaItem/index.tsx +++ b/packages/docusaurus-theme-openapi-docs/src/theme/SchemaItem/index.tsx @@ -7,8 +7,11 @@ import React, { ReactNode } from "react"; +import { translate } from "@docusaurus/Translate"; import Markdown from "@theme/Markdown"; import clsx from "clsx"; +import { translate } from "@docusaurus/Translate"; +import { OPENAPI_SCHEMA_ITEM } from "@theme/translationIds"; import { guard } from "../../markdown/utils"; @@ -36,7 +39,15 @@ const transformEnumDescriptions = ( const getEnumDescriptionMarkdown = (enumDescriptions?: [string, string][]) => { if (enumDescriptions?.length) { - return `| Enum Value | Description | + const enumHeader = translate({ + id: "theme.enum.value", + message: "Enum Value", + }); + const descHeader = translate({ + id: "theme.enum.description", + message: "Description", + }); + return `| ${enumHeader} | ${descHeader} | | ---- | ----- | ${enumDescriptions .map((desc) => { @@ -81,15 +92,23 @@ export default function SchemaItem(props: Props) { const renderRequired = guard( Array.isArray(required) ? required.includes(name) : required, - () => required + () => ( + + {translate({ id: OPENAPI_SCHEMA_ITEM.REQUIRED, message: "required" })} + + ) ); const renderDeprecated = guard(deprecated, () => ( - deprecated + + {translate({ id: OPENAPI_SCHEMA_ITEM.DEPRECATED, message: "deprecated" })} + )); const renderNullable = guard(nullable, () => ( - nullable + + {translate({ id: OPENAPI_SCHEMA_ITEM.NULLABLE, message: "nullable" })} + )); const renderEnumDescriptions = guard( @@ -120,7 +139,12 @@ export default function SchemaItem(props: Props) { if (typeof defaultValue === "string") { return (
- Default value: + + {translate({ + id: OPENAPI_SCHEMA_ITEM.DEFAULT_VALUE, + message: "Default value:", + })}{" "} + {defaultValue} @@ -129,7 +153,12 @@ export default function SchemaItem(props: Props) { } return (
- Default value: + + {translate({ + id: OPENAPI_SCHEMA_ITEM.DEFAULT_VALUE, + message: "Default value:", + })}{" "} + {JSON.stringify(defaultValue)} @@ -144,7 +173,12 @@ export default function SchemaItem(props: Props) { if (typeof example === "string") { return (
- Example: + + {translate({ + id: OPENAPI_SCHEMA_ITEM.EXAMPLE, + message: "Example:", + })}{" "} + {example} @@ -153,7 +187,12 @@ export default function SchemaItem(props: Props) { } return (
- Example: + + {translate({ + id: OPENAPI_SCHEMA_ITEM.EXAMPLE, + message: "Example:", + })}{" "} + {JSON.stringify(example)} @@ -168,7 +207,12 @@ export default function SchemaItem(props: Props) { if (typeof constValue === "string") { return (
- Constant value: + + {translate({ + id: OPENAPI_SCHEMA_ITEM.CONSTANT_VALUE, + message: "Constant value:", + })}{" "} + {constValue} @@ -177,7 +221,12 @@ export default function SchemaItem(props: Props) { } return (
- Constant value: + + {translate({ + id: OPENAPI_SCHEMA_ITEM.CONSTANT_VALUE, + message: "Constant value:", + })}{" "} + {JSON.stringify(constValue)} diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/StatusCodes/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/StatusCodes/index.tsx index e838e9897..da7ebf29f 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/StatusCodes/index.tsx +++ b/packages/docusaurus-theme-openapi-docs/src/theme/StatusCodes/index.tsx @@ -7,12 +7,15 @@ import React from "react"; +import { translate } from "@docusaurus/Translate"; + import ApiTabs from "@theme/ApiTabs"; import Details from "@theme/Details"; import Markdown from "@theme/Markdown"; import ResponseHeaders from "@theme/ResponseHeaders"; import ResponseSchema from "@theme/ResponseSchema"; import TabItem from "@theme/TabItem"; +import { OPENAPI_STATUS_CODES } from "@theme/translationIds"; import { ApiItem } from "docusaurus-plugin-openapi-docs/lib/types"; interface Props { @@ -51,7 +54,12 @@ const StatusCodes: React.FC = ({ label, id, responses }: any) => { style={{ textAlign: "left", marginBottom: "1rem" }} summary={ - Response Headers + + {translate({ + id: OPENAPI_STATUS_CODES.RESPONSE_HEADERS, + message: "Response Headers", + })} + } > @@ -59,7 +67,10 @@ const StatusCodes: React.FC = ({ label, id, responses }: any) => {
)} diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/translationIds.ts b/packages/docusaurus-theme-openapi-docs/src/theme/translationIds.ts new file mode 100644 index 000000000..36d61d691 --- /dev/null +++ b/packages/docusaurus-theme-openapi-docs/src/theme/translationIds.ts @@ -0,0 +1,93 @@ +/* ============================================================================ + * Copyright (c) Palo Alto Networks + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + * ========================================================================== */ + +export const OPENAPI_RESPONSE = { + TITLE: "theme.openapi.response.title", + CLEAR: "theme.openapi.response.clear", + PLACEHOLDER: "theme.openapi.response.placeholder", + HEADERS_TAB: "theme.openapi.response.headersTab", +}; + +export const OPENAPI_TABS = { + RESPONSES_LABEL: "theme.openapi.tabs.responses.label", +}; + +export const OPENAPI_REQUEST = { + BODY_TITLE: "theme.openapi.request.body.title", + ACCEPT_TITLE: "theme.openapi.request.accept.title", + SEND_BUTTON: "theme.openapi.request.sendButton", + REQUIRED_LABEL: "theme.openapi.request.requiredLabel", + REQUEST_TITLE: "theme.openapi.request.title", + COLLAPSE_ALL: "theme.openapi.request.collapseAll", + EXPAND_ALL: "theme.openapi.request.expandAll", + BASE_URL_TITLE: "theme.openapi.request.baseUrl.title", + AUTH_TITLE: "theme.openapi.request.auth.title", + PARAMETERS_TITLE: "theme.openapi.request.parameters.title", + FETCHING_MESSAGE: "theme.openapi.request.fetchingMessage", + CONNECTION_FAILED: "theme.openapi.request.connectionFailed", +}; + +export const OPENAPI_SERVER = { + EDIT_BUTTON: "theme.openapi.server.editButton", + HIDE_BUTTON: "theme.openapi.server.hideButton", +}; + +export const OPENAPI_PARAM_OPTIONS = { + SHOW_OPTIONAL: "theme.openapi.paramOptions.showOptional", + HIDE_OPTIONAL: "theme.openapi.paramOptions.hideOptional", +}; + +export const OPENAPI_FORM_FILE_UPLOAD = { + CLEAR_BUTTON: "theme.openapi.formFileUpload.clearButton", +}; + +export const OPENAPI_FORM = { + FIELD_REQUIRED: "theme.openapi.form.fieldRequired", +}; + +export const OPENAPI_AUTH = { + BEARER_TOKEN: "theme.openapi.auth.bearerToken", + USERNAME: "theme.openapi.auth.username", + PASSWORD: "theme.openapi.auth.password", +}; + +export const OPENAPI_RESPONSE_EXAMPLES = { + EXAMPLE: "theme.openapi.responseExamples.example", + AUTO_EXAMPLE: "theme.openapi.responseExamples.autoExample", +}; + +export const OPENAPI_BODY = { + EXAMPLE_FROM_SCHEMA: "theme.openapi.body.exampleFromSchema", +}; + +export const OPENAPI_STATUS_CODES = { + RESPONSE_HEADERS: "theme.openapi.statusCodes.responseHeaders", + SCHEMA_TITLE: "theme.openapi.statusCodes.schemaTitle", +}; + +export const OPENAPI_SCHEMA_ITEM = { + REQUIRED: "theme.openapi.schemaItem.required", + DEPRECATED: "theme.openapi.schemaItem.deprecated", + NULLABLE: "theme.openapi.schemaItem.nullable", + DEFAULT_VALUE: "theme.openapi.schemaItem.defaultValue", + EXAMPLE: "theme.openapi.schemaItem.example", + EXAMPLES: "theme.openapi.schemaItem.examples", + DESCRIPTION: "theme.openapi.schemaItem.description", + CONSTANT_VALUE: "theme.openapi.schemaItem.constantValue", +}; + +export const OPENAPI_PARAMS_DETAILS = { + PARAMETERS_TITLE: "theme.openapi.paramsDetails.parametersTitle", +}; + +export const OPENAPI_SECURITY_SCHEMES = { + NAME: "theme.openapi.securitySchemes.name", + TYPE: "theme.openapi.securitySchemes.type", + SCOPES: "theme.openapi.securitySchemes.scopes", + IN: "theme.openapi.securitySchemes.in", + FLOWS: "theme.openapi.securitySchemes.flows", +};