Skip to content

Commit 05e1a8f

Browse files
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 <[email protected]>
1 parent fed2755 commit 05e1a8f

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

openapi.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1994,12 +1994,12 @@
19941994
"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 ```"
19951995
},
19961996
"TagCommaSeparatedList": {
1997-
"description": "Comma-separated list of XML or HTML tags.",
1997+
"description": "Comma-separated list of XML tags.",
19981998
"type": "string",
19991999
"example": "a,p,span"
20002000
},
20012001
"TagList": {
2002-
"description": "List of XML or HTML tags.",
2002+
"description": "List of XML tags.",
20032003
"type": "array",
20042004
"items": {
20052005
"type": "string"

openapi.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1830,11 +1830,11 @@ components:
18301830
Bitte öffnen Sie die Seite <keep>Settings</keep> um Ihr System zu konfigurieren.
18311831
```
18321832
TagCommaSeparatedList:
1833-
description: Comma-separated list of XML or HTML tags.
1833+
description: Comma-separated list of XML tags.
18341834
type: string
18351835
example: a,p,span
18361836
TagList:
1837-
description: List of XML or HTML tags.
1837+
description: List of XML tags.
18381838
type: array
18391839
items:
18401840
type: string

openapi_gitbook.yaml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -113,19 +113,19 @@ paths:
113113
outline_detection:
114114
$ref: '#/components/schemas/OutlineDetectionOption'
115115
non_splitting_tags:
116-
description: Comma-separated list of HTML or XML tags which never split sentences.
116+
description: Comma-separated list of XML tags which never split sentences.
117117
type: array
118118
items:
119119
type: string
120120
example: non_splitting_tag
121121
splitting_tags:
122-
description: Comma-separated list of HTML or XML tags which always cause splits.
122+
description: Comma-separated list of XML tags which always cause splits.
123123
type: array
124124
items:
125125
type: string
126126
example: splitting_tag
127127
ignore_tags:
128-
description: Comma-separated list of HTML or XML tags that indicate text not to be translated.
128+
description: Comma-separated list of XML tags that indicate text not to be translated.
129129
type: array
130130
items:
131131
type: string
@@ -168,19 +168,19 @@ paths:
168168
outline_detection:
169169
$ref: '#/components/schemas/OutlineDetectionOptionStr'
170170
non_splitting_tags:
171-
description: Comma-separated list of HTML or XML tags which never split sentences.
171+
description: Comma-separated list of XML tags which never split sentences.
172172
type: array
173173
items:
174174
type: string
175175
example: non_splitting_tag
176176
splitting_tags:
177-
description: Comma-separated list of HTML or XML tags which always cause splits.
177+
description: Comma-separated list of XML tags which always cause splits.
178178
type: array
179179
items:
180180
type: string
181181
example: splitting_tag
182182
ignore_tags:
183-
description: Comma-separated list of HTML or XML tags that indicate text not to be translated.
183+
description: Comma-separated list of XML tags that indicate text not to be translated.
184184
type: array
185185
items:
186186
type: string
@@ -1466,11 +1466,11 @@ components:
14661466
- $ref: '#/components/schemas/TagList'
14671467
description: List of XML tags that indicate text not to be translated.
14681468
TagCommaSeparatedList:
1469-
description: Comma-separated list of XML or HTML tags.
1469+
description: Comma-separated list of XML tags.
14701470
type: string
14711471
example: a,p,span
14721472
TagList:
1473-
description: List of XML or HTML tags.
1473+
description: List of XML tags.
14741474
type: array
14751475
items:
14761476
type: string

0 commit comments

Comments
 (0)