Skip to content

papi: add more details about 0 and 1 to url encoded params for translate #36

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
leoncheng57 wants to merge 3 commits into from
Closed

papi: add more details about 0 and 1 to url encoded params for translate #36

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1b8cc33
papi: add more details about 0 and 1 to url encoded params for translate
leoncheng57 Jul 16, 2025
dfec4bd
Update openapi.json to match openapi.yaml
leoncheng57 Jul 17, 2025
def48a6
Update CHANGELOG.md date
leoncheng57 Jul 31, 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
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ The major and minor version numbers reflect changes to the DeepL API
number is used only for corrections to the OpenAPI specification, for example:
typos, schema fixes, or adding examples.

## [3.4.1] - 2025-07-18
### Added
* Add note for boolean values about how to input for URL-encoded forms


## [3.4.0] - 2025-07-16
### Added
Expand Down Expand Up @@ -232,6 +236,7 @@ keys within an organization.
Initial release of the OpenAPI specification.


[3.4.1]: https://github.com/DeepLcom/openapi/compare/v3.4.0...v3.4.1
[3.4.0]: https://github.com/DeepLcom/openapi/compare/v3.3.1...v3.4.0
[3.3.1]: https://github.com/DeepLcom/openapi/compare/v3.3.0...v3.3.1
[3.3.0]: https://github.com/DeepLcom/openapi/compare/v3.2.0...v3.3.0
Expand Down
8 changes: 4 additions & 4 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"name": "DeepL - Contact us",
"url": "https://www.deepl.com/contact-us"
},
"version": "3.4.0"
"version": "3.4.1"
},
"externalDocs": {
"description": "DeepL Pro - Plans and pricing",
Expand Down Expand Up @@ -3037,7 +3037,7 @@
}
},
"OutlineDetectionOption": {
"description": "The automatic detection of the XML structure won't yield best results in all XML files. You can disable this automatic mechanism altogether by setting the `outline_detection` parameter to `false` and selecting the tags that should be considered structure tags. This will split sentences using the `splitting_tags` parameter.\n\n\nIn the example below, we achieve the same results as the automatic engine by disabling automatic detection with `outline_detection=0` and setting the parameters manually to `tag_handling=xml`, `split_sentences=nonewlines`, and `splitting_tags=par,title`.\n * Example request:\n ```\n <document>\n <meta>\n <title>A document's title</title>\n </meta>\n <content>\n <par>This is the first sentence. Followed by a second one.</par>\n <par>This is the third sentence.</par>\n </content>\n </document>\n ```\n * Example response:\n ```\n <document>\n <meta>\n <title>Der Titel eines Dokuments</title>\n </meta>\n <content>\n <par>Das ist der erste Satz. Gefolgt von einem zweiten.</par>\n <par>Dies ist der dritte Satz.</par>\n </content>\n </document>\n ```\nWhile this approach is slightly more complicated, it allows for greater control over the structure of the translation output.",
"description": "The automatic detection of the XML structure won't yield best results in all XML files. You can disable this automatic mechanism altogether by setting the `outline_detection` parameter to `false` and selecting the tags that should be considered structure tags. This will split sentences using the `splitting_tags` parameter.\n\n\nIn the example below, we achieve the same results as the automatic engine by disabling automatic detection with `outline_detection=0` and setting the parameters manually to `tag_handling=xml`, `split_sentences=nonewlines`, and `splitting_tags=par,title`.\n * Example request:\n ```\n <document>\n <meta>\n <title>A document's title</title>\n </meta>\n <content>\n <par>This is the first sentence. Followed by a second one.</par>\n <par>This is the third sentence.</par>\n </content>\n </document>\n ```\n * Example response:\n ```\n <document>\n <meta>\n <title>Der Titel eines Dokuments</title>\n </meta>\n <content>\n <par>Das ist der erste Satz. Gefolgt von einem zweiten.</par>\n <par>Dies ist der dritte Satz.</par>\n </content>\n </document>\n ```\nWhile this approach is slightly more complicated, it allows for greater control over the structure of the translation output.\n\nNote: for requests sent as URL-encoded forms, boolean values should be specified as \"1\" or \"0\".",
"type": "boolean",
"default": true
},
Expand All @@ -3064,7 +3064,7 @@
}
},
"PreserveFormattingOption": {
"description": "Sets whether the translation engine should respect the original formatting, even if it would usually correct some aspects.\n\nThe formatting aspects affected by this setting include:\n * Punctuation at the beginning and end of the sentence\n * Upper/lower case at the beginning of the sentence",
"description": "Sets whether the translation engine should respect the original formatting, even if it would usually correct some aspects.\n\nThe formatting aspects affected by this setting include:\n * Punctuation at the beginning and end of the sentence\n * Upper/lower case at the beginning of the sentence\n\nNote: for requests sent as URL-encoded forms, boolean values should be specified as \"1\" or \"0\".",
"type": "boolean",
"default": false
},
Expand All @@ -3081,7 +3081,7 @@
"$ref": "#/components/schemas/MultilingualGlossaryEntries"
},
"ShowBilledCharacters": {
"description": "When true, the response will include the billed_characters parameter, giving the \nnumber of characters from the request that will be counted by DeepL for billing purposes.",
"description": "When true, the response will include the billed_characters parameter, giving the \nnumber of characters from the request that will be counted by DeepL for billing purposes.\n\nNote: for requests sent as URL-encoded forms, boolean values should be specified as \"1\" or \"0\".",
"type": "boolean"
},
"SplitSentencesOption": {
Expand Down
8 changes: 7 additions & 1 deletion openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ info:
contact:
name: DeepL - Contact us
url: https://www.deepl.com/contact-us
version: 3.4.0
version: 3.4.1
externalDocs:
description: DeepL Pro - Plans and pricing
url: https://www.deepl.com/pro#developer
Expand Down Expand Up @@ -2292,6 +2292,8 @@ components:
</document>
```
While this approach is slightly more complicated, it allows for greater control over the structure of the translation output.

Note: for requests sent as URL-encoded forms, boolean values should be specified as "1" or "0".
type: boolean
default: true
OutlineDetectionOptionStr:
Expand Down Expand Up @@ -2345,6 +2347,8 @@ components:
The formatting aspects affected by this setting include:
* Punctuation at the beginning and end of the sentence
* Upper/lower case at the beginning of the sentence

Note: for requests sent as URL-encoded forms, boolean values should be specified as "1" or "0".
type: boolean
default: false
PreserveFormattingOptionStr:
Expand All @@ -2367,6 +2371,8 @@ components:
description: |-
When true, the response will include the billed_characters parameter, giving the
number of characters from the request that will be counted by DeepL for billing purposes.

Note: for requests sent as URL-encoded forms, boolean values should be specified as "1" or "0".
type: boolean
SplitSentencesOption:
description: |-
Expand Down
8 changes: 7 additions & 1 deletion openapi_gitbook.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ info:
contact:
name: DeepL - Contact us
url: https://www.deepl.com/contact-us
version: 3.4.0
version: 3.4.1
externalDocs:
description: DeepL Pro - Plans and pricing
url: https://www.deepl.com/pro#developer
Expand Down Expand Up @@ -2123,6 +2123,8 @@ components:
Disable the automatic detection of XML structure by setting the `outline_detection` parameter
to `false` and selecting the tags that should be considered structure tags. This will split sentences
using the `splitting_tags` parameter.
Note: for requests sent as URL-encoded forms, boolean values should be specified as "1" or "0".
type: boolean
default: true
OutlineDetectionOptionStr:
Expand All @@ -2148,6 +2150,8 @@ components:
description: |-
Sets whether the translation engine should respect the original formatting, even if it would usually
correct some aspects.
Note: for requests sent as URL-encoded forms, boolean values should be specified as "1" or "0".
type: boolean
default: false
PreserveFormattingOptionStr:
Expand All @@ -2165,6 +2169,8 @@ components:
description: |-
When true, the response will include the billed_characters parameter, giving the
number of characters from the request that will be counted by DeepL for billing purposes.
Note: for requests sent as URL-encoded forms, boolean values should be specified as "1" or "0".
type: boolean
SplitSentencesOption:
description: |-
Expand Down