From 2159ec437583d8a20ad69bfd873d8531c382d4c2 Mon Sep 17 00:00:00 2001 From: mike-winters-deepl Date: Wed, 24 Jul 2024 15:05:42 +0200 Subject: [PATCH 1/9] Add zh-hant to OpenAPI spec for text translation --- openapi.yaml | 15 +++++++++------ openapi_gitbook.yaml | 44 ++++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 51 insertions(+), 8 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index 0c6d503..062c7cb 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -1943,7 +1943,7 @@ components: * `PL` - Polish * `PT` - Portuguese (unspecified variant for backward compatibility; please select `PT-BR` or `PT-PT` instead) * `PT-BR` - Portuguese (Brazilian) - * `PT-PT` - Portuguese (all Portuguese varieties excluding Brazilian Portuguese) + * `PT-PT` - Portuguese (all Portuguese variants excluding Brazilian Portuguese) * `RO` - Romanian * `RU` - Russian * `SK` - Slovak @@ -1951,13 +1951,15 @@ components: * `SV` - Swedish * `TR` - Turkish * `UK` - Ukrainian - * `ZH` - Chinese (unspecified variant for backward compatibility; please select `ZH-HANS` instead) + * `ZH` - Chinese (unspecified variant for backward compatibility; please select `ZH-HANS` or `ZH-HANT` instead) * `ZH-HANS` - Chinese (simplified) + * `ZH-HANT` - Chinese (traditional) - [1] Please note that Arabic has not yet been added to the `/languages` endpoint because - it does not yet support document translation; only text translation is supported for Arabic - at this time. When document translation support is added for Arabic, we will a) remove this - note and b) add Arabic to the `/languages` endpoint. + [1] Please note that Arabic and Chinese (traditional) have not yet been added to the /languages + endpoint because these languages do not yet support document translation; only text translation + is supported for Arabic and Chinese (traditional) at this time. When document translation support + is added for these languages, we will a) remove this note and b) add the languages to the /languages + endpoint where appropriate. enum: - AR - BG @@ -1992,4 +1994,5 @@ components: - UK - ZH - ZH-HANS + - ZH-HANT example: DE diff --git a/openapi_gitbook.yaml b/openapi_gitbook.yaml index 9c46b39..a0524df 100644 --- a/openapi_gitbook.yaml +++ b/openapi_gitbook.yaml @@ -92,7 +92,7 @@ paths: source_lang: $ref: '#/components/schemas/SourceLanguage' target_lang: - $ref: '#/components/schemas/TargetLanguage' + $ref: '#/components/schemas/TargetLanguageText' context: $ref: '#/components/schemas/Context' split_sentences: @@ -147,7 +147,7 @@ paths: source_lang: $ref: '#/components/schemas/SourceLanguage' target_lang: - $ref: '#/components/schemas/TargetLanguage' + $ref: '#/components/schemas/TargetLanguageText' context: $ref: '#/components/schemas/Context' split_sentences: @@ -1515,3 +1515,43 @@ components: - ZH - ZH-HANS example: DE + TargetLanguageText: + type: string + description: |- + The language into which the text should be translated. + enum: + - AR + - BG + - CS + - DA + - DE + - EL + - EN-GB + - EN-US + - ES + - ET + - FI + - FR + - HU + - ID + - IT + - JA + - KO + - LT + - LV + - NB + - NL + - PL + - PT-BR + - PT-PT + - RO + - RU + - SK + - SL + - SV + - TR + - UK + - ZH + - ZH-HANS + - ZH-HANT + example: DE From 091bfbe52e9d2541b4724f108a70859e06d0f56c Mon Sep 17 00:00:00 2001 From: mike-winters-deepl Date: Wed, 24 Jul 2024 13:08:50 +0000 Subject: [PATCH 2/9] Update openapi.json to match openapi.yaml --- openapi.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/openapi.json b/openapi.json index bf16bfe..ce80304 100644 --- a/openapi.json +++ b/openapi.json @@ -2051,7 +2051,7 @@ }, "TargetLanguageText": { "type": "string", - "description": "The language into which the text should be translated. Options currently available:\n * `AR` - Arabic [1]\n * `BG` - Bulgarian\n * `CS` - Czech\n * `DA` - Danish\n * `DE` - German\n * `EL` - Greek\n * `EN` - English (unspecified variant for backward compatibility; please select `EN-GB` or `EN-US` instead)\n * `EN-GB` - English (British)\n * `EN-US` - English (American)\n * `ES` - Spanish\n * `ET` - Estonian\n * `FI` - Finnish\n * `FR` - French\n * `HU` - Hungarian\n * `ID` - Indonesian\n * `IT` - Italian\n * `JA` - Japanese\n * `KO` - Korean\n * `LT` - Lithuanian\n * `LV` - Latvian\n * `NB` - Norwegian (Bokm\u00e5l)\n * `NL` - Dutch\n * `PL` - Polish\n * `PT` - Portuguese (unspecified variant for backward compatibility; please select `PT-BR` or `PT-PT` instead)\n * `PT-BR` - Portuguese (Brazilian)\n * `PT-PT` - Portuguese (all Portuguese varieties excluding Brazilian Portuguese)\n * `RO` - Romanian\n * `RU` - Russian\n * `SK` - Slovak\n * `SL` - Slovenian\n * `SV` - Swedish\n * `TR` - Turkish\n * `UK` - Ukrainian\n * `ZH` - Chinese (unspecified variant for backward compatibility; please select `ZH-HANS` instead)\n * `ZH-HANS` - Chinese (simplified)\n\n [1] Please note that Arabic has not yet been added to the `/languages` endpoint because \n it does not yet support document translation; only text translation is supported for Arabic \n at this time. When document translation support is added for Arabic, we will a) remove this \n note and b) add Arabic to the `/languages` endpoint.", + "description": "The language into which the text should be translated. Options currently available:\n * `AR` - Arabic [1]\n * `BG` - Bulgarian\n * `CS` - Czech\n * `DA` - Danish\n * `DE` - German\n * `EL` - Greek\n * `EN` - English (unspecified variant for backward compatibility; please select `EN-GB` or `EN-US` instead)\n * `EN-GB` - English (British)\n * `EN-US` - English (American)\n * `ES` - Spanish\n * `ET` - Estonian\n * `FI` - Finnish\n * `FR` - French\n * `HU` - Hungarian\n * `ID` - Indonesian\n * `IT` - Italian\n * `JA` - Japanese\n * `KO` - Korean\n * `LT` - Lithuanian\n * `LV` - Latvian\n * `NB` - Norwegian (Bokm\u00e5l)\n * `NL` - Dutch\n * `PL` - Polish\n * `PT` - Portuguese (unspecified variant for backward compatibility; please select `PT-BR` or `PT-PT` instead)\n * `PT-BR` - Portuguese (Brazilian)\n * `PT-PT` - Portuguese (all Portuguese variants excluding Brazilian Portuguese)\n * `RO` - Romanian\n * `RU` - Russian\n * `SK` - Slovak\n * `SL` - Slovenian\n * `SV` - Swedish\n * `TR` - Turkish\n * `UK` - Ukrainian\n * `ZH` - Chinese (unspecified variant for backward compatibility; please select `ZH-HANS` or `ZH-HANT` instead)\n * `ZH-HANS` - Chinese (simplified)\n * `ZH-HANT` - Chinese (traditional)\n\n [1] Please note that Arabic and Chinese (traditional) have not yet been added to the /languages \n endpoint because these languages do not yet support document translation; only text translation \n is supported for Arabic and Chinese (traditional) at this time. When document translation support \n is added for these languages, we will a) remove this note and b) add the languages to the /languages \n endpoint where appropriate.", "enum": [ "AR", "BG", @@ -2085,7 +2085,8 @@ "TR", "UK", "ZH", - "ZH-HANS" + "ZH-HANS", + "ZH-HANT" ], "example": "DE" } From 7b0bb3e7e064fa9bc279bab9c5bf609b3d29e683 Mon Sep 17 00:00:00 2001 From: mike-winters-deepl Date: Wed, 24 Jul 2024 15:20:53 +0200 Subject: [PATCH 3/9] Update wording for traditional Chinese --- openapi.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index 062c7cb..59057aa 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -1955,9 +1955,9 @@ components: * `ZH-HANS` - Chinese (simplified) * `ZH-HANT` - Chinese (traditional) - [1] Please note that Arabic and Chinese (traditional) have not yet been added to the /languages + [1] Please note that Arabic and traditional Chinese have not yet been added to the /languages endpoint because these languages do not yet support document translation; only text translation - is supported for Arabic and Chinese (traditional) at this time. When document translation support + is supported for Arabic and traditional Chinese at this time. When document translation support is added for these languages, we will a) remove this note and b) add the languages to the /languages endpoint where appropriate. enum: From 30c8b5f4991a3e17a166951cdf39be9dedd0166e Mon Sep 17 00:00:00 2001 From: mike-winters-deepl Date: Wed, 24 Jul 2024 13:21:28 +0000 Subject: [PATCH 4/9] Update openapi.json to match openapi.yaml --- openapi.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openapi.json b/openapi.json index ce80304..c1728cc 100644 --- a/openapi.json +++ b/openapi.json @@ -2051,7 +2051,7 @@ }, "TargetLanguageText": { "type": "string", - "description": "The language into which the text should be translated. Options currently available:\n * `AR` - Arabic [1]\n * `BG` - Bulgarian\n * `CS` - Czech\n * `DA` - Danish\n * `DE` - German\n * `EL` - Greek\n * `EN` - English (unspecified variant for backward compatibility; please select `EN-GB` or `EN-US` instead)\n * `EN-GB` - English (British)\n * `EN-US` - English (American)\n * `ES` - Spanish\n * `ET` - Estonian\n * `FI` - Finnish\n * `FR` - French\n * `HU` - Hungarian\n * `ID` - Indonesian\n * `IT` - Italian\n * `JA` - Japanese\n * `KO` - Korean\n * `LT` - Lithuanian\n * `LV` - Latvian\n * `NB` - Norwegian (Bokm\u00e5l)\n * `NL` - Dutch\n * `PL` - Polish\n * `PT` - Portuguese (unspecified variant for backward compatibility; please select `PT-BR` or `PT-PT` instead)\n * `PT-BR` - Portuguese (Brazilian)\n * `PT-PT` - Portuguese (all Portuguese variants excluding Brazilian Portuguese)\n * `RO` - Romanian\n * `RU` - Russian\n * `SK` - Slovak\n * `SL` - Slovenian\n * `SV` - Swedish\n * `TR` - Turkish\n * `UK` - Ukrainian\n * `ZH` - Chinese (unspecified variant for backward compatibility; please select `ZH-HANS` or `ZH-HANT` instead)\n * `ZH-HANS` - Chinese (simplified)\n * `ZH-HANT` - Chinese (traditional)\n\n [1] Please note that Arabic and Chinese (traditional) have not yet been added to the /languages \n endpoint because these languages do not yet support document translation; only text translation \n is supported for Arabic and Chinese (traditional) at this time. When document translation support \n is added for these languages, we will a) remove this note and b) add the languages to the /languages \n endpoint where appropriate.", + "description": "The language into which the text should be translated. Options currently available:\n * `AR` - Arabic [1]\n * `BG` - Bulgarian\n * `CS` - Czech\n * `DA` - Danish\n * `DE` - German\n * `EL` - Greek\n * `EN` - English (unspecified variant for backward compatibility; please select `EN-GB` or `EN-US` instead)\n * `EN-GB` - English (British)\n * `EN-US` - English (American)\n * `ES` - Spanish\n * `ET` - Estonian\n * `FI` - Finnish\n * `FR` - French\n * `HU` - Hungarian\n * `ID` - Indonesian\n * `IT` - Italian\n * `JA` - Japanese\n * `KO` - Korean\n * `LT` - Lithuanian\n * `LV` - Latvian\n * `NB` - Norwegian (Bokm\u00e5l)\n * `NL` - Dutch\n * `PL` - Polish\n * `PT` - Portuguese (unspecified variant for backward compatibility; please select `PT-BR` or `PT-PT` instead)\n * `PT-BR` - Portuguese (Brazilian)\n * `PT-PT` - Portuguese (all Portuguese variants excluding Brazilian Portuguese)\n * `RO` - Romanian\n * `RU` - Russian\n * `SK` - Slovak\n * `SL` - Slovenian\n * `SV` - Swedish\n * `TR` - Turkish\n * `UK` - Ukrainian\n * `ZH` - Chinese (unspecified variant for backward compatibility; please select `ZH-HANS` or `ZH-HANT` instead)\n * `ZH-HANS` - Chinese (simplified)\n * `ZH-HANT` - Chinese (traditional)\n\n [1] Please note that Arabic and traditional Chinese have not yet been added to the /languages \n endpoint because these languages do not yet support document translation; only text translation \n is supported for Arabic and traditional Chinese at this time. When document translation support \n is added for these languages, we will a) remove this note and b) add the languages to the /languages \n endpoint where appropriate.", "enum": [ "AR", "BG", From 99538db7316ff1f5c379af6e338544f07c7e1f1b Mon Sep 17 00:00:00 2001 From: mike-winters-deepl Date: Thu, 25 Jul 2024 08:36:03 +0200 Subject: [PATCH 5/9] Increase minor version number --- openapi.yaml | 2 +- openapi_gitbook.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index 59057aa..9d0d9ae 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.0.4 info: title: DeepL API Documentation description: The DeepL API provides programmatic access to DeepL’s machine translation diff --git a/openapi_gitbook.yaml b/openapi_gitbook.yaml index a0524df..3e82083 100644 --- a/openapi_gitbook.yaml +++ b/openapi_gitbook.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.0.4 info: title: DeepL API Documentation description: |- From 22c3e837427868897fc54a0f07e4bdd9d4c1a77a Mon Sep 17 00:00:00 2001 From: mike-winters-deepl Date: Thu, 25 Jul 2024 06:36:32 +0000 Subject: [PATCH 6/9] Update openapi.json to match openapi.yaml --- openapi.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openapi.json b/openapi.json index c1728cc..3ddeadd 100644 --- a/openapi.json +++ b/openapi.json @@ -1,5 +1,5 @@ { - "openapi": "3.0.3", + "openapi": "3.0.4", "info": { "title": "DeepL API Documentation", "description": "The DeepL API provides programmatic access to DeepL\u2019s machine translation technology.", From 36c3bac08f304511fbbd42ca22c377e7b0e8c780 Mon Sep 17 00:00:00 2001 From: mike-winters-deepl Date: Thu, 25 Jul 2024 09:36:36 +0200 Subject: [PATCH 7/9] Version update fix --- openapi.yaml | 4 ++-- openapi_gitbook.yaml | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index 9d0d9ae..b2da27c 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.4 +openapi: 3.0.3 info: title: DeepL API Documentation description: The DeepL API provides programmatic access to DeepL’s machine translation @@ -7,7 +7,7 @@ info: contact: name: DeepL - Contact us url: https://www.deepl.com/contact-us - version: 2.15.0 + version: 2.16.0 externalDocs: description: DeepL Pro - Plans and pricing url: https://www.deepl.com/pro#developer?cta=header-prices/ diff --git a/openapi_gitbook.yaml b/openapi_gitbook.yaml index 3e82083..741e65c 100644 --- a/openapi_gitbook.yaml +++ b/openapi_gitbook.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.4 +openapi: 3.0.3 info: title: DeepL API Documentation description: |- @@ -9,7 +9,7 @@ info: contact: name: DeepL - Contact us url: https://www.deepl.com/contact-us - version: 2.15.0 + version: 2.16.0 externalDocs: description: DeepL Pro - Plans and pricing url: https://www.deepl.com/pro#developer?cta=header-prices/ From 27e298f8358786a522497b4f5aa87e5ab0e0570d Mon Sep 17 00:00:00 2001 From: mike-winters-deepl Date: Thu, 25 Jul 2024 07:37:06 +0000 Subject: [PATCH 8/9] Update openapi.json to match openapi.yaml --- openapi.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/openapi.json b/openapi.json index 3ddeadd..6e4c5c0 100644 --- a/openapi.json +++ b/openapi.json @@ -1,5 +1,5 @@ { - "openapi": "3.0.4", + "openapi": "3.0.3", "info": { "title": "DeepL API Documentation", "description": "The DeepL API provides programmatic access to DeepL\u2019s machine translation technology.", @@ -8,7 +8,7 @@ "name": "DeepL - Contact us", "url": "https://www.deepl.com/contact-us" }, - "version": "2.15.0" + "version": "2.16.0" }, "externalDocs": { "description": "DeepL Pro - Plans and pricing", From 4fff8a179fb93e1c0f025e9ed77134bf2fa066d2 Mon Sep 17 00:00:00 2001 From: Daniel Jones Date: Thu, 25 Jul 2024 12:39:19 +0200 Subject: [PATCH 9/9] Update changelog --- CHANGELOG.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index dc6bd85..7119ab9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,14 +10,19 @@ number is used only for corrections to the OpenAPI specification, for example: typos, schema fixes, or adding examples. -## [Unreleased] +## [2.16.0] - 2024-07-25 +### Added +* Add supported target language variant for text translation: Chinese + (traditional) (`ZH-HANT`). Traditional Chinese is currently supported only for + text translation; document translation support is coming soon. ### Changed * The Chinese language codes returned in the `/languages` response for target languages were changed. While previously only `ZH` "Chinese (simplified)" was included, `ZH-HANS` "Chinese (simplified)" is now listed too. Both language codes are supported for text and document translation. ### Deprecated -* The target language code `ZH` is deprecated; instead `ZH-HANS` should be used. +* The target language code `ZH` is deprecated; instead `ZH-HANS` or `ZH-HANT` + should be used. ## [2.15.0] - 2024-07-03 @@ -151,7 +156,7 @@ typos, schema fixes, or adding examples. Initial release of the OpenAPI specification. -[Unreleased]: https://github.com/DeepLcom/openapi/compare/v2.15.0...HEAD +[2.16.0]: https://github.com/DeepLcom/openapi/compare/v2.15.0...v2.16.0 [2.15.0]: https://github.com/DeepLcom/openapi/compare/v2.14.1...v2.15.0 [2.14.1]: https://github.com/DeepLcom/openapi/compare/v2.14.0...v2.14.1 [2.14.0]: https://github.com/DeepLcom/openapi/compare/v2.13.0...v2.14.0