Skip to content

Commit 44874e7

Browse files
leoncheng57github-actions[bot]
authored andcommitted
Update openapi.json to match openapi.yaml
1 parent 3be7da6 commit 44874e7

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

openapi.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"name": "DeepL - Contact us",
99
"url": "https://www.deepl.com/contact-us"
1010
},
11-
"version": "3.4.0"
11+
"version": "3.4.1"
1212
},
1313
"externalDocs": {
1414
"description": "DeepL Pro - Plans and pricing",
@@ -3037,7 +3037,7 @@
30373037
}
30383038
},
30393039
"OutlineDetectionOption": {
3040-
"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.",
3040+
"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\".",
30413041
"type": "boolean",
30423042
"default": true
30433043
},
@@ -3064,7 +3064,7 @@
30643064
}
30653065
},
30663066
"PreserveFormattingOption": {
3067-
"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",
3067+
"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\".",
30683068
"type": "boolean",
30693069
"default": false
30703070
},
@@ -3081,7 +3081,7 @@
30813081
"$ref": "#/components/schemas/MultilingualGlossaryEntries"
30823082
},
30833083
"ShowBilledCharacters": {
3084-
"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.",
3084+
"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\".",
30853085
"type": "boolean"
30863086
},
30873087
"SplitSentencesOption": {

0 commit comments

Comments
 (0)