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.

Sign up for GitHub

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

Additonal CAT description updates #778

Merged
merged 1 commit into from
Jan 10, 2025
Merged

Additonal CAT description updates #778

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
84 changes: 42 additions & 42 deletions spec/namespaces/cat.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1156,11 +1156,11 @@
cat.all_pit_segments::query.help:
name: help
in: query
description: Return help information.
description: Returns help information.
schema:
type: boolean
default: false
description: Return help information.
description: Returns help information.
cat.all_pit_segments::query.s:
name: s
in: query
Expand Down Expand Up @@ -1292,11 +1292,11 @@
cat.cluster_manager::query.help:
name: help
in: query
description: Return help information.
description: Returns help information.
schema:
type: boolean
default: false
description: Return help information.
description: Returns help information.
cat.cluster_manager::query.local:
name: local
in: query
Expand Down Expand Up @@ -1364,11 +1364,11 @@
cat.count::query.help:
name: help
in: query
description: Return help information.
description: Returns help information.
schema:
type: boolean
default: false
description: Return help information.
description: Returns help information.
cat.count::query.s:
name: s
in: query
Expand Down Expand Up @@ -1433,11 +1433,11 @@
cat.fielddata::query.help:
name: help
in: query
description: Return help information.
description: Returns help information.
schema:
type: boolean
default: false
description: Return help information.
description: Returns help information.
cat.fielddata::query.s:
name: s
in: query
Expand Down Expand Up @@ -1478,11 +1478,11 @@
cat.health::query.help:
name: help
in: query
description: Return help information.
description: Returns help information.
schema:
type: boolean
default: false
description: Return help information.
description: Returns help information.
cat.health::query.s:
name: s
in: query
Expand Down Expand Up @@ -1544,7 +1544,7 @@
cat.indices::query.expand_wildcards:
in: query
name: expand_wildcards
description: The type of index that wildcard patterns can match.
description: The type of index that wildcard patterns can match. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.

Check failure on line 1547 in spec/namespaces/cat.yaml

View workflow job for this annotation

GitHub Actions / check 

[vale] reported by reviewdog 🐶
[OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'match. Supported'.

Raw Output:
{"message": "[OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'match. Supported'.", "location": {"path": "spec/namespaces/cat.yaml", "range": {"start": {"line": 1547, "column": 65}}}, "severity": "ERROR"}
schema:
$ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards'
style: form
Expand Down Expand Up @@ -1576,11 +1576,11 @@
cat.indices::query.help:
name: help
in: query
description: Return help information.
description: Returns help information.
schema:
type: boolean
default: false
description: Return help information.
description: Returns help information.
cat.indices::query.include_unloaded_segments:
in: query
name: include_unloaded_segments
Expand Down Expand Up @@ -1668,11 +1668,11 @@
cat.master::query.help:
name: help
in: query
description: Return help information.
description: Returns help information.
schema:
type: boolean
default: false
description: Return help information.
description: Returns help information.
cat.master::query.local:
name: local
in: query
Expand Down Expand Up @@ -1737,11 +1737,11 @@
cat.nodeattrs::query.help:
name: help
in: query
description: Return help information.
description: Returns help information.
schema:
type: boolean
default: false
description: Return help information.
description: Returns help information.
cat.nodeattrs::query.local:
name: local
in: query
Expand Down Expand Up @@ -1821,11 +1821,11 @@
cat.nodes::query.help:
name: help
in: query
description: Return help information.
description: Returns help information.
schema:
type: boolean
default: false
description: Return help information.
description: Returns help information.
cat.nodes::query.local:
name: local
in: query
Expand Down Expand Up @@ -1899,11 +1899,11 @@
cat.pending_tasks::query.help:
name: help
in: query
description: Return help information.
description: Returns help information.
schema:
type: boolean
default: false
description: Return help information.
description: Returns help information.
cat.pending_tasks::query.local:
name: local
in: query
Expand Down Expand Up @@ -1973,11 +1973,11 @@
cat.pit_segments::query.help:
name: help
in: query
description: Return help information.
description: Returns help information.
schema:
type: boolean
default: false
description: Return help information.
description: Returns help information.
cat.pit_segments::query.s:
name: s
in: query
Expand Down Expand Up @@ -2025,11 +2025,11 @@
cat.plugins::query.help:
name: help
in: query
description: Return help information.
description: Returns help information.
schema:
type: boolean
default: false
description: Return help information.
description: Returns help information.
cat.plugins::query.local:
name: local
in: query
Expand Down Expand Up @@ -2120,11 +2120,11 @@
cat.recovery::query.help:
name: help
in: query
description: Return help information.
description: Returns help information.
schema:
type: boolean
default: false
description: Return help information.
description: Returns help information.
cat.recovery::query.index:
name: index
in: query
Expand Down Expand Up @@ -2193,11 +2193,11 @@
cat.repositories::query.help:
name: help
in: query
description: Return help information.
description: Returns help information.
schema:
type: boolean
default: false
description: Return help information.
description: Returns help information.
cat.repositories::query.local:
name: local
in: query
Expand Down Expand Up @@ -2288,7 +2288,7 @@
cat.segment_replication::query.expand_wildcards:
name: expand_wildcards
in: query
description: Whether to expand the wildcard expression to include concrete indexes that are open, closed, or both.
description: The type of index that wildcard patterns can match. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards'
cat.segment_replication::query.format:
Expand All @@ -2312,11 +2312,11 @@
cat.segment_replication::query.help:
name: help
in: query
description: Return help information.
description: Returns help information.
schema:
type: boolean
default: false
description: Return help information.
description: Returns help information.
cat.segment_replication::query.ignore_throttled:
name: ignore_throttled
in: query
Expand Down Expand Up @@ -2513,11 +2513,11 @@
cat.shards::query.help:
name: help
in: query
description: Return help information.
description: Returns help information.
schema:
type: boolean
default: false
description: Return help information.
description: Returns help information.
cat.shards::query.local:
name: local
in: query
Expand Down Expand Up @@ -2611,11 +2611,11 @@
cat.snapshots::query.help:
name: help
in: query
description: Return help information.
description: Returns help information.
schema:
type: boolean
default: false
description: Return help information.
description: Returns help information.
cat.snapshots::query.ignore_unavailable:
in: query
name: ignore_unavailable
Expand Down Expand Up @@ -2696,11 +2696,11 @@
cat.tasks::query.help:
name: help
in: query
description: Return help information.
description: Returns help information.
schema:
type: boolean
default: false
description: Return help information.
description: Returns help information.
cat.tasks::query.nodes:
name: nodes
in: query
Expand Down Expand Up @@ -2785,11 +2785,11 @@
cat.templates::query.help:
name: help
in: query
description: Return help information.
description: Returns help information.
schema:
type: boolean
default: false
description: Return help information.
description: Returns help information.
cat.templates::query.local:
name: local
in: query
Expand Down Expand Up @@ -2864,11 +2864,11 @@
cat.thread_pool::query.help:
name: help
in: query
description: Return help information.
description: Returns help information.
schema:
type: boolean
default: false
description: Return help information.
description: Returns help information.
cat.thread_pool::query.local:
name: local
in: query
Expand Down
Loading