Skip to content

Commit 1c275b7

Browse files
chore: update OpenAPI JSON files from YAML sources
1 parent cdbe25d commit 1c275b7

1 file changed

Lines changed: 18 additions & 19 deletions

File tree

api-reference/openapi.json

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -585,7 +585,7 @@
585585
"example": "def3a26b-3e84-45b3-84ae-0c0aaf3525f7"
586586
},
587587
"style_id": {
588-
"description": "Specify the [style rule list](/api-reference/style-rules) to use for the translation. \n\n**Important:** The target language has to match the language of the style rule list. \n\n**Note:** Any request with the `style_id` parameter enabled will use `quality_optimized` models. Requests combining `style_id` and `model_type: latency_optimized` will be rejected.",
588+
"description": "Specify the [style rule list](/api-reference/style-rules) to use for the translation.\n\n**Important:** The target language has to match the language of the style rule list.\n\n**Note:** Any request with the `style_id` parameter enabled will use `quality_optimized` models. Requests combining `style_id` and `model_type: latency_optimized` will be rejected.",
589589
"type": "string",
590590
"example": "7ff9bfd6-cd85-4190-8503-d6215a321519"
591591
},
@@ -1220,11 +1220,12 @@
12201220
},
12211221
"/v2/glossary-language-pairs": {
12221222
"get": {
1223+
"deprecated": true,
12231224
"tags": [
12241225
"ManageGlossaries"
12251226
],
12261227
"summary": "List Language Pairs Supported by Glossaries",
1227-
"description": "Retrieve the list of language pairs supported by the glossary feature.",
1228+
"description": "**Deprecated.** Use `GET /v3/languages?resource=glossary` instead, which returns per-language\navailability including source and target roles.\n\nRetrieve the list of language pairs supported by the glossary feature.",
12281229
"operationId": "listGlossaryLanguages",
12291230
"responses": {
12301231
"200": {
@@ -2623,11 +2624,13 @@
26232624
},
26242625
"/v2/languages": {
26252626
"get": {
2627+
"deprecated": true,
26262628
"tags": [
26272629
"MetaInformation"
26282630
],
26292631
"summary": "Retrieve Supported Languages",
2630-
"operationId": "getLanguages",
2632+
"description": "**Deprecated.** Use `GET /v3/languages?resource=translate_text` (or the appropriate resource)\ninstead. See the [migration guide](https://developers.deepl.com/api-reference/languages/migrate-from-v2-languages)\nfor details.",
2633+
"operationId": "getLanguagesV2",
26312634
"parameters": [
26322635
{
26332636
"name": "type",
@@ -2864,10 +2867,8 @@
28642867
"/v3/languages/resources": {
28652868
"get": {
28662869
"tags": [
2867-
"MetaInformation",
2868-
"beta"
2870+
"MetaInformation"
28692871
],
2870-
"x-beta": true,
28712872
"summary": "Retrieve Language Resources",
28722873
"operationId": "getLanguageResources",
28732874
"description": "Returns all DeepL API resources and the features they support.\n\nFor each feature, the response indicates which languages must support it for the feature to be\navailable — source only (`needs_source_support`), target only (`needs_target_support`), or both.\nThis allows clients to determine feature availability for a language pair by checking the\nappropriate language's `features` object returned by `GET /v3/languages`.",
@@ -3014,10 +3015,8 @@
30143015
"/v3/languages": {
30153016
"get": {
30163017
"tags": [
3017-
"MetaInformation",
3018-
"beta"
3018+
"MetaInformation"
30193019
],
3020-
"x-beta": true,
30213020
"summary": "Retrieve Languages",
30223021
"operationId": "getLanguages",
30233022
"description": "Returns languages supported by the specified DeepL API resource. Each language indicates whether it can\nbe used as a source language, a target language, or both, along with the features it supports for that\nresource.",
@@ -4786,7 +4785,7 @@
47864785
"securitySchemes": {
47874786
"auth_header": {
47884787
"type": "apiKey",
4789-
"description": "Authentication with `Authorization` header and `DeepL-Auth-Key` authentication scheme. Example: `DeepL-Auth-Key <api-key>`\n",
4788+
"description": "Authentication with `Authorization` header and `DeepL-Auth-Key` authentication scheme. Example: `DeepL-Auth-Key <api-key>`\n",
47904789
"name": "Authorization",
47914790
"in": "header",
47924791
"x-default": "DeepL-Auth-Key "
@@ -6562,7 +6561,7 @@
65626561
}
65636562
},
65646563
"Formality": {
6565-
"description": "Sets whether the translated text should lean towards formal or informal language.\nThis feature is only available for certain target languages. Setting this parameter \nwith a target language that does not support formality will fail, unless one of the \n`prefer_...` options are used.\nPossible options are:\n * `default` (default)\n * `more` - for a more formal language\n * `less` - for a more informal language\n * `prefer_more` - for a more formal language if available, otherwise fallback to default formality\n * `prefer_less` - for a more informal language if available, otherwise fallback to default formality",
6564+
"description": "Sets whether the translated text should lean towards formal or informal language.\nThis feature is only available for certain target languages. Setting this parameter\nwith a target language that does not support formality will fail, unless one of the\n`prefer_...` options are used.\nPossible options are:\n * `default` (default)\n * `more` - for a more formal language\n * `less` - for a more informal language\n * `prefer_more` - for a more formal language if available, otherwise fallback to default formality\n * `prefer_less` - for a more informal language if available, otherwise fallback to default formality",
65666565
"type": "string",
65676566
"enum": [
65686567
"default",
@@ -6827,12 +6826,12 @@
68276826
}
68286827
},
68296828
"OutlineDetectionOption": {
6830-
"description": "Disable the automatic detection of XML structure by setting the `outline_detection` parameter \nto `false` and selecting the tags that should be considered structure tags. This will split sentences \nusing the `splitting_tags` parameter.",
6829+
"description": "Disable the automatic detection of XML structure by setting the `outline_detection` parameter\nto `false` and selecting the tags that should be considered structure tags. This will split sentences\nusing the `splitting_tags` parameter.",
68316830
"type": "boolean",
68326831
"default": true
68336832
},
68346833
"OutlineDetectionOptionStr": {
6835-
"description": "Disable the automatic detection of XML structure by setting the `outline_detection` parameter \nto `false` and selecting the tags that should be considered structure tags. This will split sentences \nusing the `splitting_tags` parameter.",
6834+
"description": "Disable the automatic detection of XML structure by setting the `outline_detection` parameter\nto `false` and selecting the tags that should be considered structure tags. This will split sentences\nusing the `splitting_tags` parameter.",
68366835
"type": "string",
68376836
"default": "1",
68386837
"enum": [
@@ -6855,12 +6854,12 @@
68556854
}
68566855
},
68576856
"PreserveFormattingOption": {
6858-
"description": "Sets whether the translation engine should respect the original formatting, even if it would usually \ncorrect some aspects.",
6857+
"description": "Sets whether the translation engine should respect the original formatting, even if it would usually\ncorrect some aspects.",
68596858
"type": "boolean",
68606859
"default": false
68616860
},
68626861
"PreserveFormattingOptionStr": {
6863-
"description": "Sets whether the translation engine should respect the original formatting, even if it would usually \ncorrect some aspects.",
6862+
"description": "Sets whether the translation engine should respect the original formatting, even if it would usually\ncorrect some aspects.",
68646863
"type": "string",
68656864
"enum": [
68666865
"0",
@@ -6869,11 +6868,11 @@
68696868
"default": "0"
68706869
},
68716870
"ShowBilledCharacters": {
6872-
"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.",
6871+
"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.",
68736872
"type": "boolean"
68746873
},
68756874
"SplitSentencesOption": {
6876-
"description": "Sets whether the translation engine should first split the input into sentences. \n\nPossible values are:\n * 0 - no splitting at all, whole input is treated as one sentence\n * 1 (default when tag_handling is not set to html) - splits on punctuation and on newlines\n * nonewlines (default when tag_handling=html) - splits on punctuation only, ignoring newlines",
6875+
"description": "Sets whether the translation engine should first split the input into sentences.\n\nPossible values are:\n * 0 - no splitting at all, whole input is treated as one sentence\n * 1 (default when tag_handling is not set to html) - splits on punctuation and on newlines\n * nonewlines (default when tag_handling=html) - splits on punctuation only, ignoring newlines",
68776876
"type": "string",
68786877
"enum": [
68796878
"0",
@@ -6885,7 +6884,7 @@
68856884
},
68866885
"SourceLanguage": {
68876886
"type": "string",
6888-
"description": "Language of the text to be translated. If this parameter is omitted, the API will attempt to\ndetect the language of the text and translate it.\n\nFor the full list of supported source languages, see [supported languages](https://developers.deepl.com/docs/getting-started/supported-languages) or query the [`GET /v3/languages` endpoint](https://developers.deepl.com/api-reference/languages/retrieve-supported-languages-by-resource) (beta).",
6887+
"description": "Language of the text to be translated. If this parameter is omitted, the API will attempt to\ndetect the language of the text and translate it.\n\nFor the full list of supported source languages, see [supported languages](https://developers.deepl.com/docs/getting-started/supported-languages) or query the [`GET /v3/languages` endpoint](https://developers.deepl.com/api-reference/languages/retrieve-supported-languages-by-resource).",
68896888
"example": "EN"
68906889
},
68916890
"TranslationMemory": {
@@ -7059,7 +7058,7 @@
70597058
},
70607059
"TargetLanguage": {
70617060
"type": "string",
7062-
"description": "The language into which the text should be translated.\n\nFor the full list of supported target languages, see [supported languages](https://developers.deepl.com/docs/getting-started/supported-languages) or query the [`GET /v3/languages` endpoint](https://developers.deepl.com/api-reference/languages/retrieve-supported-languages-by-resource) (beta).",
7061+
"description": "The language into which the text should be translated.\n\nFor the full list of supported target languages, see [supported languages](https://developers.deepl.com/docs/getting-started/supported-languages) or query the [`GET /v3/languages` endpoint](https://developers.deepl.com/api-reference/languages/retrieve-supported-languages-by-resource).",
70637062
"example": "DE"
70647063
},
70657064
"TargetLanguageWrite": {

0 commit comments

Comments
 (0)