From 05e1a8f562e53337d1716d337cee2454fe7f43ce Mon Sep 17 00:00:00 2001
From: Daniel Jones <daniel.jones@deepl.com>
Date: Mon, 9 Sep 2024 14:13:16 +0200
Subject: [PATCH] Correct tag-list parameter descriptions as only XML
 tag-handling is supported (#23)

* Correct tag-list parameter descriptions as only XML tag-handling is supported

---------

Co-authored-by: daniel-jones-dev <daniel-jones-dev@users.noreply.github.com>
---
 openapi.json         |  4 ++--
 openapi.yaml         |  4 ++--
 openapi_gitbook.yaml | 16 ++++++++--------
 3 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/openapi.json b/openapi.json
index 6e4c5c0..936ed33 100644
--- a/openapi.json
+++ b/openapi.json
@@ -1994,12 +1994,12 @@
         "description": "List of XML tags that indicate text not to be translated.\n\n\nUse this parameter to ensure that elements in the original text are not altered in the translation (e.g., trademarks, product names) and insert tags into your original text. In the following example, the `ignore_tags` parameter is set to `keep`:\n * Example request:\n   ```\n   Please open the page <keep>Settings</keep> to configure your system.\n   ```\n * Example response:\n   ```\n   Bitte \u00f6ffnen Sie die Seite <keep>Settings</keep> um Ihr System zu konfigurieren.\n   ```"
       },
       "TagCommaSeparatedList": {
-        "description": "Comma-separated list of XML or HTML tags.",
+        "description": "Comma-separated list of XML tags.",
         "type": "string",
         "example": "a,p,span"
       },
       "TagList": {
-        "description": "List of XML or HTML tags.",
+        "description": "List of XML tags.",
         "type": "array",
         "items": {
           "type": "string"
diff --git a/openapi.yaml b/openapi.yaml
index b2da27c..572cf15 100644
--- a/openapi.yaml
+++ b/openapi.yaml
@@ -1830,11 +1830,11 @@ components:
            Bitte öffnen Sie die Seite <keep>Settings</keep> um Ihr System zu konfigurieren.
            ```
     TagCommaSeparatedList:
-      description: Comma-separated list of XML or HTML tags.
+      description: Comma-separated list of XML tags.
       type: string
       example: a,p,span
     TagList:
-      description: List of XML or HTML tags.
+      description: List of XML tags.
       type: array
       items:
         type: string
diff --git a/openapi_gitbook.yaml b/openapi_gitbook.yaml
index 741e65c..ffb0204 100644
--- a/openapi_gitbook.yaml
+++ b/openapi_gitbook.yaml
@@ -113,19 +113,19 @@ paths:
                 outline_detection:
                   $ref: '#/components/schemas/OutlineDetectionOption'
                 non_splitting_tags:
-                  description: Comma-separated list of HTML or XML tags which never split sentences.
+                  description: Comma-separated list of XML tags which never split sentences.
                   type: array
                   items:
                     type: string
                     example: non_splitting_tag
                 splitting_tags:
-                  description: Comma-separated list of HTML or XML tags which always cause splits.
+                  description: Comma-separated list of XML tags which always cause splits.
                   type: array
                   items:
                     type: string
                     example: splitting_tag
                 ignore_tags:
-                  description: Comma-separated list of HTML or XML tags that indicate text not to be translated.
+                  description: Comma-separated list of XML tags that indicate text not to be translated.
                   type: array
                   items:
                     type: string
@@ -168,19 +168,19 @@ paths:
                 outline_detection:
                   $ref: '#/components/schemas/OutlineDetectionOptionStr'
                 non_splitting_tags:
-                  description: Comma-separated list of HTML or XML tags which never split sentences.
+                  description: Comma-separated list of XML tags which never split sentences.
                   type: array
                   items:
                     type: string
                     example: non_splitting_tag
                 splitting_tags:
-                  description: Comma-separated list of HTML or XML tags which always cause splits.
+                  description: Comma-separated list of XML tags which always cause splits.
                   type: array
                   items:
                     type: string
                     example: splitting_tag
                 ignore_tags:
-                  description: Comma-separated list of HTML or XML tags that indicate text not to be translated.
+                  description: Comma-separated list of XML tags that indicate text not to be translated.
                   type: array
                   items:
                     type: string
@@ -1466,11 +1466,11 @@ components:
       - $ref: '#/components/schemas/TagList'
       description: List of XML tags that indicate text not to be translated.
     TagCommaSeparatedList:
-      description: Comma-separated list of XML or HTML tags.
+      description: Comma-separated list of XML tags.
       type: string
       example: a,p,span
     TagList:
-      description: List of XML or HTML tags.
+      description: List of XML tags.
       type: array
       items:
         type: string