Skip to content

docs(document): add enable_watermark parameter to POST /v2/document #398

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

Closed
yoshiamakino wants to merge 1 commit into from
+26 −0
Closed

docs(document): add enable_watermark parameter to POST /v2/document #398

Show file tree
Hide file tree
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
13 changes: 13 additions & 0 deletions api-reference/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1077,6 +1077,14 @@
"file": "@document.docx"
}
},
"Watermark": {
"summary": "Adding a \"Translated by DeepL\" watermark",
"value": {
"target_lang": "DE",
"file": "@document.docx",
"enable_watermark": true
}
},
"Glossary": {
"summary": "Using a Glossary",
"value": {
Expand Down Expand Up @@ -1169,6 +1177,11 @@
"translation_memory_threshold": {
"$ref": "#/components/schemas/TranslationMemoryThreshold"
},
"enable_watermark": {
"description": "When `true`, adds a \"Translated by DeepL\" watermark to the translated document.\n\nOnly supported for `docx` and `pdf` output. For all other output formats the parameter is ignored and the document is returned without a watermark.",
"type": "boolean",
"default": false
},
"enable_beta_languages": {
"description": "This parameter is maintained for backward compatibility and has no effect.",
"type": "boolean",
Expand Down
13 changes: 13 additions & 0 deletions api-reference/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -827,6 +827,12 @@ paths:
value:
target_lang: DE
file: '@document.docx'
Watermark:
summary: Adding a "Translated by DeepL" watermark
value:
target_lang: DE
file: '@document.docx'
enable_watermark: true
Glossary:
summary: Using a Glossary
value:
Expand Down Expand Up @@ -925,6 +931,13 @@ paths:
$ref: '#/components/schemas/TranslationMemoryId'
translation_memory_threshold:
$ref: '#/components/schemas/TranslationMemoryThreshold'
enable_watermark:
description: |-
When `true`, adds a "Translated by DeepL" watermark to the translated document.

Only supported for `docx` and `pdf` output. For all other output formats the parameter is ignored and the document is returned without a watermark.
type: boolean
default: false
enable_beta_languages:
description: |-
This parameter is maintained for backward compatibility and has no effect.
Expand Down
Loading