Skip to content

Commit

Permalink
Add updated tables.
Browse files Browse the repository at this point in the history
Signed-off-by: Archer <[email protected]>
  • Loading branch information
Naarcha-AWS committed Jan 13, 2025
1 parent a4358fb commit 1aea840
Show file tree
Hide file tree
Showing 18 changed files with 20 additions and 20 deletions.
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-cluster_manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-count.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
<!-- spec_insert_end -->
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-field-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
<!-- spec_insert_end -->
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-health.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
4 changes: 2 additions & 2 deletions _api-reference/cat/cat-indices.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-nodeattrs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-pending-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/). |
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-pit-segments.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
<!-- spec_insert_end -->
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-recovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-repositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
4 changes: 2 additions & 2 deletions _api-reference/cat/cat-segment-replication.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-shards.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/). |
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-snapshots.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/). |
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-thread-pool.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand Down

0 comments on commit 1aea840

Please sign in to comment.