diff --git a/_api-reference/cat/cat-cluster_manager.md b/_api-reference/cat/cat-cluster_manager.md index 7599b33258..6081f949a3 100644 --- a/_api-reference/cat/cat-cluster_manager.md +++ b/_api-reference/cat/cat-cluster_manager.md @@ -41,7 +41,7 @@ Parameter | Type | Description | Default `cluster_manager_timeout` | String | A timeout for connection to the cluster manager node. | `format` | String | A short version of the HTTP `Accept` header, such as `json` or `yaml`. | `h` | List | A comma-separated list of column names to display. | -`help` | Boolean | Return help information. | `false` +`help` | Boolean | Returns help information. | `false` `local` | Boolean | Returns local information but does not retrieve the state from the cluster manager node. | `false` `s` | List | A comma-separated list of column names or column aliases to sort by. | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` diff --git a/_api-reference/cat/cat-count.md b/_api-reference/cat/cat-count.md index 055318f42f..152977da30 100644 --- a/_api-reference/cat/cat-count.md +++ b/_api-reference/cat/cat-count.md @@ -42,7 +42,7 @@ Parameter | Type | Description | Default :--- | :--- | :--- | :--- `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | `h` | List | A comma-separated list of column names to display. | -`help` | Boolean | Return help information. | `false` +`help` | Boolean | Returns help information. | `false` `s` | List | A comma-separated list of column names or column aliases to sort by. | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` diff --git a/_api-reference/cat/cat-field-data.md b/_api-reference/cat/cat-field-data.md index aa85998c1e..d01ef8ba3f 100644 --- a/_api-reference/cat/cat-field-data.md +++ b/_api-reference/cat/cat-field-data.md @@ -41,7 +41,7 @@ Parameter | Type | Description | Default `bytes` | String | The units used to display byte values. | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | `h` | List | A comma-separated list of column names to display. | -`help` | Boolean | Return help information. | `false` +`help` | Boolean | Returns help information. | `false` `s` | List | A comma-separated list of column names or column aliases to sort by. | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` diff --git a/_api-reference/cat/cat-health.md b/_api-reference/cat/cat-health.md index 7df6ed4700..841459742a 100644 --- a/_api-reference/cat/cat-health.md +++ b/_api-reference/cat/cat-health.md @@ -40,7 +40,7 @@ Parameter | Type | Description | Default :--- | :--- | :--- | :--- `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | `h` | List | A comma-separated list of column names to display. | -`help` | Boolean | Return help information. | `false` +`help` | Boolean | Returns help information. | `false` `s` | List | A comma-separated list of column names or column aliases to sort by. | `time` | String | The unit used to display time values. | `ts` | Boolean | When `true`, returns `HH:MM:SS` and Unix epoch timestamps. | `true` diff --git a/_api-reference/cat/cat-indices.md b/_api-reference/cat/cat-indices.md index d146716eec..7aade8f959 100644 --- a/_api-reference/cat/cat-indices.md +++ b/_api-reference/cat/cat-indices.md @@ -41,11 +41,11 @@ Parameter | Type | Description | Default :--- | :--- | :--- | :--- `bytes` | String | The units used to display byte values. | `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | -`expand_wildcards` | List or String | The type of index that wildcard patterns can match. | +`expand_wildcards` | List or String | The type of index that wildcard patterns can match. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | `h` | List | A comma-separated list of column names to display. | `health` | String | Limits indexes based on their health status. Supported values are `green`, `yellow`, and `red`. | -`help` | Boolean | Return help information. | `false` +`help` | Boolean | Returns help information. | `false` `include_unloaded_segments` | Boolean | Whether to include information from segments not loaded into memory. | `false` `local` | Boolean | Returns local information but does not retrieve the state from the cluster manager node. | `false` `pri` | Boolean | When `true`, returns information only from the primary shards. | `false` diff --git a/_api-reference/cat/cat-nodeattrs.md b/_api-reference/cat/cat-nodeattrs.md index d3fa2f25e3..229f77f8b6 100644 --- a/_api-reference/cat/cat-nodeattrs.md +++ b/_api-reference/cat/cat-nodeattrs.md @@ -41,7 +41,7 @@ Parameter | Type | Description | Default `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | `h` | List | A comma-separated list of column names to display. | -`help` | Boolean | Return help information. | `false` +`help` | Boolean | Returns help information. | `false` `local` | Boolean | Returns local information but does not retrieve the state from the cluster manager node. | `false` `s` | List | A comma-separated list of column names or column aliases to sort by. | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` diff --git a/_api-reference/cat/cat-nodes.md b/_api-reference/cat/cat-nodes.md index 5fcb25d8ca..50e2dc6de2 100644 --- a/_api-reference/cat/cat-nodes.md +++ b/_api-reference/cat/cat-nodes.md @@ -45,7 +45,7 @@ Parameter | Type | Description | Default `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | `full_id` | Boolean or String | When `true`, returns the full node ID. When `false`, returns the shortened node ID. | `false` `h` | List | A comma-separated list of column names to display. | -`help` | Boolean | Return help information. | `false` +`help` | Boolean | Returns help information. | `false` `s` | List | A comma-separated list of column names or column aliases to sort by. | `time` | String | Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` diff --git a/_api-reference/cat/cat-pending-tasks.md b/_api-reference/cat/cat-pending-tasks.md index 230820a76b..7a7222dcb1 100644 --- a/_api-reference/cat/cat-pending-tasks.md +++ b/_api-reference/cat/cat-pending-tasks.md @@ -41,7 +41,7 @@ Parameter | Type | Description | Default `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | `h` | List | A comma-separated list of column names to display. | -`help` | Boolean | Return help information. | `false` +`help` | Boolean | Returns help information. | `false` `local` | Boolean | Returns local information but does not retrieve the state from the cluster manager node. | `false` `s` | List | A comma-separated list of column names or column aliases to sort by. | `time` | String | Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). | diff --git a/_api-reference/cat/cat-pit-segments.md b/_api-reference/cat/cat-pit-segments.md index 80f659a5c1..a7a64e842e 100644 --- a/_api-reference/cat/cat-pit-segments.md +++ b/_api-reference/cat/cat-pit-segments.md @@ -47,7 +47,7 @@ Parameter | Type | Description | Default `bytes` | String | The units used to display byte values. | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | `h` | List | A comma-separated list of column names to display. | -`help` | Boolean | Return help information. | `false` +`help` | Boolean | Returns help information. | `false` `s` | List | A comma-separated list of column names or column aliases to sort by. | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` diff --git a/_api-reference/cat/cat-plugins.md b/_api-reference/cat/cat-plugins.md index 6df3d570d7..012ed0dfd8 100644 --- a/_api-reference/cat/cat-plugins.md +++ b/_api-reference/cat/cat-plugins.md @@ -40,7 +40,7 @@ Parameter | Type | Description | Default `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | `h` | List | A comma-separated list of column names to display. | -`help` | Boolean | Return help information. | `false` +`help` | Boolean | Returns help information. | `false` `local` | Boolean | Returns local information but does not retrieve the state from the cluster manager node. | `false` `s` | List | A comma-separated list of column names or column aliases to sort by. | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` diff --git a/_api-reference/cat/cat-recovery.md b/_api-reference/cat/cat-recovery.md index 74d14124d9..aab281d983 100644 --- a/_api-reference/cat/cat-recovery.md +++ b/_api-reference/cat/cat-recovery.md @@ -44,7 +44,7 @@ Parameter | Type | Description | Default `detailed` | Boolean | When `true`, includes detailed information about shard recoveries. | `false` `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | `h` | List | A comma-separated list of column names to display. | -`help` | Boolean | Return help information. | `false` +`help` | Boolean | Returns help information. | `false` `s` | List | A comma-separated list of column names or column aliases to sort by. | `time` | String | Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` diff --git a/_api-reference/cat/cat-repositories.md b/_api-reference/cat/cat-repositories.md index 77a0c9e3e1..c25235a4f4 100644 --- a/_api-reference/cat/cat-repositories.md +++ b/_api-reference/cat/cat-repositories.md @@ -40,7 +40,7 @@ Parameter | Type | Description | Default `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | `h` | List | A comma-separated list of column names to display. | -`help` | Boolean | Return help information. | `false` +`help` | Boolean | Returns help information. | `false` `local` | Boolean | Returns local information but does not retrieve the state from the cluster manager node. | `false` `s` | List | A comma-separated list of column names or column aliases to sort by. | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` diff --git a/_api-reference/cat/cat-segment-replication.md b/_api-reference/cat/cat-segment-replication.md index 2d23e9fa07..74235e881c 100644 --- a/_api-reference/cat/cat-segment-replication.md +++ b/_api-reference/cat/cat-segment-replication.md @@ -57,10 +57,10 @@ Parameter | Type | Description | Default `bytes` | String | The units used to display byte values. | `completed_only` | Boolean | When `true`, the response only includes the last-completed segment replication events. | `false` `detailed` | Boolean | When `true`, the response includes additional metrics for each stage of a segment replication event. | `false` -`expand_wildcards` | List or String | Whether to expand the wildcard expression to include concrete indexes that are open, closed, or both. | +`expand_wildcards` | List or String | The type of index that wildcard patterns can match. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | `h` | List | A comma-separated list of column names to display. | -`help` | Boolean | Return help information. | `false` +`help` | Boolean | Returns help information. | `false` `ignore_throttled` | Boolean | Whether specified concrete, expanded, or aliased indexes should be ignored when throttled. | `ignore_unavailable` | Boolean | Whether the specified concrete indexes should be ignored when missing or closed. | `s` | List | A comma-separated list of column names or column aliases to sort by. | diff --git a/_api-reference/cat/cat-shards.md b/_api-reference/cat/cat-shards.md index 8d441c8c2a..ef270ee999 100644 --- a/_api-reference/cat/cat-shards.md +++ b/_api-reference/cat/cat-shards.md @@ -43,7 +43,7 @@ Parameter | Type | Description | Default `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | `h` | List | A comma-separated list of column names to display. | -`help` | Boolean | Return help information. | `false` +`help` | Boolean | Returns help information. | `false` `local` | Boolean | Returns local information but does not retrieve the state from the cluster manager node. | `false` `s` | List | A comma-separated list of column names or column aliases to sort by. | `time` | String | Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). | diff --git a/_api-reference/cat/cat-snapshots.md b/_api-reference/cat/cat-snapshots.md index 4468e47c55..9aa16f2916 100644 --- a/_api-reference/cat/cat-snapshots.md +++ b/_api-reference/cat/cat-snapshots.md @@ -42,7 +42,7 @@ Parameter | Type | Description | Default `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | `h` | List | A comma-separated list of column names to display. | -`help` | Boolean | Return help information. | `false` +`help` | Boolean | Returns help information. | `false` `ignore_unavailable` | Boolean | When `true`, the response does not include information from unavailable snapshots. | `false` `s` | List | A comma-separated list of column names or column aliases to sort by. | `time` | String | Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). | diff --git a/_api-reference/cat/cat-tasks.md b/_api-reference/cat/cat-tasks.md index 29dc1dd601..1b67e9cdc2 100644 --- a/_api-reference/cat/cat-tasks.md +++ b/_api-reference/cat/cat-tasks.md @@ -41,7 +41,7 @@ Parameter | Type | Description | Default `detailed` | Boolean | If `true`, the response includes detailed information about shard recoveries. | `false` `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | `h` | List | A comma-separated list of column names to display. | -`help` | Boolean | Return help information. | `false` +`help` | Boolean | Returns help information. | `false` `nodes` | List | A comma-separated list of node IDs or names used to limit the returned information. Use `_local` to return information from the node to which you're connecting, specify a specific node from which to get information, or keep the parameter empty to get information from all nodes. | `parent_task_id` | String | The parent task identifier, which is used to limit the response. | `s` | List | A comma-separated list of column names or column aliases to sort by. | diff --git a/_api-reference/cat/cat-templates.md b/_api-reference/cat/cat-templates.md index 95b4aae3b9..b9d4a58e0a 100644 --- a/_api-reference/cat/cat-templates.md +++ b/_api-reference/cat/cat-templates.md @@ -42,7 +42,7 @@ Parameter | Type | Description | Default `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | `h` | List | A comma-separated list of column names to display. | -`help` | Boolean | Return help information. | `false` +`help` | Boolean | Returns help information. | `false` `local` | Boolean | Returns local information but does not retrieve the state from the cluster manager node. | `false` `s` | List | A comma-separated list of column names or column aliases to sort by. | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` diff --git a/_api-reference/cat/cat-thread-pool.md b/_api-reference/cat/cat-thread-pool.md index 75c92b5795..82d49e5126 100644 --- a/_api-reference/cat/cat-thread-pool.md +++ b/_api-reference/cat/cat-thread-pool.md @@ -42,7 +42,7 @@ Parameter | Type | Description | Default `cluster_manager_timeout` | String | A timeout for connection to the cluster manager node. | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | `h` | List | A comma-separated list of column names to display. | -`help` | Boolean | Return help information. | `false` +`help` | Boolean | Returns help information. | `false` `local` | Boolean | Returns local information but does not retrieve the state from the cluster manager node. | `false` `s` | List | A comma-separated list of column names or column aliases to sort by. | `size` | Integer | The multiplier in which to display values. |