Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from
Sep 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
16 changes: 8 additions & 8 deletions openapi_gitbook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down