Skip to content

Add default values to API playground for translate, rephrase, and correct endpoints #373

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

Merged
shirgoldbird merged 3 commits into from
Jun 16, 2026
Merged

Add default values to API playground for translate, rephrase, and correct endpoints #373

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
06d3d7c
Add x-default values to pre-populate API playground fields
shirgoldbird Jun 16, 2026
e52970f
chore: update OpenAPI JSON files from YAML sources
shirgoldbird Jun 16, 2026
39ae5fb
add download spec functionality to dropdown
shirgoldbird Jun 16, 2026
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
31 changes: 26 additions & 5 deletions api-reference/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -749,6 +749,9 @@
"text": {
"description": "Text to be translated. Only UTF-8-encoded plain text is supported. The parameter may be specified\nmany times in a single request, within the request size limit (128KiB). Translations are returned\nin the same order as they are requested. Each text in the array is translated independently — texts\ndo not share context with each other.",
"type": "array",
"x-default": [
"Hello, World!"
],
"items": {
"type": "string",
"example": "Hello, World!"
Expand All @@ -758,7 +761,8 @@
"$ref": "#/components/schemas/SourceLanguage"
},
"target_lang": {
"$ref": "#/components/schemas/TargetLanguage"
"$ref": "#/components/schemas/TargetLanguage",
"x-default": "DE"
},
"context": {
"$ref": "#/components/schemas/Context"
Expand Down Expand Up @@ -2651,6 +2655,9 @@
"text": {
"description": "Text to be improved. Only UTF-8-encoded plain text is supported. Improvements are returned in the same order as they are requested.",
"type": "array",
"x-default": [
"this is a example sentence to imprve"
],
"items": {
"type": "string",
"example": "this is a example sentence to imprve"
Expand Down Expand Up @@ -2678,6 +2685,9 @@
"text": {
"description": "Text to be improved. Only UTF-8-encoded plain text is supported. Improvements are returned in the same order as they are requested.",
"type": "array",
"x-default": [
"this is a example sentence to imprve"
],
"items": {
"type": "string",
"example": "this is a example sentence to imprve"
Expand Down Expand Up @@ -2792,6 +2802,9 @@
"text": {
"description": "Text to be corrected. Only UTF-8-encoded plain text is supported. Corrections are returned in the same order as they are requested.",
"type": "array",
"x-default": [
"this is a example sentence to imprve"
],
"items": {
"type": "string",
"example": "this is a example sentence to imprve"
Expand All @@ -2813,6 +2826,9 @@
"text": {
"description": "Text to be corrected. Only UTF-8-encoded plain text is supported. Corrections are returned in the same order as they are requested.",
"type": "array",
"x-default": [
"this is a example sentence to imprve"
],
"items": {
"type": "string",
"example": "this is a example sentence to imprve"
Expand Down Expand Up @@ -3421,6 +3437,7 @@
]
},
"example": "translate_text",
"x-default": "translate_text",
"description": "The resource to retrieve languages for. Supported values: `translate_text`, `translate_document`,\n`glossary`, `voice`, `write`, `style_rules`."
},
{
Expand Down Expand Up @@ -3820,10 +3837,12 @@
],
"properties": {
"name": {
"$ref": "#/components/schemas/StyleRuleName"
"$ref": "#/components/schemas/StyleRuleName",
"x-default": "My style rules"
},
"language": {
"$ref": "#/components/schemas/StyleRuleLanguage"
"$ref": "#/components/schemas/StyleRuleLanguage",
"x-default": "de"
},
"configured_rules": {
"$ref": "#/components/schemas/ConfiguredRules"
Expand Down Expand Up @@ -4213,12 +4232,14 @@
"label": {
"type": "string",
"description": "Label for the custom instruction",
"maxLength": 100
"maxLength": 100,
"x-default": "Currency custom instruction"
},
"prompt": {
"type": "string",
"description": "Instruction text",
"maxLength": 300
"maxLength": 300,
"x-default": "Have currency symbols before the numerical value (e.g. $100, €100)"
},
"source_language": {
"type": "string",
Expand Down
16 changes: 16 additions & 0 deletions api-reference/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -551,13 +551,16 @@ paths:
in the same order as they are requested. Each text in the array is translated independently — texts
do not share context with each other.
type: array
x-default:
- Hello, World!
items:
type: string
example: Hello, World!
source_lang:
$ref: '#/components/schemas/SourceLanguage'
target_lang:
$ref: '#/components/schemas/TargetLanguage'
x-default: DE
context:
$ref: '#/components/schemas/Context'
show_billed_characters:
Expand Down Expand Up @@ -1871,6 +1874,8 @@ paths:
description: Text to be improved. Only UTF-8-encoded plain text is supported. Improvements are
returned in the same order as they are requested.
type: array
x-default:
- this is a example sentence to imprve
items:
type: string
example: this is a example sentence to imprve
Expand All @@ -1890,6 +1895,8 @@ paths:
description: Text to be improved. Only UTF-8-encoded plain text is supported. Improvements are
returned in the same order as they are requested.
type: array
x-default:
- this is a example sentence to imprve
items:
type: string
example: this is a example sentence to imprve
Expand Down Expand Up @@ -1968,6 +1975,8 @@ paths:
description: Text to be corrected. Only UTF-8-encoded plain text is supported. Corrections are
returned in the same order as they are requested.
type: array
x-default:
- this is a example sentence to imprve
items:
type: string
example: this is a example sentence to imprve
Expand All @@ -1983,6 +1992,8 @@ paths:
description: Text to be corrected. Only UTF-8-encoded plain text is supported. Corrections are
returned in the same order as they are requested.
type: array
x-default:
- this is a example sentence to imprve
items:
type: string
example: this is a example sentence to imprve
Expand Down Expand Up @@ -2377,6 +2388,7 @@ paths:
- write
- style_rules
example: translate_text
x-default: translate_text
description: |-
The resource to retrieve languages for. Supported values: `translate_text`, `translate_document`,
`glossary`, `voice`, `write`, `style_rules`.
Expand Down Expand Up @@ -2659,8 +2671,10 @@ paths:
properties:
name:
$ref: '#/components/schemas/StyleRuleName'
x-default: My style rules
language:
$ref: '#/components/schemas/StyleRuleLanguage'
x-default: de
configured_rules:
$ref: '#/components/schemas/ConfiguredRules'
custom_instructions:
Expand Down Expand Up @@ -2907,10 +2921,12 @@ paths:
type: string
description: Label for the custom instruction
maxLength: 100
x-default: Currency custom instruction
prompt:
type: string
description: Instruction text
maxLength: 300
x-default: "Have currency symbols before the numerical value (e.g. $100, €100)"
source_language:
type: string
description: Optional source language code
Expand Down
1 change: 1 addition & 0 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -545,6 +545,7 @@
"contextual": {
"options": [
"copy",
"download-spec",
"chatgpt",
"claude",
"cursor",
Expand Down
Loading