Skip to content

feat: Updated OpenAPI spec #46

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
github-actions merged 1 commit into from
Jun 16, 2026
Merged

feat: Updated OpenAPI spec #46

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions src/libs/DeepL/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 @@ -1827,6 +1830,8 @@ paths:
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 All @@ -1845,6 +1850,8 @@ paths:
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 @@ -1922,6 +1929,8 @@ paths:
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 @@ -1936,6 +1945,8 @@ paths:
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 @@ -2329,6 +2340,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 @@ -2611,8 +2623,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 @@ -2859,10 +2873,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