diff --git a/CHANGELOG.md b/CHANGELOG.md
index bd64069..37635f7 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -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-31
+### Added
+* Add note for boolean values about how to input for URL-encoded forms
+
## [3.4.0] - 2025-07-16
### Added
@@ -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
diff --git a/openapi.json b/openapi.json
index 048f8a8..80665fc 100644
--- a/openapi.json
+++ b/openapi.json
@@ -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",
@@ -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 \n \n A document's title\n \n \n This is the first sentence. Followed by a second one.\n This is the third sentence.\n \n \n ```\n * Example response:\n ```\n \n \n Der Titel eines Dokuments\n \n \n Das ist der erste Satz. Gefolgt von einem zweiten.\n Dies ist der dritte Satz.\n \n \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 \n \n A document's title\n \n \n This is the first sentence. Followed by a second one.\n This is the third sentence.\n \n \n ```\n * Example response:\n ```\n \n \n Der Titel eines Dokuments\n \n \n Das ist der erste Satz. Gefolgt von einem zweiten.\n Dies ist der dritte Satz.\n \n \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
},
@@ -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
},
@@ -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": {
diff --git a/openapi.yaml b/openapi.yaml
index 5693235..87082d6 100644
--- a/openapi.yaml
+++ b/openapi.yaml
@@ -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
@@ -2292,6 +2292,8 @@ components:
```
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:
@@ -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:
@@ -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: |-
diff --git a/openapi_gitbook.yaml b/openapi_gitbook.yaml
index 24e3ad5..82610bd 100644
--- a/openapi_gitbook.yaml
+++ b/openapi_gitbook.yaml
@@ -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
@@ -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:
@@ -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:
@@ -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: |-