Skip to content

Commit 1b8cc33

Browse files
committed
papi: add more details about 0 and 1 to url encoded params for translate
1 parent 65576f8 commit 1b8cc33

File tree

3 files changed

+19
-2
lines changed

3 files changed

+19
-2
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ The major and minor version numbers reflect changes to the DeepL API
99
number is used only for corrections to the OpenAPI specification, for example:
1010
typos, schema fixes, or adding examples.
1111

12+
## [3.4.1] - 2025-07-18
13+
### Added
14+
* Add note for boolean values about how to input for URL-encoded forms
15+
1216

1317
## [3.4.0] - 2025-07-16
1418
### Added
@@ -232,6 +236,7 @@ keys within an organization.
232236
Initial release of the OpenAPI specification.
233237

234238

239+
[3.4.1]: https://github.com/DeepLcom/openapi/compare/v3.4.0...v3.4.1
235240
[3.4.0]: https://github.com/DeepLcom/openapi/compare/v3.3.1...v3.4.0
236241
[3.3.1]: https://github.com/DeepLcom/openapi/compare/v3.3.0...v3.3.1
237242
[3.3.0]: https://github.com/DeepLcom/openapi/compare/v3.2.0...v3.3.0

openapi.yaml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ info:
77
contact:
88
name: DeepL - Contact us
99
url: https://www.deepl.com/contact-us
10-
version: 3.4.0
10+
version: 3.4.1
1111
externalDocs:
1212
description: DeepL Pro - Plans and pricing
1313
url: https://www.deepl.com/pro#developer
@@ -2292,6 +2292,8 @@ components:
22922292
</document>
22932293
```
22942294
While this approach is slightly more complicated, it allows for greater control over the structure of the translation output.
2295+
2296+
Note: for requests sent as URL-encoded forms, boolean values should be specified as "1" or "0".
22952297
type: boolean
22962298
default: true
22972299
OutlineDetectionOptionStr:
@@ -2345,6 +2347,8 @@ components:
23452347
The formatting aspects affected by this setting include:
23462348
* Punctuation at the beginning and end of the sentence
23472349
* Upper/lower case at the beginning of the sentence
2350+
2351+
Note: for requests sent as URL-encoded forms, boolean values should be specified as "1" or "0".
23482352
type: boolean
23492353
default: false
23502354
PreserveFormattingOptionStr:
@@ -2367,6 +2371,8 @@ components:
23672371
description: |-
23682372
When true, the response will include the billed_characters parameter, giving the
23692373
number of characters from the request that will be counted by DeepL for billing purposes.
2374+
2375+
Note: for requests sent as URL-encoded forms, boolean values should be specified as "1" or "0".
23702376
type: boolean
23712377
SplitSentencesOption:
23722378
description: |-

openapi_gitbook.yaml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ info:
99
contact:
1010
name: DeepL - Contact us
1111
url: https://www.deepl.com/contact-us
12-
version: 3.4.0
12+
version: 3.4.1
1313
externalDocs:
1414
description: DeepL Pro - Plans and pricing
1515
url: https://www.deepl.com/pro#developer
@@ -2123,6 +2123,8 @@ components:
21232123
Disable the automatic detection of XML structure by setting the `outline_detection` parameter
21242124
to `false` and selecting the tags that should be considered structure tags. This will split sentences
21252125
using the `splitting_tags` parameter.
2126+
2127+
Note: for requests sent as URL-encoded forms, boolean values should be specified as "1" or "0".
21262128
type: boolean
21272129
default: true
21282130
OutlineDetectionOptionStr:
@@ -2148,6 +2150,8 @@ components:
21482150
description: |-
21492151
Sets whether the translation engine should respect the original formatting, even if it would usually
21502152
correct some aspects.
2153+
2154+
Note: for requests sent as URL-encoded forms, boolean values should be specified as "1" or "0".
21512155
type: boolean
21522156
default: false
21532157
PreserveFormattingOptionStr:
@@ -2165,6 +2169,8 @@ components:
21652169
description: |-
21662170
When true, the response will include the billed_characters parameter, giving the
21672171
number of characters from the request that will be counted by DeepL for billing purposes.
2172+
2173+
Note: for requests sent as URL-encoded forms, boolean values should be specified as "1" or "0".
21682174
type: boolean
21692175
SplitSentencesOption:
21702176
description: |-

0 commit comments

Comments
 (0)