Skip to content

Commit

Permalink
Merge pull request #19 from DeepLcom/add_ro_to_glossary_documentation
Browse files Browse the repository at this point in the history
Add RO as glossary language
  • Loading branch information
seekuehe authored Jul 5, 2024
2 parents a279605 + 5d35a8f commit 0fbd4ae
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 6 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ number is used only for corrections to the OpenAPI specification, for example:
typos, schema fixes, or adding examples.


## [2.15.0] - 2024-07-03
### Added
* Add supported glossary language: Romanian (`ro`).


## [2.14.1] - 2024-06-18
### Changed
* Text translation `context` parameter is now generally available (was alpha).
Expand Down Expand Up @@ -136,6 +141,7 @@ typos, schema fixes, or adding examples.
Initial release of the OpenAPI specification.


[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
[2.13.0]: https://github.com/DeepLcom/openapi/compare/v2.12.0...v2.13.0
Expand Down
6 changes: 4 additions & 2 deletions openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"name": "DeepL - Contact us",
"url": "https://www.deepl.com/contact-us"
},
"version": "2.14.1"
"version": "2.15.0"
},
"externalDocs": {
"description": "DeepL Pro - Plans and pricing",
Expand All @@ -35,7 +35,7 @@
},
{
"name": "ManageGlossaries",
"description": "The *glossary* functions allow you to create, inspect, and delete glossaries.\nGlossaries created with the glossary function can be used in translate requests by specifying the\n`glossary_id` parameter.\nIf you encounter issues, please let us know at [email protected].\n\nThe DeepL API supports glossaries in any combination of two languages from the following list, enabling a total of\n105 possible glossary language pairs:\n\n- DA (Danish)\n- DE (German)\n- EN (English)\n- ES (Spanish)\n- FR (French)\n- IT (Italian)\n- JA (Japanese)\n- KO (Korean)\n- NB (Norwegian (bokm\u00e5l))\n- NL (Dutch)\n- PL (Polish)\n- PT (Portuguese)\n- RU (Russian)\n- SV (Swedish)\n- ZH (Chinese)\n\nThe maximum size limit for a glossary is 10 MiB = 10485760 bytes and each source/target text,\nas well as the name of the glossary, is limited to 1024 UTF-8 bytes.\nA total of 1000 glossaries are allowed per account.\n\nWhen creating a glossary with target language `EN` or `PT`, it's not necessary to specify a variant (e.g. `EN-US`, `EN-GB`, `PT-PT` or `PT-BR`).\nGlossaries with target language `EN` can be used in translations with either English variant.\nSimilarly `PT` glossaries can be used in translations with either Portuguese variant.\n\n\nGlossaries created via the DeepL API are distinct from glossaries created via the DeepL website and DeepL apps.\nThis means API glossaries cannot be used on the website and vice versa.\n\n\n\nNote that glossaries are immutable: once created, the glossary entries for a given glossary ID cannot be modified.\n\nAs a workaround for effectively editable glossaries, we suggest to identify glossaries by name instead of ID in your application\nand then use the following procedure for modifications:\n- [download](https://www.deepl.com/docs-api/glossaries/get-glossary-entries) and store the current glossary's entries,\n- locally modify the glossary entries,\n- [delete](https://www.deepl.com/docs-api/glossaries/delete-glossary) the existing glossary,\n- [create a new glossary](https://www.deepl.com/docs-api/glossaries/create-glossary) with the same name."
"description": "The *glossary* functions allow you to create, inspect, and delete glossaries.\nGlossaries created with the glossary function can be used in translate requests by specifying the\n`glossary_id` parameter.\nIf you encounter issues, please let us know at [email protected].\n\nThe DeepL API supports glossaries in any combination of two languages from the following list, enabling a total of\n120 possible glossary language pairs:\n\n- DA (Danish)\n- DE (German)\n- EN (English)\n- ES (Spanish)\n- FR (French)\n- IT (Italian)\n- JA (Japanese)\n- KO (Korean)\n- NB (Norwegian (bokm\u00e5l))\n- NL (Dutch)\n- PL (Polish)\n- PT (Portuguese)\n- RO (Romanian)\n- RU (Russian)\n- SV (Swedish)\n- ZH (Chinese)\n\nThe maximum size limit for a glossary is 10 MiB = 10485760 bytes and each source/target text,\nas well as the name of the glossary, is limited to 1024 UTF-8 bytes.\nA total of 1000 glossaries are allowed per account.\n\nWhen creating a glossary with target language `EN` or `PT`, it's not necessary to specify a variant (e.g. `EN-US`, `EN-GB`, `PT-PT` or `PT-BR`).\nGlossaries with target language `EN` can be used in translations with either English variant.\nSimilarly `PT` glossaries can be used in translations with either Portuguese variant.\n\n\nGlossaries created via the DeepL API are distinct from glossaries created via the DeepL website and DeepL apps.\nThis means API glossaries cannot be used on the website and vice versa.\n\n\n\nNote that glossaries are immutable: once created, the glossary entries for a given glossary ID cannot be modified.\n\nAs a workaround for effectively editable glossaries, we suggest to identify glossaries by name instead of ID in your application\nand then use the following procedure for modifications:\n- [download](https://www.deepl.com/docs-api/glossaries/get-glossary-entries) and store the current glossary's entries,\n- locally modify the glossary entries,\n- [delete](https://www.deepl.com/docs-api/glossaries/delete-glossary) the existing glossary,\n- [create a new glossary](https://www.deepl.com/docs-api/glossaries/create-glossary) with the same name."
},
{
"name": "MetaInformation",
Expand Down Expand Up @@ -1793,6 +1793,7 @@
"nl",
"pl",
"pt",
"ro",
"ru",
"sv",
"zh"
Expand All @@ -1815,6 +1816,7 @@
"nl",
"pl",
"pt",
"ro",
"ru",
"sv",
"zh"
Expand Down
7 changes: 5 additions & 2 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ info:
contact:
name: DeepL - Contact us
url: https://www.deepl.com/contact-us
version: 2.14.1
version: 2.15.0
externalDocs:
description: DeepL Pro - Plans and pricing
url: https://www.deepl.com/pro#developer?cta=header-prices/
Expand Down Expand Up @@ -54,7 +54,7 @@ tags:
If you encounter issues, please let us know at [email protected].
The DeepL API supports glossaries in any combination of two languages from the following list, enabling a total of
105 possible glossary language pairs:
120 possible glossary language pairs:
- DA (Danish)
- DE (German)
Expand All @@ -68,6 +68,7 @@ tags:
- NL (Dutch)
- PL (Polish)
- PT (Portuguese)
- RO (Romanian)
- RU (Russian)
- SV (Swedish)
- ZH (Chinese)
Expand Down Expand Up @@ -1426,6 +1427,7 @@ components:
- nl
- pl
- pt
- ro
- ru
- sv
- zh
Expand All @@ -1446,6 +1448,7 @@ components:
- nl
- pl
- pt
- ro
- ru
- sv
- zh
Expand Down
7 changes: 5 additions & 2 deletions openapi_gitbook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ info:
contact:
name: DeepL - Contact us
url: https://www.deepl.com/contact-us
version: 2.14.1
version: 2.15.0
externalDocs:
description: DeepL Pro - Plans and pricing
url: https://www.deepl.com/pro#developer?cta=header-prices/
Expand Down Expand Up @@ -41,7 +41,7 @@ tags:
If you encounter issues, please let us know at [email protected].
The DeepL API supports glossaries in any combination of two languages from the following list, enabling a total of
105 possible glossary language pairs:
120 possible glossary language pairs:
- DA (Danish)
- DE (German)
Expand All @@ -55,6 +55,7 @@ tags:
- NL (Dutch)
- PL (Polish)
- PT (Portuguese)
- RO (Romanian)
- RU (Russian)
- SV (Swedish)
- ZH (Chinese)
Expand Down Expand Up @@ -1278,6 +1279,7 @@ components:
- nl
- pl
- pt
- ro
- ru
- sv
- zh
Expand All @@ -1298,6 +1300,7 @@ components:
- nl
- pl
- pt
- ro
- ru
- sv
- zh
Expand Down

0 comments on commit 0fbd4ae

Please sign in to comment.