Skip to content

Commit 7e2cc7e

Browse files
committed
[DOCS] Edits cluster health parameter descriptions
1 parent 1cd36d6 commit 7e2cc7e

File tree

1 file changed

+25
-12
lines changed

1 file changed

+25
-12
lines changed

specification/cluster/health/ClusterHealthRequest.ts

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -61,61 +61,74 @@ export interface Request extends RequestBase {
6161
]
6262
path_parts: {
6363
/**
64-
* Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (`*`) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or `*`.
64+
* A comma-separated list of data streams, indices, and index aliases that limit the request.
65+
* Wildcard expressions (`*`) are supported.
66+
* To target all data streams and indices in a cluster, omit this parameter or use _all or `*`.
6567
*/
6668
index?: Indices
6769
}
6870
query_parameters: {
6971
/**
70-
* Whether to expand wildcard expression to concrete indices that are open, closed or both.
72+
* Expand wildcard expression to concrete indices that are open, closed or both.
7173
* @server_default all
7274
*/
7375
expand_wildcards?: ExpandWildcards
7476
/**
75-
* Can be one of cluster, indices or shards. Controls the details level of the health information returned.
77+
* Return health information at a specific level of detail.
7678
* @server_default cluster
7779
*/
7880
level?: Level
7981
/**
80-
* If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
82+
* If true, retrieve information from the local node only.
83+
* If false, retrieve information from the master node.
8184
* @server_default false
8285
*/
8386
local?: boolean
8487
/**
85-
* Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
88+
* The period to wait for a connection to the master node.
89+
* If no response is received before the timeout expires, the request fails and returns an error.
8690
* @server_default 30s
8791
*/
8892
master_timeout?: Duration
8993
/**
90-
* Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
94+
* The period to wait for a response.
95+
* If no response is received before the timeout expires, the request fails and returns an error.
9196
* @server_default 30s
9297
*/
9398
timeout?: Duration
9499
/**
95-
* A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait.
100+
* Wait for the specified number of active shards.
101+
* Use `all` to wait for all shards in the cluster to be active.
102+
* Use `0` to not wait.
96103
* @server_default 0
97104
*/
98105
wait_for_active_shards?: WaitForActiveShards
99106
/**
100-
* Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed.
107+
* Wait until all currently queued events with the given priority are processed.
101108
*/
102109
wait_for_events?: WaitForEvents
103110
/**
104-
* The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and <N. Alternatively, it is possible to use ge(N), le(N), gt(N) and lt(N) notation.
111+
* Wait until the specified number (N) of nodes is available.
112+
* It also accepts `>=N`, `<=N`, `>N` and `<N`.
113+
* Alternatively, use the notations `ge(N)`, `le(N)`, `gt(N)`, and `lt(N)`.
105114
*/
106115
wait_for_nodes?: WaitForNodes
107116
/**
108-
* A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards.
117+
* Wait (until the timeout expires) for the cluster to have no shard initializations.
118+
* If false, the request does not wait for initializing shards.
109119
* @server_default false
110120
*/
111121
wait_for_no_initializing_shards?: boolean
112122
/**
113-
* A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards.
123+
* Wait (until the timeout expires) for the cluster to have no shard relocations.
124+
* If false, the request not wait for relocating shards.
114125
* @server_default false
115126
*/
116127
wait_for_no_relocating_shards?: boolean
117128
/**
118-
* One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status.
129+
* Wait (until the timeout expires) for the cluster to reach a specific health status (or a better status).
130+
* A green status is better than yellow and yellow is better than red.
131+
* By default, the request does not wait for a particular status.
119132
*/
120133
wait_for_status?: HealthStatus
121134
}

0 commit comments

Comments
 (0)