Skip to content

feat: translate additional labels #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

feat: translate additional labels #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
890e247
feat(theme): add initial i18n support
sserrata Jul 17, 2025
8b85f97
Add i18n wrappers across more theme components
sserrata Jul 17, 2025
bff2fc7
localize remaining theme components
sserrata Jul 17, 2025
f1ee9bd
feat: translate additional labels
sserrata Aug 25, 2025
a220a3e
Merge branch 'codex/review-issue-#1146-and-recommend-plan' into codex…
sserrata Aug 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 21 additions & 21 deletions packages/docusaurus-plugin-openapi-docs/src/markdown/__snapshots__/createSchema.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Array [
<div style={{ marginLeft: \\"1rem\\" }}>
<div>
<span className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }}>
oneOf
<Translate id=\\"theme.schema.oneOf\\">oneOf</Translate>
</span>
<SchemaTabs>
<TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
Expand Down Expand Up @@ -399,7 +399,7 @@ Array [
<div style={{ marginLeft: \\"1rem\\" }}>
<div>
<span className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }}>
anyOf
<Translate id=\\"theme.schema.anyOf\\">anyOf</Translate>
</span>
<SchemaTabs>
<TabItem label={\\"An int or a bool\\"} value={\\"0-item-properties\\"}>
Expand All @@ -408,7 +408,7 @@ Array [
className={\\"badge badge--info\\"}
style={{ marginBottom: \\"1rem\\" }}
>
oneOf
<Translate id=\\"theme.schema.oneOf\\">oneOf</Translate>
</span>
<SchemaTabs>
<TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
Expand Down Expand Up @@ -451,7 +451,7 @@ Array [
<div style={{ marginLeft: \\"1rem\\" }}>
<div>
<span className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }}>
anyOf
<Translate id=\\"theme.schema.anyOf\\">anyOf</Translate>
</span>
<SchemaTabs>
<TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
Expand All @@ -477,7 +477,7 @@ exports[`createNodes discriminator should handle basic discriminator with mappin
Array [
"<div>
<span className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }}>
oneOf
<Translate id=\\"theme.schema.oneOf\\">oneOf</Translate>
</span>
<SchemaTabs>
<TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
Expand Down Expand Up @@ -554,7 +554,7 @@ exports[`createNodes discriminator should handle basic discriminator with oneOf
Array [
"<div>
<span className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }}>
oneOf
<Translate id=\\"theme.schema.oneOf\\">oneOf</Translate>
</span>
<SchemaTabs>
<TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
Expand Down Expand Up @@ -612,7 +612,7 @@ exports[`createNodes discriminator should handle discriminator with additional p
Array [
"<div>
<span className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }}>
oneOf
<Translate id=\\"theme.schema.oneOf\\">oneOf</Translate>
</span>
<SchemaTabs>
<TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
Expand Down Expand Up @@ -679,7 +679,7 @@ Array [
",
"<div>
<span className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }}>
oneOf
<Translate id=\\"theme.schema.oneOf\\">oneOf</Translate>
</span>
<SchemaTabs>
<TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
Expand Down Expand Up @@ -774,7 +774,7 @@ Array [
",
"<div>
<span className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }}>
oneOf
<Translate id=\\"theme.schema.oneOf\\">oneOf</Translate>
</span>
<SchemaTabs>
<TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
Expand Down Expand Up @@ -860,7 +860,7 @@ exports[`createNodes discriminator should handle discriminator with nested schem
Array [
"<div>
<span className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }}>
oneOf
<Translate id=\\"theme.schema.oneOf\\">oneOf</Translate>
</span>
<SchemaTabs>
<TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
Expand Down Expand Up @@ -958,7 +958,7 @@ exports[`createNodes discriminator should handle discriminator with required pro
Array [
"<div>
<span className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }}>
oneOf
<Translate id=\\"theme.schema.oneOf\\">oneOf</Translate>
</span>
<SchemaTabs>
<TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
Expand Down Expand Up @@ -1016,7 +1016,7 @@ exports[`createNodes discriminator should handle discriminator with required pro
Array [
"<div>
<span className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }}>
oneOf
<Translate id=\\"theme.schema.oneOf\\">oneOf</Translate>
</span>
<SchemaTabs>
<TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
Expand Down Expand Up @@ -1093,7 +1093,7 @@ exports[`createNodes discriminator should handle discriminator with shared prope
Array [
"<div>
<span className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }}>
oneOf
<Translate id=\\"theme.schema.oneOf\\">oneOf</Translate>
</span>
<SchemaTabs>
<TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
Expand Down Expand Up @@ -1160,7 +1160,7 @@ exports[`createNodes discriminator should handle discriminator with shared prope
Array [
"<div>
<span className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }}>
oneOf
<Translate id=\\"theme.schema.oneOf\\">oneOf</Translate>
</span>
<SchemaTabs>
<TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
Expand Down Expand Up @@ -1255,7 +1255,7 @@ Array [
<div style={{ marginLeft: \\"1rem\\" }}>
<div>
<span className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }}>
oneOf
<Translate id=\\"theme.schema.oneOf\\">oneOf</Translate>
</span>
<SchemaTabs>
<TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
Expand Down Expand Up @@ -1345,7 +1345,7 @@ Array [
<div style={{ marginLeft: \\"1rem\\" }}>
<div>
<span className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }}>
oneOf
<Translate id=\\"theme.schema.oneOf\\">oneOf</Translate>
</span>
<SchemaTabs>
<TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
Expand All @@ -1365,7 +1365,7 @@ Array [
className={\\"badge badge--info\\"}
style={{ marginBottom: \\"1rem\\" }}
>
oneOf
<Translate id=\\"theme.schema.oneOf\\">oneOf</Translate>
</span>
<SchemaTabs>
<TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
Expand Down Expand Up @@ -1415,7 +1415,7 @@ Array [
<div style={{ marginLeft: \\"1rem\\" }}>
<div>
<span className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }}>
oneOf
<Translate id=\\"theme.schema.oneOf\\">oneOf</Translate>
</span>
<SchemaTabs>
<TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
Expand Down Expand Up @@ -1478,7 +1478,7 @@ Array [
<div style={{ marginLeft: \\"1rem\\" }}>
<div>
<span className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }}>
oneOf
<Translate id=\\"theme.schema.oneOf\\">oneOf</Translate>
</span>
<SchemaTabs>
<TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
Expand Down Expand Up @@ -1518,7 +1518,7 @@ Array [
<div style={{ marginLeft: \\"1rem\\" }}>
<div>
<span className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }}>
oneOf
<Translate id=\\"theme.schema.oneOf\\">oneOf</Translate>
</span>
<SchemaTabs>
<TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
Expand Down Expand Up @@ -1572,7 +1572,7 @@ Array [
<div style={{ marginLeft: \\"1rem\\" }}>
<div>
<span className={\\"badge badge--info\\"} style={{ marginBottom: \\"1rem\\" }}>
oneOf
<Translate id=\\"theme.schema.oneOf\\">oneOf</Translate>
</span>
<SchemaTabs>
<TabItem label={\\"MOD1\\"} value={\\"0-item-properties\\"}>
Expand Down
21 changes: 11 additions & 10 deletions packages/docusaurus-plugin-openapi-docs/src/markdown/createRequestHeader.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: [
`<Translate id="theme.RequestHeader.${id}">`,
header,
"</Translate>",
],
}),
`\n\n`,
];
}
9 changes: 6 additions & 3 deletions packages/docusaurus-plugin-openapi-docs/src/markdown/createSchema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,12 @@ export function mergeAllOf(allOf: SchemaObject) {
*/
function createAnyOneOf(schema: SchemaObject): any {
const type = schema.oneOf ? "oneOf" : "anyOf";
const translatedType = `<Translate id="theme.schema.${type}">${type}</Translate>`;
return create("div", {
children: [
create("span", {
className: "badge badge--info",
children: type,
children: translatedType,
style: { marginBottom: "1rem" },
}),
create("SchemaTabs", {
Expand Down Expand Up @@ -375,7 +376,8 @@ function createDetailsNode(
() => [
create("span", {
className: "openapi-schema__required",
children: "required",
children:
'<Translate id="theme.schema.required">required</Translate>',
}),
]
),
Expand Down Expand Up @@ -530,7 +532,8 @@ function createPropertyDiscriminator(
guard(required, () => [
create("span", {
className: "openapi-schema__required",
children: "required",
children:
'<Translate id="theme.schema.required">required</Translate>',
}),
]),
],
Expand Down
1 change: 1 addition & 0 deletions packages/docusaurus-plugin-openapi-docs/src/markdown/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`,
Expand Down
8 changes: 7 additions & 1 deletion packages/docusaurus-theme-openapi-docs/src/markdown/schema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down Expand Up @@ -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 = [];

Expand Down
59 changes: 50 additions & 9 deletions packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Authorization/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";

Expand All @@ -32,7 +34,12 @@ function Authorization() {
return (
<div>
{optionKeys.length > 1 && (
<FormItem label="Security Scheme">
<FormItem
label={translate({
id: "theme.authorization.securityScheme",
message: "Security Scheme",
})}
>
<FormSelect
options={optionKeys}
value={selected}
Expand All @@ -45,9 +52,18 @@ function Authorization() {
{selectedAuth.map((a: any) => {
if (a.type === "http" && a.scheme === "bearer") {
return (
<FormItem label="Bearer Token" key={a.key + "-bearer"}>
<FormItem
label={translate({
id: OPENAPI_AUTH.BEARER_TOKEN,
message: "Bearer Token",
})}
key={a.key + "-bearer"}
>
<FormTextInput
placeholder="Bearer Token"
placeholder={translate({
id: OPENAPI_AUTH.BEARER_TOKEN,
message: "Bearer Token",
})}
password
value={data[a.key].token ?? ""}
onChange={(e: React.ChangeEvent<HTMLInputElement>) => {
Expand All @@ -67,9 +83,18 @@ function Authorization() {

if (a.type === "oauth2") {
return (
<FormItem label="Bearer Token" key={a.key + "-oauth2"}>
<FormItem
label={translate({
id: OPENAPI_AUTH.BEARER_TOKEN,
message: "Bearer Token",
})}
key={a.key + "-oauth2"}
>
<FormTextInput
placeholder="Bearer Token"
placeholder={translate({
id: OPENAPI_AUTH.BEARER_TOKEN,
message: "Bearer Token",
})}
password
value={data[a.key].token ?? ""}
onChange={(e: React.ChangeEvent<HTMLInputElement>) => {
Expand All @@ -90,9 +115,17 @@ function Authorization() {
if (a.type === "http" && a.scheme === "basic") {
return (
<React.Fragment key={a.key + "-basic"}>
<FormItem label="Username">
<FormItem
label={translate({
id: OPENAPI_AUTH.USERNAME,
message: "Username",
})}
>
<FormTextInput
placeholder="Username"
placeholder={translate({
id: OPENAPI_AUTH.USERNAME,
message: "Username",
})}
value={data[a.key].username ?? ""}
onChange={(e: React.ChangeEvent<HTMLInputElement>) => {
const value = e.target.value;
Expand All @@ -106,9 +139,17 @@ function Authorization() {
}}
/>
</FormItem>
<FormItem label="Password">
<FormItem
label={translate({
id: OPENAPI_AUTH.PASSWORD,
message: "Password",
})}
>
<FormTextInput
placeholder="Password"
placeholder={translate({
id: OPENAPI_AUTH.PASSWORD,
message: "Password",
})}
password
value={data[a.key].password ?? ""}
onChange={(e: React.ChangeEvent<HTMLInputElement>) => {
Expand Down
Loading