Merge pull request #38 from DeepLcom/feat/add-tag-handling-version

feat: add tag handling version

Author: michael-helmling-deepl

CHANGELOG.md

@@ -9,6 +9,10 @@ The major and minor version numbers reflect changes to the DeepL API
 number is used only for corrections to the OpenAPI specification, for example:
 typos, schema fixes, or adding examples.
 
+## [3.6.0] - 2025-10-29
+### Added
+* Add new parameter `tag_handling_version` to `/v2/translate`
+
 ## [3.5.0] - 2025-10-27
 ### Added
 * Add new endpoint `v2/admin/analytics` which enables admins to retrieve usage statistics across their organization

openapi.json

@@ -223,6 +223,9 @@
                   "tag_handling": {
                     "$ref": "#/components/schemas/TagHandlingOption"
                   },
+                  "tag_handling_version": {
+                    "$ref": "#/components/schemas/TagHandlingVersionOption"
+                  },
                   "outline_detection": {
                     "$ref": "#/components/schemas/OutlineDetectionOptionStr"
                   },
@@ -3334,6 +3337,14 @@
           "html"
         ]
       },
+      "TagHandlingVersionOption": {
+        "description": "Sets which version of the tag handling algorithm should be used. Options currently available:\n * `v2`: Improved algorithm released in October 2025 (default as of December 2025).\n * `v1`: Traditional algorithm (default until December 2025).",
+        "type": "string",
+        "enum": [
+          "v1",
+          "v2"
+        ]
+      },
       "UsageResponse": {
         "type": "object",
         "properties": {

openapi.yaml

@@ -238,6 +238,8 @@ paths:
                     pair of the glossary has to match the language pair of the request.
                 tag_handling:
                   $ref: '#/components/schemas/TagHandlingOption'
+                tag_handling_version:
+                  $ref: '#/components/schemas/TagHandlingVersionOption'
                 outline_detection:
                   $ref: '#/components/schemas/OutlineDetectionOptionStr'
                 non_splitting_tags:
@@ -2666,6 +2668,15 @@ components:
       enum:
       - xml
       - html
+    TagHandlingVersionOption:
+      description: |-
+        Sets which version of the tag handling algorithm should be used. Options currently available:
+         * `v2`: Improved algorithm released in October 2025 (default as of December 2025).
+         * `v1`: Traditional algorithm (default until December 2025).
+      type: string
+      enum:
+      - v1
+      - v2
     UsageResponse:
       type: object
       properties:

openapi_gitbook.yaml

@@ -124,6 +124,8 @@ paths:
                   example: def3a26b-3e84-45b3-84ae-0c0aaf3525f7
                 tag_handling:
                   $ref: '#/components/schemas/TagHandlingOption'
+                tag_handling_version:
+                  $ref: '#/components/schemas/TagHandlingVersionOption'
                 outline_detection:
                   $ref: '#/components/schemas/OutlineDetectionOption'
                 non_splitting_tags:
@@ -2343,6 +2345,15 @@ components:
       - xml
       - html
       example: html
+    TagHandlingVersionOption:
+      description: |-
+        Sets which version of the tag handling algorithm should be used. Options currently available:
+         * `v2`: Improved algorithm released in October 2025 (default as of December 2025).
+         * `v1`: Traditional algorithm (default until December 2025).
+      type: string
+      enum:
+      - v1
+      - v2
     NonSplittingTagCommaSeparatedList:
       allOf:
       - $ref: '#/components/schemas/TagCommaSeparatedList'