Merge pull request #15 from DeepLcom/add_glossary_languages

Add glossary languages

Author: daniel-jones-dev

CHANGELOG.md

@@ -10,6 +10,11 @@ number is used only for corrections to the OpenAPI specification, for example:
 typos, schema fixes, or adding examples.
 
 
+## [2.14.0] - 2024-05-08
+### Added
+* Added supported glossary languages: Danish (`'da'`), Norwegian (bokmål) (`'nb'`), and Swedish (`'sv'`).
+
+
 ## [2.13.0] - 2024-03-14
 ### Deprecated
 * Remove all properties from `/usage` except for `character_count` and `character_limit`; 
@@ -126,6 +131,7 @@ typos, schema fixes, or adding examples.
 Initial release of the OpenAPI specification.
 
 
+[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
 [2.12.0]: https://github.com/DeepLcom/openapi/compare/v2.11.0...v2.12.0
 [2.11.0]: https://github.com/DeepLcom/openapi/compare/v2.10.0...v2.11.0

openapi.json

@@ -8,7 +8,7 @@
       "name": "DeepL - Contact us",
       "url": "https://www.deepl.com/contact-us"
     },
-    "version": "2.13.0"
+    "version": "2.14.0"
   },
   "externalDocs": {
     "description": "DeepL Pro - Plans and pricing",
@@ -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 support@DeepL.com.\n\nThe DeepL API supports glossaries in any combination of two languages from the following list, enabling a total of\n66 possible glossary language pairs:\n\n- DE (German)\n- EN (English)\n- ES (Spanish)\n- FR (French)\n- IT (Italian)\n- JA (Japanese)\n- KO (Korean)\n- NL (Dutch)\n- PL (Polish)\n- PT (Portuguese)\n- RU (Russian)\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 support@DeepL.com.\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."
     },
     {
       "name": "MetaInformation",
@@ -1781,17 +1781,20 @@
         "type": "string",
         "description": "The language in which the source texts in the glossary are specified.",
         "enum": [
+          "da",
           "de",
           "en",
           "es",
           "fr",
           "it",
           "ja",
           "ko",
+          "nb",
           "nl",
           "pl",
           "pt",
           "ru",
+          "sv",
           "zh"
         ],
         "example": "en"
@@ -1800,17 +1803,20 @@
         "type": "string",
         "description": "The language in which the target texts in the glossary are specified.",
         "enum": [
+          "da",
           "de",
           "en",
           "es",
           "fr",
           "it",
           "ja",
           "ko",
+          "nb",
           "nl",
           "pl",
           "pt",
           "ru",
+          "sv",
           "zh"
         ],
         "example": "de"

openapi.yaml

@@ -7,7 +7,7 @@ info:
   contact:
     name: DeepL - Contact us
     url: https://www.deepl.com/contact-us
-  version: 2.13.0
+  version: 2.14.0
 externalDocs:
   description: DeepL Pro - Plans and pricing
   url: https://www.deepl.com/pro#developer?cta=header-prices/
@@ -53,19 +53,22 @@ tags:
     If you encounter issues, please let us know at support@DeepL.com.
 
     The DeepL API supports glossaries in any combination of two languages from the following list, enabling a total of
-    66 possible glossary language pairs:
+    105 possible glossary language pairs:
 
+    - DA (Danish)
     - DE (German)
     - EN (English)
     - ES (Spanish)
     - FR (French)
     - IT (Italian)
     - JA (Japanese)
     - KO (Korean)
+    - NB (Norwegian (bokmål))
     - NL (Dutch)
     - PL (Polish)
     - PT (Portuguese)
     - RU (Russian)
+    - SV (Swedish)
     - ZH (Chinese)
 
     The maximum size limit for a glossary is 10 MiB = 10485760 bytes and each source/target text,
@@ -1417,34 +1420,40 @@ components:
       type: string
       description: The language in which the source texts in the glossary are specified.
       enum:
+      - da
       - de
       - en
       - es
       - fr
       - it
       - ja
       - ko
+      - nb
       - nl
       - pl
       - pt
       - ru
+      - sv
       - zh
       example: en
     GlossaryTargetLanguage:
       type: string
       description: The language in which the target texts in the glossary are specified.
       enum:
+      - da
       - de
       - en
       - es
       - fr
       - it
       - ja
       - ko
+      - nb
       - nl
       - pl
       - pt
       - ru
+      - sv
       - zh
       example: de
     OutlineDetectionOption:

openapi_gitbook.yaml

@@ -9,7 +9,7 @@ info:
   contact:
     name: DeepL - Contact us
     url: https://www.deepl.com/contact-us
-  version: 2.13.0
+  version: 2.14.0
 externalDocs:
   description: DeepL Pro - Plans and pricing
   url: https://www.deepl.com/pro#developer?cta=header-prices/
@@ -40,19 +40,22 @@ tags:
     If you encounter issues, please let us know at support@DeepL.com.
 
     The DeepL API supports glossaries in any combination of two languages from the following list, enabling a total of
-    66 possible glossary language pairs:
+    105 possible glossary language pairs:
 
+    - DA (Danish)
     - DE (German)
     - EN (English)
     - ES (Spanish)
     - FR (French)
     - IT (Italian)
     - JA (Japanese)
     - KO (Korean)
+    - NB (Norwegian (bokmål))
     - NL (Dutch)
     - PL (Polish)
     - PT (Portuguese)
     - RU (Russian)
+    - SV (Swedish)
     - ZH (Chinese)
 - name: MetaInformation
   description: Information about API usage and value ranges
@@ -1261,34 +1264,40 @@ components:
       type: string
       description: The language in which the source texts in the glossary are specified.
       enum:
+      - da
       - de
       - en
       - es
       - fr
       - it
       - ja
       - ko
+      - nb
       - nl
       - pl
       - pt
       - ru
+      - sv
       - zh
       example: en
     GlossaryTargetLanguage:
       type: string
       description: The language in which the target texts in the glossary are specified.
       enum:
+      - da
       - de
       - en
       - es
       - fr
       - it
       - ja
       - ko
+      - nb
       - nl
       - pl
       - pt
       - ru
+      - sv
       - zh
       example: de
     OutlineDetectionOption: