From c2a61a8b9441cd9e8fdde8eb9ba43628cd7a8286 Mon Sep 17 00:00:00 2001 From: Daniel Jones Date: Mon, 9 Sep 2024 11:41:14 +0200 Subject: [PATCH 1/3] Correct tag-list parameter descriptions as only XML tag-handling is supported --- openapi.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 Settings 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 From 6a3899274124dd83e3ad3f806bc914219fa9d112 Mon Sep 17 00:00:00 2001 From: daniel-jones-dev Date: Mon, 9 Sep 2024 09:42:06 +0000 Subject: [PATCH 2/3] 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 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 Settings to configure your system.\n ```\n * Example response:\n ```\n Bitte \u00f6ffnen Sie die Seite Settings 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" From 27b323ae9671a0266ac8ab0fecef8e226e8976ca Mon Sep 17 00:00:00 2001 From: Daniel Jones Date: Mon, 9 Sep 2024 11:46:07 +0200 Subject: [PATCH 3/3] Correct tag list descriptions in _gitbook.yaml --- openapi_gitbook.yaml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) 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