Skip to content

Commit be10d16

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

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

openapi.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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)