Skip to content

Commit 3ecdb0c

Browse files
authored
Update Cat API query descriptions. (#726)
* Update Cat API query descriptions. Signed-off-by: Archer <[email protected]> * Fixes missed description. Signed-off-by: Archer <[email protected]> * Remove space. Signed-off-by: Archer <[email protected]> --------- Signed-off-by: Archer <[email protected]>
1 parent 01f222e commit 3ecdb0c

File tree

1 file changed

+39
-39
lines changed

1 file changed

+39
-39
lines changed

spec/namespaces/cat.yaml

+39-39
Original file line numberDiff line numberDiff line change
@@ -1068,63 +1068,63 @@ components:
10681068
cat.aliases::query.expand_wildcards:
10691069
in: query
10701070
name: expand_wildcards
1071-
description: Whether to expand wildcard expression to concrete indexes that are open, closed or both.
1071+
description: Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
10721072
schema:
10731073
$ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards'
10741074
style: form
10751075
cat.aliases::query.format:
10761076
name: format
10771077
in: query
1078-
description: A short version of the Accept header (for example, `json`, `yaml`).
1078+
description: A short version of the `Accept` header, such as `json` or `yaml`.
10791079
schema:
10801080
type: string
1081-
description: A short version of the Accept header (for example, `json`, `yaml`).
1081+
description: A short version of the `Accept` header, such as `json` or `yaml`.
10821082
cat.aliases::query.h:
10831083
name: h
10841084
in: query
1085-
description: Comma-separated list of column names to display.
1085+
description: A comma-separated list of column names to display.
10861086
style: form
10871087
schema:
10881088
type: array
10891089
items:
10901090
type: string
1091-
description: Comma-separated list of column names to display.
1091+
description: A comma-separated list of column names to display.
10921092
explode: true
10931093
cat.aliases::query.help:
10941094
name: help
10951095
in: query
1096-
description: Return help information.
1096+
description: Returns help information.
10971097
schema:
1098-
description: Return help information.
1098+
description: Returns help information.
10991099
type: boolean
11001100
default: false
11011101
cat.aliases::query.local:
11021102
name: local
11031103
in: query
1104-
description: Return local information, do not retrieve the state from cluster-manager node.
1104+
description: Whether to return information from the local node only instead of from the cluster manager node.
11051105
schema:
11061106
type: boolean
11071107
default: false
1108-
description: Return local information, do not retrieve the state from cluster-manager node.
1108+
description: Whether to return information from the local node only instead of from the cluster manager node.
11091109
cat.aliases::query.s:
11101110
name: s
11111111
in: query
1112-
description: Comma-separated list of column names or column aliases to sort by.
1112+
description: A comma-separated list of column names or column aliases to sort by.
11131113
style: form
11141114
schema:
11151115
type: array
11161116
items:
11171117
type: string
1118-
description: Comma-separated list of column names or column aliases to sort by.
1118+
description: A comma-separated list of column names or column aliases to sort by.
11191119
explode: true
11201120
cat.aliases::query.v:
11211121
name: v
11221122
in: query
1123-
description: Verbose mode. Display column headers.
1123+
description: Enables verbose mode, which displays column headers.
11241124
schema:
11251125
type: boolean
11261126
default: false
1127-
description: Verbose mode. Display column headers.
1127+
description: Enables verbose mode, which displays column headers.
11281128
cat.all_pit_segments::query.bytes:
11291129
name: bytes
11301130
in: query
@@ -1179,63 +1179,63 @@ components:
11791179
cat.allocation::path.node_id:
11801180
in: path
11811181
name: node_id
1182-
description: Comma-separated list of node identifiers or names used to limit the returned information.
1182+
description: A comma-separated list of node IDs or names used to limit the returned information.
11831183
required: true
11841184
schema:
11851185
$ref: '../schemas/_common.yaml#/components/schemas/NodeIds'
11861186
style: simple
11871187
cat.allocation::query.bytes:
11881188
in: query
11891189
name: bytes
1190-
description: The unit used to display byte values.
1190+
description: The units used to display byte values.
11911191
schema:
11921192
$ref: '../schemas/_common.yaml#/components/schemas/ByteUnit'
11931193
style: form
11941194
cat.allocation::query.cluster_manager_timeout:
11951195
name: cluster_manager_timeout
11961196
in: query
1197-
description: Operation timeout for connection to cluster-manager node.
1197+
description: A timeout for connection to the cluster manager node.
11981198
schema:
11991199
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
12001200
x-version-added: '2.0'
12011201
cat.allocation::query.format:
12021202
name: format
12031203
in: query
1204-
description: A short version of the Accept header (for example, `json`, `yaml`).
1204+
description: A short version of the HTTP `Accept` header, such as `json` or `yaml`.
12051205
schema:
12061206
type: string
1207-
description: A short version of the Accept header (for example, `json`, `yaml`).
1207+
description: A short version of the HTTP `Accept` header, such as `json` or `yaml`.
12081208
cat.allocation::query.h:
12091209
name: h
12101210
in: query
1211-
description: Comma-separated list of column names to display.
1211+
description: A comma-separated list of column names to display.
12121212
style: form
12131213
schema:
12141214
type: array
12151215
items:
12161216
type: string
1217-
description: Comma-separated list of column names to display.
1217+
description: A comma-separated list of column names to display.
12181218
explode: true
12191219
cat.allocation::query.help:
12201220
name: help
12211221
in: query
1222-
description: Return help information.
1222+
description: Returns help information.
12231223
schema:
12241224
type: boolean
12251225
default: false
1226-
description: Return help information.
1226+
description: Returns help information.
12271227
cat.allocation::query.local:
12281228
name: local
12291229
in: query
1230-
description: Return local information, do not retrieve the state from cluster-manager node.
1230+
description: Returns local information but does not retrieve the state from cluster-manager node.
12311231
schema:
12321232
type: boolean
12331233
default: false
1234-
description: Return local information, do not retrieve the state from cluster-manager node.
1234+
description: Returns local information but does not retrieve the state from cluster-manager node.
12351235
cat.allocation::query.master_timeout:
12361236
name: master_timeout
12371237
in: query
1238-
description: Operation timeout for connection to cluster-manager node.
1238+
description: A timeout for connection to the cluster manager node.
12391239
schema:
12401240
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
12411241
x-version-deprecated: '2.0'
@@ -1244,46 +1244,46 @@ components:
12441244
cat.allocation::query.s:
12451245
name: s
12461246
in: query
1247-
description: Comma-separated list of column names or column aliases to sort by.
1247+
description: A comma-separated list of column names or column aliases to sort by.
12481248
style: form
12491249
schema:
12501250
type: array
12511251
items:
12521252
type: string
1253-
description: Comma-separated list of column names or column aliases to sort by.
1253+
description: A comma-separated list of column names or column aliases to sort by.
12541254
explode: true
12551255
cat.allocation::query.v:
12561256
name: v
12571257
in: query
1258-
description: Verbose mode. Display column headers.
1258+
description: Enables verbose mode, which displays column headers.
12591259
schema:
12601260
type: boolean
12611261
default: false
1262-
description: Verbose mode. Display column headers.
1262+
description: Enables verbose mode, which displays column headers.
12631263
cat.cluster_manager::query.cluster_manager_timeout:
12641264
name: cluster_manager_timeout
12651265
in: query
1266-
description: Operation timeout for connection to cluster-manager node.
1266+
description: A timeout for connection to the cluster manager node.
12671267
schema:
12681268
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
12691269
x-version-added: '2.0'
12701270
cat.cluster_manager::query.format:
12711271
name: format
12721272
in: query
1273-
description: A short version of the Accept header (for example, `json`, `yaml`).
1273+
description: A short version of the HTTP `Accept` header, such as `json` or `yaml`.
12741274
schema:
12751275
type: string
1276-
description: A short version of the Accept header (for example, `json`, `yaml`).
1276+
description: A short version of the HTTP `Accept` header, such as `json` or `yaml`.
12771277
cat.cluster_manager::query.h:
12781278
name: h
12791279
in: query
1280-
description: Comma-separated list of column names to display.
1280+
description: A comma-separated list of column names to display.
12811281
style: form
12821282
schema:
12831283
type: array
12841284
items:
12851285
type: string
1286-
description: Comma-separated list of column names to display.
1286+
description: A comma-separated list of column names to display.
12871287
explode: true
12881288
cat.cluster_manager::query.help:
12891289
name: help
@@ -1304,7 +1304,7 @@ components:
13041304
cat.cluster_manager::query.master_timeout:
13051305
name: master_timeout
13061306
in: query
1307-
description: Operation timeout for connection to cluster-manager node.
1307+
description: A timeout for connection to the cluster manager node.
13081308
schema:
13091309
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
13101310
x-version-deprecated: '2.0'
@@ -1313,22 +1313,22 @@ components:
13131313
cat.cluster_manager::query.s:
13141314
name: s
13151315
in: query
1316-
description: Comma-separated list of column names or column aliases to sort by.
1316+
description: A comma-separated list of column names or column aliases to sort by.
13171317
style: form
13181318
schema:
13191319
type: array
13201320
items:
13211321
type: string
1322-
description: Comma-separated list of column names or column aliases to sort by.
1322+
description: A comma-separated list of column names or column aliases to sort by.
13231323
explode: true
13241324
cat.cluster_manager::query.v:
13251325
name: v
13261326
in: query
1327-
description: Verbose mode. Display column headers.
1327+
description: Enables verbose mode, which displays column headers.
13281328
schema:
13291329
type: boolean
13301330
default: false
1331-
description: Verbose mode. Display column headers.
1331+
description: Enables verbose mode, which displays column headers.
13321332
cat.count::path.index:
13331333
in: path
13341334
name: index

0 commit comments

Comments
 (0)