From f95be66cee69e45a9f065320c9e709e47318ab3f Mon Sep 17 00:00:00 2001 From: Archer Date: Thu, 9 Jan 2025 11:57:41 -0600 Subject: [PATCH 01/32] Add CAT API automation Signed-off-by: Archer --- _api-reference/cat/cat-cluster_manager.md | 34 ++++++-- _api-reference/cat/cat-count.md | 27 ++++++- _api-reference/cat/cat-field-data.md | 31 ++++++-- _api-reference/cat/cat-health.md | 31 ++++++-- _api-reference/cat/cat-indices.md | 43 ++++++---- _api-reference/cat/cat-nodeattrs.md | 30 +++++-- _api-reference/cat/cat-nodes.md | 39 ++++++---- _api-reference/cat/cat-pending-tasks.md | 33 +++++--- _api-reference/cat/cat-pit-segments.md | 78 +++++++++++++++++++ _api-reference/cat/cat-plugins.md | 38 +++++---- _api-reference/cat/cat-recovery.md | 36 ++++++--- _api-reference/cat/cat-repositories.md | 32 +++++--- _api-reference/cat/cat-segment-replication.md | 48 +++++++++++- _api-reference/cat/cat-segments.md | 32 ++++++-- _api-reference/cat/cat-shards.md | 41 ++++++---- _api-reference/cat/cat-snapshots.md | 33 ++++++-- _api-reference/cat/cat-tasks.md | 36 ++++++--- _api-reference/cat/cat-templates.md | 32 ++++++-- _api-reference/cat/cat-thread-pool.md | 32 ++++++-- 19 files changed, 545 insertions(+), 161 deletions(-) create mode 100644 _api-reference/cat/cat-pit-segments.md diff --git a/_api-reference/cat/cat-cluster_manager.md b/_api-reference/cat/cat-cluster_manager.md index 2cdb27d218..7ab91462ab 100644 --- a/_api-reference/cat/cat-cluster_manager.md +++ b/_api-reference/cat/cat-cluster_manager.md @@ -15,19 +15,37 @@ has_children: false The CAT cluster manager operation lists information that helps identify the elected cluster manager node. + ## Endpoints - ```json -GET _cat/cluster_manager +GET /_cat/cluster_manager ``` + -## Query parameters - -Parameter | Type | Description -:--- | :--- | :--- -cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds. -## Example requests + +## Query parameters +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` +`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` + + + +## Example request ``` GET _cat/cluster_manager?v diff --git a/_api-reference/cat/cat-count.md b/_api-reference/cat/cat-count.md index fa50ce1d0f..d20c732e50 100644 --- a/_api-reference/cat/cat-count.md +++ b/_api-reference/cat/cat-count.md @@ -16,12 +16,33 @@ redirect_from: The CAT count operation lists the number of documents in your cluster. + ## Endpoints - ```json -GET _cat/count?v -GET _cat/count/?v +GET /_cat/count +GET /_cat/count/{index} ``` + + + + +## Query parameters +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` +`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` + ## Example requests diff --git a/_api-reference/cat/cat-field-data.md b/_api-reference/cat/cat-field-data.md index 4a7e30642f..4a3291c490 100644 --- a/_api-reference/cat/cat-field-data.md +++ b/_api-reference/cat/cat-field-data.md @@ -14,19 +14,34 @@ redirect_from: The CAT Field Data operation lists the memory size used by each field per node. - + ## Endpoints - ```json -GET _cat/fielddata?v -GET _cat/fielddata/?v +GET /_cat/fielddata +GET /_cat/fielddata/{fields} ``` + -## Query parameters -Parameter | Type | Description -:--- | :--- | :--- -bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/). + +## Query parameters +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` +`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` + ## Example requests diff --git a/_api-reference/cat/cat-health.md b/_api-reference/cat/cat-health.md index 49bdec3b0a..b0826e0c30 100644 --- a/_api-reference/cat/cat-health.md +++ b/_api-reference/cat/cat-health.md @@ -2,7 +2,6 @@ layout: default title: CAT health parent: CAT API - nav_order: 20 has_children: false redirect_from: @@ -16,18 +15,34 @@ redirect_from: The CAT health operation lists the status of the cluster, how long the cluster has been up, the number of nodes, and other useful information that helps you analyze the health of your cluster. + ## Endpoints - ```json -GET _cat/health?v +GET /_cat/health ``` + -## Query parameters -Parameter | Type | Description -:--- | :--- | :--- -time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/). -ts | Boolean | If true, returns HH:MM:SS and Unix epoch timestamps. Default is `true`. + +## Query parameters +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` +`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` +`v` | Boolean | Enables verbose mode, which displays column headers. | `false` + ## Example request diff --git a/_api-reference/cat/cat-indices.md b/_api-reference/cat/cat-indices.md index c061c8fa17..a653d5ddad 100644 --- a/_api-reference/cat/cat-indices.md +++ b/_api-reference/cat/cat-indices.md @@ -15,24 +15,41 @@ redirect_from: The CAT indices operation lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on. + ## Endpoints - ```json -GET _cat/indices/ -GET _cat/indices +GET /_cat/indices +GET /_cat/indices/{index} ``` + -## Query parameters -Parameter | Type | Description -:--- | :--- | :--- -bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/). -health | String | Limit indexes based on their health status. Supported values are `green`, `yellow`, and `red`. -include_unloaded_segments | Boolean | Whether to include information from segments not loaded into memory. Default is `false`. -cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds. -pri | Boolean | Whether to return information only from the primary shards. Default is `false`. -time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/). -expand_wildcards | Enum | Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. Default is `open`. + +## Query parameters +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. | +`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` +`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` +`s` | List | A comma-separated list of column names or column aliases to sort by. | +`time` | String | Specifies the time units. | +`v` | Boolean | Enables verbose mode, which displays column headers. | `false` + ## Example requests diff --git a/_api-reference/cat/cat-nodeattrs.md b/_api-reference/cat/cat-nodeattrs.md index 1aa4f32640..7286c46688 100644 --- a/_api-reference/cat/cat-nodeattrs.md +++ b/_api-reference/cat/cat-nodeattrs.md @@ -15,18 +15,34 @@ redirect_from: The CAT nodeattrs operation lists the attributes of custom nodes. + ## Endpoints - ```json -GET _cat/nodeattrs +GET /_cat/nodeattrs ``` + -## Query parameters -Parameter | Type | Description -:--- | :--- | :--- -local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is `false`. -cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds. + +## Query parameters +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` +`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` + ## Example request diff --git a/_api-reference/cat/cat-nodes.md b/_api-reference/cat/cat-nodes.md index 1a892ab0d9..adc7332880 100644 --- a/_api-reference/cat/cat-nodes.md +++ b/_api-reference/cat/cat-nodes.md @@ -17,25 +17,36 @@ The CAT nodes operation lists node-level information, including node roles and l A few important node metrics are `pid`, `name`, `cluster_manager`, `ip`, `port`, `version`, `build`, `jdk`, along with `disk`, `heap`, `ram`, and `file_desc`. + ## Endpoints - ```json -GET _cat/nodes +GET /_cat/nodes ``` + -## Query parameters - -All CAT nodes URL parameters are optional. -In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters: - -Parameter | Type | Description -:--- | :--- | :--- -bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/). -full_id | Boolean | If true, return the full node ID. If false, return the shortened node ID. Defaults to false. -cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds. -time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/). -include_unloaded_segments | Boolean | Whether to include information from segments not loaded into memory. Default is `false`. + +## Query parameters +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. | +`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` +`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` + ## Example request diff --git a/_api-reference/cat/cat-pending-tasks.md b/_api-reference/cat/cat-pending-tasks.md index 370ed09597..03c44d0074 100644 --- a/_api-reference/cat/cat-pending-tasks.md +++ b/_api-reference/cat/cat-pending-tasks.md @@ -2,7 +2,6 @@ layout: default title: CAT pending tasks parent: CAT API - nav_order: 45 has_children: false redirect_from: @@ -16,19 +15,35 @@ redirect_from: The CAT pending tasks operation lists the progress of all pending tasks, including task priority and time in queue. + ## Endpoints - ```json -GET _cat/pending_tasks +GET /_cat/pending_tasks ``` + -## Query parameters -Parameter | Type | Description -:--- | :--- | :--- -local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is `false`. -cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds. -time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/). + +## Query parameters +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` +`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/). | +`v` | Boolean | Enables verbose mode, which displays column headers. | `false` + ## Example request diff --git a/_api-reference/cat/cat-pit-segments.md b/_api-reference/cat/cat-pit-segments.md new file mode 100644 index 0000000000..d9ed8ee9b3 --- /dev/null +++ b/_api-reference/cat/cat-pit-segments.md @@ -0,0 +1,78 @@ +--- +layout: default +title: CAT PIT segments +parent: CAT API +nav_order: 46 +--- + +# CAT PIT segments + +The CAT point-in-time (PIT) segments operation returns information about one or more PIT segments. + +## Endpoints + + +```json +GET /_cat/pit_segments +``` + + + +```json +GET /_cat/pit_segments/_all +``` + + + +## Query parameters +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` +`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` + + +## Request body fields + +Field | Data type | Description +:--- | :--- | :--- +pit_id | [Base64 encoded binary]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/binary) or an array of binaries | The PIT IDs of the PITs whose segments are to be listed. Required. + +## Example request + +```json +GET /_cat/pit_segments + +{ + "pit_id": [ + "o463QQEPbXktaW5kZXgtMDAwMDAxFkhGN09fMVlPUkVPLXh6MUExZ1hpaEEAFjBGbmVEZHdGU1EtaFhhUFc4ZkR5cWcAAAAAAAAAAAEWaXBPNVJtZEhTZDZXTWFFR05waXdWZwEWSEY3T18xWU9SRU8teHoxQTFnWGloQQAA", + "o463QQEPbXktaW5kZXgtMDAwMDAxFkhGN09fMVlPUkVPLXh6MUExZ1hpaEEAFjBGbmVEZHdGU1EtaFhhUFc4ZkR5cWcAAAAAAAAAAAIWaXBPNVJtZEhTZDZXTWFFR05waXdWZwEWSEY3T18xWU9SRU8teHoxQTFnWGloQQAA" + ] +} +``` + +## Example response + +```json +index shard prirep ip segment generation docs.count docs.deleted size size.memory committed searchable version compound +index1 0 r 10.212.36.190 _0 0 4 0 3.8kb 1364 false true 8.8.2 true +index1 1 p 10.212.36.190 _0 0 3 0 3.7kb 1364 false true 8.8.2 true +index1 2 r 10.212.74.139 _0 0 2 0 3.6kb 1364 false true 8.8.2 true +``` + diff --git a/_api-reference/cat/cat-plugins.md b/_api-reference/cat/cat-plugins.md index f4e540be14..588f6d0ff6 100644 --- a/_api-reference/cat/cat-plugins.md +++ b/_api-reference/cat/cat-plugins.md @@ -2,7 +2,6 @@ layout: default title: CAT plugins parent: CAT API - nav_order: 50 has_children: false redirect_from: @@ -15,25 +14,36 @@ redirect_from: The CAT plugins operation lists the names, components, and versions of the installed plugins. - + ## Endpoints - ```json -GET _cat/plugins +GET /_cat/plugins ``` + -## Query parameters -All parameters are optional. - -In addition to the [common parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters: - -Parameter | Type | Description -:--- | :--- | :--- -local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is `false`. -cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds. + +## Query parameters +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` +`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` + -## Example requests +## Example request The following example request lists all installed plugins: diff --git a/_api-reference/cat/cat-recovery.md b/_api-reference/cat/cat-recovery.md index f568fa46b3..ec9010af85 100644 --- a/_api-reference/cat/cat-recovery.md +++ b/_api-reference/cat/cat-recovery.md @@ -2,7 +2,6 @@ layout: default title: CAT recovery parent: CAT API - nav_order: 50 has_children: false redirect_from: @@ -16,20 +15,37 @@ redirect_from: The CAT recovery operation lists all completed and ongoing index and shard recoveries. + ## Endpoints - ```json -GET _cat/recovery +GET /_cat/recovery +GET /_cat/recovery/{index} ``` + -## Query parameters -Parameter | Type | Description -:--- | :--- | :--- -active_only | Boolean | Whether to only include ongoing shard recoveries. Default is `false`. -bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/). -detailed | Boolean | Whether to include detailed information about shard recoveries. Default is `false`. -time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/). + +## Query parameters +Parameter | Type | Description | Default +:--- | :--- | :--- | :--- +`active_only` | Boolean | If `true`, the response only includes ongoing shard recoveries. | `false` +`bytes` | String | The units used to display byte values. | +`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` +`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` + ## Example requests diff --git a/_api-reference/cat/cat-repositories.md b/_api-reference/cat/cat-repositories.md index fb7bb9a78c..9c331bdcd3 100644 --- a/_api-reference/cat/cat-repositories.md +++ b/_api-reference/cat/cat-repositories.md @@ -2,7 +2,6 @@ layout: default title: CAT repositories parent: CAT API - nav_order: 52 has_children: false redirect_from: @@ -15,19 +14,34 @@ redirect_from: The CAT repositories operation lists all snapshot repositories for a cluster. + ## Endpoints - ```json -GET _cat/repositories +GET /_cat/repositories ``` + -## Query parameters - -Parameter | Type | Description -:--- | :--- | :--- -local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is `false`. -cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds. + +## Query parameters +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` +`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` + ## Example request diff --git a/_api-reference/cat/cat-segment-replication.md b/_api-reference/cat/cat-segment-replication.md index ba1a5dd67e..d0d2e04fb6 100644 --- a/_api-reference/cat/cat-segment-replication.md +++ b/_api-reference/cat/cat-segment-replication.md @@ -15,12 +15,56 @@ The CAT segment replication operation returns information about active and last Call the CAT Segment Replication API only on indexes with segment replication enabled. {: .note} + ## Endpoints - ```json GET /_cat/segment_replication -GET /_cat/segment_replication/ +GET /_cat/segment_replication/{index} ``` + + + +## Path parameters +Parameter | Type | Description +:--- | :--- | :--- +`index` | List | A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. + + + + +## Query parameters +Parameter | Type | Description | Default +:--- | :--- | :--- | :--- +`active_only` | Boolean | When `true`, the response only includes ongoing segment replication events. | `false` +`allow_no_indices` | Boolean | Whether to ignore the index if a wildcard index expression resolves to no concrete indexes. This includes the `_all` string or when no indexes have been specified. | +`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. | +`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` +`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. | +`shards` | List | A comma-separated list of shards to display. | +`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/). | +`timeout` | String | The operation timeout. | +`v` | Boolean | Enables verbose mode, which displays column headers. | `false` + ## Path parameters diff --git a/_api-reference/cat/cat-segments.md b/_api-reference/cat/cat-segments.md index 7ed54f646b..c25f28bc57 100644 --- a/_api-reference/cat/cat-segments.md +++ b/_api-reference/cat/cat-segments.md @@ -2,7 +2,6 @@ layout: default title: CAT segments parent: CAT API - nav_order: 55 has_children: false redirect_from: @@ -16,18 +15,35 @@ redirect_from: The cat segments operation lists Lucene segment-level information for each index. + ## Endpoints - ```json -GET _cat/segments +GET /_cat/segments +GET /_cat/segments/{index} ``` + -## Query parameters -Parameter | Type | Description -:--- | :--- | :--- -bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).. -cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds. + +## Query parameters +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. | +`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 | 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` + ## Example requests diff --git a/_api-reference/cat/cat-shards.md b/_api-reference/cat/cat-shards.md index 800eaa66d3..a38e526756 100644 --- a/_api-reference/cat/cat-shards.md +++ b/_api-reference/cat/cat-shards.md @@ -2,7 +2,6 @@ layout: default title: CAT shards parent: CAT API - nav_order: 60 has_children: false redirect_from: @@ -16,25 +15,37 @@ redirect_from: The CAT shards operation lists the state of all primary and replica shards and how they are distributed. + ## Endpoints - ```json -GET _cat/shards +GET /_cat/shards +GET /_cat/shards/{index} ``` + -## Query parameters - -All parameters are optional. - -In addition to the [common parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters: -Parameter | Type | Description -:--- | :--- | :--- -bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/). -local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is `false`. -cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds. -cancel_after_time_interval | Time | The amount of time after which the shard request will be canceled. Default is `-1`. -time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/). + +## Query parameters +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. | +`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` +`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/). | +`v` | Boolean | Enables verbose mode, which displays column headers. | `false` + ## Example requests diff --git a/_api-reference/cat/cat-snapshots.md b/_api-reference/cat/cat-snapshots.md index 9fd5394779..55d6b84b51 100644 --- a/_api-reference/cat/cat-snapshots.md +++ b/_api-reference/cat/cat-snapshots.md @@ -2,7 +2,6 @@ layout: default title: CAT snapshots parent: CAT API - nav_order: 65 has_children: false redirect_from: @@ -16,18 +15,36 @@ redirect_from: The CAT snapshots operation lists all snapshots for a repository. + ## Endpoints - ```json -GET _cat/snapshots +GET /_cat/snapshots +GET /_cat/snapshots/{repository} ``` + -## Query parameters -Parameter | Type | Description -:--- | :--- | :--- -cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds. -time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/). + +## Query parameters +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` +`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/). | +`v` | Boolean | Enables verbose mode, which displays column headers. | `false` + ## Example request diff --git a/_api-reference/cat/cat-tasks.md b/_api-reference/cat/cat-tasks.md index 4b2de14e40..ee00b81ac5 100644 --- a/_api-reference/cat/cat-tasks.md +++ b/_api-reference/cat/cat-tasks.md @@ -2,7 +2,6 @@ layout: default title: CAT tasks parent: CAT API - nav_order: 70 has_children: false redirect_from: @@ -15,20 +14,37 @@ redirect_from: The CAT tasks operation lists the progress of all tasks currently running on your cluster. + ## Endpoints - ```json -GET _cat/tasks +GET /_cat/tasks ``` + -## Query parameters -Parameter | Type | Description -:--- | :--- | :--- -nodes | List | A comma-separated list of node IDs or names to limit the returned information. Use `_local` to return information from the node you're connecting to, specify the node name to get information from specific nodes, or keep the parameter empty to get information from all nodes. -detailed | Boolean | Returns detailed task information. (Default: false) -parent_task_id | String | Returns tasks with a specified parent task ID (node_id:task_number). Keep empty or set to -1 to return all. -time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/). + +## Query parameters +Parameter | Type | Description | Default +:--- | :--- | :--- | :--- +`actions` | List | The task action names used to limit the response. | +`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` +`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. | +`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` + ## Example request diff --git a/_api-reference/cat/cat-templates.md b/_api-reference/cat/cat-templates.md index 5570094058..1d04c27b93 100644 --- a/_api-reference/cat/cat-templates.md +++ b/_api-reference/cat/cat-templates.md @@ -2,7 +2,6 @@ layout: default title: CAT templates parent: CAT API - nav_order: 70 has_children: false redirect_from: @@ -16,18 +15,35 @@ redirect_from: The CAT templates operation lists the names, patterns, order numbers, and version numbers of index templates. + ## Endpoints - ```json -GET _cat/templates +GET /_cat/templates +GET /_cat/templates/{name} ``` + -## Query parameters -Parameter | Type | Description -:--- | :--- | :--- -local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is `false`. -cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds. + +## Query parameters +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` +`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` + ## Example requests diff --git a/_api-reference/cat/cat-thread-pool.md b/_api-reference/cat/cat-thread-pool.md index 39df7a2010..a3ec9736c8 100644 --- a/_api-reference/cat/cat-thread-pool.md +++ b/_api-reference/cat/cat-thread-pool.md @@ -15,18 +15,36 @@ redirect_from: The CAT thread pool operation lists the active, queued, and rejected threads of different thread pools on each node. + ## Endpoints - ```json -GET _cat/thread_pool +GET /_cat/thread_pool +GET /_cat/thread_pool/{thread_pool_patterns} ``` + -## Query parameters -Parameter | Type | Description -:--- | :--- | :--- -local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is `false`. -cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds. + +## Query parameters +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` +`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. | +`v` | Boolean | Enables verbose mode, which displays column headers. | `false` + ## Example requests From ba94920c8f1ff3ce7c3ca2827c1560042afda649 Mon Sep 17 00:00:00 2001 From: Archer Date: Thu, 9 Jan 2025 12:03:29 -0600 Subject: [PATCH 02/32] Add CAT API reference Signed-off-by: Archer --- _api-reference/cat/cat-pit-segments.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_api-reference/cat/cat-pit-segments.md b/_api-reference/cat/cat-pit-segments.md index d9ed8ee9b3..a946cf0d32 100644 --- a/_api-reference/cat/cat-pit-segments.md +++ b/_api-reference/cat/cat-pit-segments.md @@ -52,7 +52,7 @@ Parameter | Type | Description | Default Field | Data type | Description :--- | :--- | :--- -pit_id | [Base64 encoded binary]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/binary) or an array of binaries | The PIT IDs of the PITs whose segments are to be listed. Required. +pit_id | [Base64 encoded binary]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/binary/) or an array of binaries | The PIT IDs of the PITs whose segments are to be listed. Required. ## Example request From 7a45d1d13b27ebd3ac78257fd1b7f83e45dbd1b3 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Thu, 9 Jan 2025 13:58:39 -0600 Subject: [PATCH 03/32] Update cat-pit-segments.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- _api-reference/cat/cat-pit-segments.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_api-reference/cat/cat-pit-segments.md b/_api-reference/cat/cat-pit-segments.md index a946cf0d32..0b20eb8130 100644 --- a/_api-reference/cat/cat-pit-segments.md +++ b/_api-reference/cat/cat-pit-segments.md @@ -58,7 +58,6 @@ pit_id | [Base64 encoded binary]({{site.url}}{{site.baseurl}}/opensearch/support ```json GET /_cat/pit_segments - { "pit_id": [ "o463QQEPbXktaW5kZXgtMDAwMDAxFkhGN09fMVlPUkVPLXh6MUExZ1hpaEEAFjBGbmVEZHdGU1EtaFhhUFc4ZkR5cWcAAAAAAAAAAAEWaXBPNVJtZEhTZDZXTWFFR05waXdWZwEWSEY3T18xWU9SRU8teHoxQTFnWGloQQAA", @@ -66,6 +65,7 @@ GET /_cat/pit_segments ] } ``` +{% include copy.html %} ## Example response From 2e56e27a27399233e534fe5bf8524adeb94b9460 Mon Sep 17 00:00:00 2001 From: Archer Date: Thu, 9 Jan 2025 14:32:08 -0600 Subject: [PATCH 04/32] Fix mustache template Signed-off-by: Archer --- _api-reference/cat/cat-aliases.md | 4 ++++ _api-reference/cat/cat-allocation.md | 4 ++++ _api-reference/cat/cat-cluster_manager.md | 4 ++++ _api-reference/cat/cat-count.md | 4 ++++ _api-reference/cat/cat-field-data.md | 4 ++++ _api-reference/cat/cat-health.md | 4 ++++ _api-reference/cat/cat-indices.md | 4 ++++ _api-reference/cat/cat-nodeattrs.md | 4 ++++ _api-reference/cat/cat-nodes.md | 4 ++++ _api-reference/cat/cat-pending-tasks.md | 4 ++++ _api-reference/cat/cat-pit-segments.md | 5 +++++ _api-reference/cat/cat-plugins.md | 4 ++++ _api-reference/cat/cat-recovery.md | 4 ++++ _api-reference/cat/cat-repositories.md | 4 ++++ _api-reference/cat/cat-segment-replication.md | 5 +++++ _api-reference/cat/cat-segments.md | 4 ++++ _api-reference/cat/cat-shards.md | 4 ++++ _api-reference/cat/cat-snapshots.md | 4 ++++ _api-reference/cat/cat-tasks.md | 4 ++++ _api-reference/cat/cat-templates.md | 4 ++++ _api-reference/cat/cat-thread-pool.md | 4 ++++ .../workload-management/query-group-lifecycle-api.md | 4 ++++ .../lib/renderers/templates/endpoints.mustache | 1 + .../lib/renderers/templates/path_parameters.mustache | 1 + .../renderers/templates/query_parameters.mustache | 3 +++ .../spec/_fixtures/expected_output/endpoints.md | 2 ++ .../spec/_fixtures/expected_output/param_tables.md | 12 +++++++----- 27 files changed, 104 insertions(+), 5 deletions(-) diff --git a/_api-reference/cat/cat-aliases.md b/_api-reference/cat/cat-aliases.md index 9913100d0d..54fd94b9bd 100644 --- a/_api-reference/cat/cat-aliases.md +++ b/_api-reference/cat/cat-aliases.md @@ -22,6 +22,7 @@ api: cat.aliases component: endpoints --> ## Endpoints + ```json GET /_cat/aliases GET /_cat/aliases/{name} @@ -36,6 +37,9 @@ columns: Parameter,Type,Description,Default include_deprecated: false --> ## Query parameters + + + Parameter | Type | Description | Default :--- | :--- | :--- | :--- `expand_wildcards` | List or String | Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. | diff --git a/_api-reference/cat/cat-allocation.md b/_api-reference/cat/cat-allocation.md index 933537bcbb..f34accc607 100644 --- a/_api-reference/cat/cat-allocation.md +++ b/_api-reference/cat/cat-allocation.md @@ -21,6 +21,7 @@ api: cat.allocation component: endpoints --> ## Endpoints + ```json GET /_cat/allocation GET /_cat/allocation/{node_id} @@ -35,6 +36,9 @@ columns: Parameter,Type,Description,Default include_deprecated: false --> ## Query parameters + + + Parameter | Type | Description | Default :--- | :--- | :--- | :--- `bytes` | String | The units used to display byte values. | diff --git a/_api-reference/cat/cat-cluster_manager.md b/_api-reference/cat/cat-cluster_manager.md index 7ab91462ab..f3902a8612 100644 --- a/_api-reference/cat/cat-cluster_manager.md +++ b/_api-reference/cat/cat-cluster_manager.md @@ -20,6 +20,7 @@ api: cat.cluster_manager component: endpoints --> ## Endpoints + ```json GET /_cat/cluster_manager ``` @@ -33,6 +34,9 @@ columns: Parameter,Type,Description,Default include_deprecated: false --> ## Query parameters + + + Parameter | Type | Description | Default :--- | :--- | :--- | :--- `cluster_manager_timeout` | String | A timeout for connection to the cluster manager node. | diff --git a/_api-reference/cat/cat-count.md b/_api-reference/cat/cat-count.md index d20c732e50..dfafc8beee 100644 --- a/_api-reference/cat/cat-count.md +++ b/_api-reference/cat/cat-count.md @@ -21,6 +21,7 @@ api: cat.count component: endpoints --> ## Endpoints + ```json GET /_cat/count GET /_cat/count/{index} @@ -35,6 +36,9 @@ columns: Parameter,Type,Description,Default include_deprecated: false --> ## Query parameters + + + Parameter | Type | Description | Default :--- | :--- | :--- | :--- `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | diff --git a/_api-reference/cat/cat-field-data.md b/_api-reference/cat/cat-field-data.md index 4a3291c490..24f6990ed0 100644 --- a/_api-reference/cat/cat-field-data.md +++ b/_api-reference/cat/cat-field-data.md @@ -19,6 +19,7 @@ api: cat.fielddata component: endpoints --> ## Endpoints + ```json GET /_cat/fielddata GET /_cat/fielddata/{fields} @@ -33,6 +34,9 @@ columns: Parameter,Type,Description,Default include_deprecated: false --> ## Query parameters + + + Parameter | Type | Description | Default :--- | :--- | :--- | :--- `bytes` | String | The units used to display byte values. | diff --git a/_api-reference/cat/cat-health.md b/_api-reference/cat/cat-health.md index b0826e0c30..79ef48e782 100644 --- a/_api-reference/cat/cat-health.md +++ b/_api-reference/cat/cat-health.md @@ -20,6 +20,7 @@ api: cat.health component: endpoints --> ## Endpoints + ```json GET /_cat/health ``` @@ -33,6 +34,9 @@ columns: Parameter,Type,Description,Default include_deprecated: false --> ## Query parameters + + + Parameter | Type | Description | Default :--- | :--- | :--- | :--- `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | diff --git a/_api-reference/cat/cat-indices.md b/_api-reference/cat/cat-indices.md index a653d5ddad..3975128195 100644 --- a/_api-reference/cat/cat-indices.md +++ b/_api-reference/cat/cat-indices.md @@ -20,6 +20,7 @@ api: cat.indices component: endpoints --> ## Endpoints + ```json GET /_cat/indices GET /_cat/indices/{index} @@ -34,6 +35,9 @@ columns: Parameter,Type,Description,Default include_deprecated: false --> ## Query parameters + + + Parameter | Type | Description | Default :--- | :--- | :--- | :--- `bytes` | String | The units used to display byte values. | diff --git a/_api-reference/cat/cat-nodeattrs.md b/_api-reference/cat/cat-nodeattrs.md index 7286c46688..1ccd6a8c51 100644 --- a/_api-reference/cat/cat-nodeattrs.md +++ b/_api-reference/cat/cat-nodeattrs.md @@ -20,6 +20,7 @@ api: cat.nodeattrs component: endpoints --> ## Endpoints + ```json GET /_cat/nodeattrs ``` @@ -33,6 +34,9 @@ columns: Parameter,Type,Description,Default include_deprecated: false --> ## Query parameters + + + Parameter | Type | Description | Default :--- | :--- | :--- | :--- `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | diff --git a/_api-reference/cat/cat-nodes.md b/_api-reference/cat/cat-nodes.md index adc7332880..935b86fd60 100644 --- a/_api-reference/cat/cat-nodes.md +++ b/_api-reference/cat/cat-nodes.md @@ -22,6 +22,7 @@ api: cat.nodes component: endpoints --> ## Endpoints + ```json GET /_cat/nodes ``` @@ -35,6 +36,9 @@ columns: Parameter,Type,Description,Default include_deprecated: false --> ## Query parameters + + + Parameter | Type | Description | Default :--- | :--- | :--- | :--- `bytes` | String | The units used to display byte values. | diff --git a/_api-reference/cat/cat-pending-tasks.md b/_api-reference/cat/cat-pending-tasks.md index 03c44d0074..b1f37fd3cb 100644 --- a/_api-reference/cat/cat-pending-tasks.md +++ b/_api-reference/cat/cat-pending-tasks.md @@ -20,6 +20,7 @@ api: cat.pending_tasks component: endpoints --> ## Endpoints + ```json GET /_cat/pending_tasks ``` @@ -33,6 +34,9 @@ columns: Parameter,Type,Description,Default include_deprecated: false --> ## Query parameters + + + Parameter | Type | Description | Default :--- | :--- | :--- | :--- `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | diff --git a/_api-reference/cat/cat-pit-segments.md b/_api-reference/cat/cat-pit-segments.md index 0b20eb8130..bbc65c77af 100644 --- a/_api-reference/cat/cat-pit-segments.md +++ b/_api-reference/cat/cat-pit-segments.md @@ -16,6 +16,7 @@ api: cat.pit_segments component: endpoints omit_header: true --> + ```json GET /_cat/pit_segments ``` @@ -26,6 +27,7 @@ api: cat.all_pit_segments component: endpoints omit_header: true --> + ```json GET /_cat/pit_segments/_all ``` @@ -38,6 +40,9 @@ columns: Parameter,Type,Description,Default include_deprecated: false --> ## Query parameters + + + Parameter | Type | Description | Default :--- | :--- | :--- | :--- `bytes` | String | The units used to display byte values. | diff --git a/_api-reference/cat/cat-plugins.md b/_api-reference/cat/cat-plugins.md index 588f6d0ff6..f345dd0166 100644 --- a/_api-reference/cat/cat-plugins.md +++ b/_api-reference/cat/cat-plugins.md @@ -19,6 +19,7 @@ api: cat.plugins component: endpoints --> ## Endpoints + ```json GET /_cat/plugins ``` @@ -32,6 +33,9 @@ columns: Parameter,Type,Description,Default include_deprecated: false --> ## Query parameters + + + Parameter | Type | Description | Default :--- | :--- | :--- | :--- `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | diff --git a/_api-reference/cat/cat-recovery.md b/_api-reference/cat/cat-recovery.md index ec9010af85..febe6d1fae 100644 --- a/_api-reference/cat/cat-recovery.md +++ b/_api-reference/cat/cat-recovery.md @@ -20,6 +20,7 @@ api: cat.recovery component: endpoints --> ## Endpoints + ```json GET /_cat/recovery GET /_cat/recovery/{index} @@ -34,6 +35,9 @@ columns: Parameter,Type,Description,Default include_deprecated: false --> ## Query parameters + + + Parameter | Type | Description | Default :--- | :--- | :--- | :--- `active_only` | Boolean | If `true`, the response only includes ongoing shard recoveries. | `false` diff --git a/_api-reference/cat/cat-repositories.md b/_api-reference/cat/cat-repositories.md index 9c331bdcd3..236d8c4698 100644 --- a/_api-reference/cat/cat-repositories.md +++ b/_api-reference/cat/cat-repositories.md @@ -19,6 +19,7 @@ api: cat.repositories component: endpoints --> ## Endpoints + ```json GET /_cat/repositories ``` @@ -32,6 +33,9 @@ columns: Parameter,Type,Description,Default include_deprecated: false --> ## Query parameters + + + Parameter | Type | Description | Default :--- | :--- | :--- | :--- `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | diff --git a/_api-reference/cat/cat-segment-replication.md b/_api-reference/cat/cat-segment-replication.md index d0d2e04fb6..e8ba122b01 100644 --- a/_api-reference/cat/cat-segment-replication.md +++ b/_api-reference/cat/cat-segment-replication.md @@ -20,6 +20,7 @@ api: cat.segment_replication component: endpoints --> ## Endpoints + ```json GET /_cat/segment_replication GET /_cat/segment_replication/{index} @@ -33,6 +34,7 @@ columns: Parameter,Type,Description include_deprecated: false --> ## Path parameters + Parameter | Type | Description :--- | :--- | :--- `index` | List | A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. @@ -46,6 +48,9 @@ columns: Parameter,Type,Description,Default include_deprecated: false --> ## Query parameters + + + Parameter | Type | Description | Default :--- | :--- | :--- | :--- `active_only` | Boolean | When `true`, the response only includes ongoing segment replication events. | `false` diff --git a/_api-reference/cat/cat-segments.md b/_api-reference/cat/cat-segments.md index c25f28bc57..e60cd54032 100644 --- a/_api-reference/cat/cat-segments.md +++ b/_api-reference/cat/cat-segments.md @@ -20,6 +20,7 @@ api: cat.segments component: endpoints --> ## Endpoints + ```json GET /_cat/segments GET /_cat/segments/{index} @@ -34,6 +35,9 @@ columns: Parameter,Type,Description,Default include_deprecated: false --> ## Query parameters + + + Parameter | Type | Description | Default :--- | :--- | :--- | :--- `bytes` | String | The units used to display byte values. | diff --git a/_api-reference/cat/cat-shards.md b/_api-reference/cat/cat-shards.md index a38e526756..69ce951eea 100644 --- a/_api-reference/cat/cat-shards.md +++ b/_api-reference/cat/cat-shards.md @@ -20,6 +20,7 @@ api: cat.shards component: endpoints --> ## Endpoints + ```json GET /_cat/shards GET /_cat/shards/{index} @@ -34,6 +35,9 @@ columns: Parameter,Type,Description,Default include_deprecated: false --> ## Query parameters + + + Parameter | Type | Description | Default :--- | :--- | :--- | :--- `bytes` | String | The units used to display byte values. | diff --git a/_api-reference/cat/cat-snapshots.md b/_api-reference/cat/cat-snapshots.md index 55d6b84b51..5c8f5d4de5 100644 --- a/_api-reference/cat/cat-snapshots.md +++ b/_api-reference/cat/cat-snapshots.md @@ -20,6 +20,7 @@ api: cat.snapshots component: endpoints --> ## Endpoints + ```json GET /_cat/snapshots GET /_cat/snapshots/{repository} @@ -34,6 +35,9 @@ columns: Parameter,Type,Description,Default include_deprecated: false --> ## Query parameters + + + Parameter | Type | Description | Default :--- | :--- | :--- | :--- `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | diff --git a/_api-reference/cat/cat-tasks.md b/_api-reference/cat/cat-tasks.md index ee00b81ac5..470c6a71d1 100644 --- a/_api-reference/cat/cat-tasks.md +++ b/_api-reference/cat/cat-tasks.md @@ -19,6 +19,7 @@ api: cat.tasks component: endpoints --> ## Endpoints + ```json GET /_cat/tasks ``` @@ -32,6 +33,9 @@ columns: Parameter,Type,Description,Default include_deprecated: false --> ## Query parameters + + + Parameter | Type | Description | Default :--- | :--- | :--- | :--- `actions` | List | The task action names used to limit the response. | diff --git a/_api-reference/cat/cat-templates.md b/_api-reference/cat/cat-templates.md index 1d04c27b93..08bce5ce51 100644 --- a/_api-reference/cat/cat-templates.md +++ b/_api-reference/cat/cat-templates.md @@ -20,6 +20,7 @@ api: cat.templates component: endpoints --> ## Endpoints + ```json GET /_cat/templates GET /_cat/templates/{name} @@ -34,6 +35,9 @@ columns: Parameter,Type,Description,Default include_deprecated: false --> ## Query parameters + + + Parameter | Type | Description | Default :--- | :--- | :--- | :--- `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | diff --git a/_api-reference/cat/cat-thread-pool.md b/_api-reference/cat/cat-thread-pool.md index a3ec9736c8..8ac1d11ed6 100644 --- a/_api-reference/cat/cat-thread-pool.md +++ b/_api-reference/cat/cat-thread-pool.md @@ -20,6 +20,7 @@ api: cat.thread_pool component: endpoints --> ## Endpoints + ```json GET /_cat/thread_pool GET /_cat/thread_pool/{thread_pool_patterns} @@ -34,6 +35,9 @@ columns: Parameter,Type,Description,Default include_deprecated: false --> ## Query parameters + + + Parameter | Type | Description | Default :--- | :--- | :--- | :--- `cluster_manager_timeout` | String | A timeout for connection to the cluster manager node. | diff --git a/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md b/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md index d59fd4ecf2..df4f542b61 100644 --- a/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md +++ b/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md @@ -20,6 +20,7 @@ api: wlm.create_query_group component: endpoints omit_header: true --> + ```json PUT /_wlm/query_group ``` @@ -32,6 +33,7 @@ api: wlm.create_query_group component: endpoints omit_header: true --> + ```json PUT /_wlm/query_group ``` @@ -44,6 +46,7 @@ api: wlm.get_query_group component: endpoints omit_header: true --> + ```json GET /_wlm/query_group GET /_wlm/query_group/{name} @@ -57,6 +60,7 @@ api: wlm.create_query_group component: endpoints omit_header: true --> + ```json PUT /_wlm/query_group ``` diff --git a/spec-insert/lib/renderers/templates/endpoints.mustache b/spec-insert/lib/renderers/templates/endpoints.mustache index 0541921aa8..83fc7db1ec 100644 --- a/spec-insert/lib/renderers/templates/endpoints.mustache +++ b/spec-insert/lib/renderers/templates/endpoints.mustache @@ -1,6 +1,7 @@ {{^omit_header}} ## Endpoints {{/omit_header}} + ```json {{#operations}} {{{verb}}} {{{path}}} diff --git a/spec-insert/lib/renderers/templates/path_parameters.mustache b/spec-insert/lib/renderers/templates/path_parameters.mustache index 9d9a2df9d4..e725759696 100644 --- a/spec-insert/lib/renderers/templates/path_parameters.mustache +++ b/spec-insert/lib/renderers/templates/path_parameters.mustache @@ -1,4 +1,5 @@ {{^omit_header}} ## Path parameters {{/omit_header}} + {{{table}}} \ No newline at end of file diff --git a/spec-insert/lib/renderers/templates/query_parameters.mustache b/spec-insert/lib/renderers/templates/query_parameters.mustache index d7331d8f5a..117e22ebef 100644 --- a/spec-insert/lib/renderers/templates/query_parameters.mustache +++ b/spec-insert/lib/renderers/templates/query_parameters.mustache @@ -1,7 +1,10 @@ {{^omit_header}} ## Query parameters + {{#optional}} All query parameters are optional. {{/optional}} + {{/omit_header}} + {{{table}}} \ No newline at end of file diff --git a/spec-insert/spec/_fixtures/expected_output/endpoints.md b/spec-insert/spec/_fixtures/expected_output/endpoints.md index cffad018cb..32768d8f4a 100644 --- a/spec-insert/spec/_fixtures/expected_output/endpoints.md +++ b/spec-insert/spec/_fixtures/expected_output/endpoints.md @@ -4,10 +4,12 @@ api: search component: endpoints --> ## Endpoints + ```json GET /_search POST /_search GET /{index}/_search POST /{index}/_search ``` + diff --git a/spec-insert/spec/_fixtures/expected_output/param_tables.md b/spec-insert/spec/_fixtures/expected_output/param_tables.md index 96bbcd363b..12e9013594 100644 --- a/spec-insert/spec/_fixtures/expected_output/param_tables.md +++ b/spec-insert/spec/_fixtures/expected_output/param_tables.md @@ -5,6 +5,7 @@ api: search component: path_parameters --> ## Path parameters + Parameter | Type | Description :--- | :--- | :--- `index` | List or String | Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams and indexes, omit this parameter or use `*` or `_all`. @@ -20,11 +21,12 @@ pretty: true columns: Type, Parameter, Description, Required, Default --> ## Query parameters -| Type | Parameter | Description | Required | Default | -|:--------|:--------------------------|:-----------------------------------------------------------------------------------------------------------------------------------|:---------|:--------| -| Boolean | `analyze_wildcard` | If true, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified. | Required | `false` | -| String | `analyzer` | Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified. | | | -| Boolean | `pretty` | Whether to pretty format the returned JSON response. | | | + +Type | Parameter | Description | Required | Default + :--- | :--- | :--- |:--- | :--- +| Boolean | `analyze_wildcard` | If true, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified. | Required | `false` | +| String | `analyzer` | Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified. | | | +| Boolean | `pretty` | Whether to pretty format the returned JSON response. | | | | Boolean | `human`
_DEPRECATED_ | _(Deprecated since 3.0: Use the `format` parameter instead.)_ Whether to return human readable values for statistics. | | `true` | From 5314b427007b81d1d400e7097b10054832cfd4e3 Mon Sep 17 00:00:00 2001 From: Archer Date: Thu, 9 Jan 2025 14:37:01 -0600 Subject: [PATCH 05/32] Fix table spacing Signed-off-by: Archer --- spec-insert/lib/renderers/parameter_table_renderer.rb | 2 +- spec-insert/lib/renderers/templates/query_parameters.mustache | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/spec-insert/lib/renderers/parameter_table_renderer.rb b/spec-insert/lib/renderers/parameter_table_renderer.rb index 0deefaa9ba..80d7891c3c 100644 --- a/spec-insert/lib/renderers/parameter_table_renderer.rb +++ b/spec-insert/lib/renderers/parameter_table_renderer.rb @@ -28,7 +28,7 @@ def row(param) 'Parameter' => "`#{param.name}`#{'
_DEPRECATED_' if param.deprecated}", 'Description' => description(param), 'Required' => param.required ? 'Required' : nil, - 'Type' => param.doc_type, + 'Data Type' => param.doc_type, 'Default' => param.default.nil? ? nil : "`#{param.default}`" } end diff --git a/spec-insert/lib/renderers/templates/query_parameters.mustache b/spec-insert/lib/renderers/templates/query_parameters.mustache index 117e22ebef..ee86f96808 100644 --- a/spec-insert/lib/renderers/templates/query_parameters.mustache +++ b/spec-insert/lib/renderers/templates/query_parameters.mustache @@ -4,7 +4,6 @@ {{#optional}} All query parameters are optional. {{/optional}} - {{/omit_header}} {{{table}}} \ No newline at end of file From e6d2233718bb37ed600690982909f9a7cc091e29 Mon Sep 17 00:00:00 2001 From: Archer Date: Thu, 9 Jan 2025 14:41:34 -0600 Subject: [PATCH 06/32] Updated expected output Signed-off-by: Archer --- .../spec/_fixtures/expected_output/param_tables.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/spec-insert/spec/_fixtures/expected_output/param_tables.md b/spec-insert/spec/_fixtures/expected_output/param_tables.md index 12e9013594..63ce4830cc 100644 --- a/spec-insert/spec/_fixtures/expected_output/param_tables.md +++ b/spec-insert/spec/_fixtures/expected_output/param_tables.md @@ -18,16 +18,16 @@ api: search component: query_parameters include_global: true pretty: true -columns: Type, Parameter, Description, Required, Default +columns: Parameter, Type Description, Required, Default --> ## Query parameters -Type | Parameter | Description | Required | Default +| Parameter | Data Type | Description | Required | Default | :--- | :--- | :--- |:--- | :--- -| Boolean | `analyze_wildcard` | If true, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified. | Required | `false` | -| String | `analyzer` | Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified. | | | -| Boolean | `pretty` | Whether to pretty format the returned JSON response. | | | -| Boolean | `human`
_DEPRECATED_ | _(Deprecated since 3.0: Use the `format` parameter instead.)_ Whether to return human readable values for statistics. | | `true` | +| `analyze_wildcard` | Boolean | If true, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified. | Required | `false` | +| `analyzer` | String | Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified. | | | +| `pretty` | Boolean | Whether to pretty format the returned JSON response. | | | +| `human`
_DEPRECATED_ | Boolean | _(Deprecated since 3.0: Use the `format` parameter instead.)_ Whether to return human readable values for statistics. | | `true` | Query Parameters Example with only Parameter and Description Columns From d0b2fa07d2a0fd112ddaa20effb6e907ce67fb8b Mon Sep 17 00:00:00 2001 From: Archer Date: Thu, 9 Jan 2025 14:53:41 -0600 Subject: [PATCH 07/32] Revert back to type Signed-off-by: Archer --- _api-reference/cat/cat-aliases.md | 1 - _api-reference/cat/cat-allocation.md | 1 - _api-reference/cat/cat-cluster_manager.md | 1 - _api-reference/cat/cat-count.md | 1 - _api-reference/cat/cat-field-data.md | 1 - _api-reference/cat/cat-health.md | 1 - _api-reference/cat/cat-indices.md | 1 - _api-reference/cat/cat-nodeattrs.md | 1 - _api-reference/cat/cat-nodes.md | 1 - _api-reference/cat/cat-pending-tasks.md | 1 - _api-reference/cat/cat-pit-segments.md | 1 - _api-reference/cat/cat-plugins.md | 1 - _api-reference/cat/cat-recovery.md | 1 - _api-reference/cat/cat-repositories.md | 1 - _api-reference/cat/cat-segment-replication.md | 1 - _api-reference/cat/cat-segments.md | 1 - _api-reference/cat/cat-shards.md | 1 - _api-reference/cat/cat-snapshots.md | 1 - _api-reference/cat/cat-tasks.md | 1 - _api-reference/cat/cat-templates.md | 1 - _api-reference/cat/cat-thread-pool.md | 1 - .../lib/renderers/parameter_table_renderer.rb | 2 +- .../spec/_fixtures/expected_output/param_tables.md | 14 +++++++------- 23 files changed, 8 insertions(+), 29 deletions(-) diff --git a/_api-reference/cat/cat-aliases.md b/_api-reference/cat/cat-aliases.md index 54fd94b9bd..d6ef4138d3 100644 --- a/_api-reference/cat/cat-aliases.md +++ b/_api-reference/cat/cat-aliases.md @@ -39,7 +39,6 @@ include_deprecated: false ## Query parameters - Parameter | Type | Description | Default :--- | :--- | :--- | :--- `expand_wildcards` | List or String | Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. | diff --git a/_api-reference/cat/cat-allocation.md b/_api-reference/cat/cat-allocation.md index f34accc607..6476d2ef2d 100644 --- a/_api-reference/cat/cat-allocation.md +++ b/_api-reference/cat/cat-allocation.md @@ -38,7 +38,6 @@ include_deprecated: false ## Query parameters - Parameter | Type | Description | Default :--- | :--- | :--- | :--- `bytes` | String | The units used to display byte values. | diff --git a/_api-reference/cat/cat-cluster_manager.md b/_api-reference/cat/cat-cluster_manager.md index f3902a8612..7599b33258 100644 --- a/_api-reference/cat/cat-cluster_manager.md +++ b/_api-reference/cat/cat-cluster_manager.md @@ -36,7 +36,6 @@ include_deprecated: false ## Query parameters - Parameter | Type | Description | Default :--- | :--- | :--- | :--- `cluster_manager_timeout` | String | A timeout for connection to the cluster manager node. | diff --git a/_api-reference/cat/cat-count.md b/_api-reference/cat/cat-count.md index dfafc8beee..055318f42f 100644 --- a/_api-reference/cat/cat-count.md +++ b/_api-reference/cat/cat-count.md @@ -38,7 +38,6 @@ include_deprecated: false ## Query parameters - Parameter | Type | Description | Default :--- | :--- | :--- | :--- `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | diff --git a/_api-reference/cat/cat-field-data.md b/_api-reference/cat/cat-field-data.md index 24f6990ed0..aa85998c1e 100644 --- a/_api-reference/cat/cat-field-data.md +++ b/_api-reference/cat/cat-field-data.md @@ -36,7 +36,6 @@ include_deprecated: false ## Query parameters - Parameter | Type | Description | Default :--- | :--- | :--- | :--- `bytes` | String | The units used to display byte values. | diff --git a/_api-reference/cat/cat-health.md b/_api-reference/cat/cat-health.md index 79ef48e782..7df6ed4700 100644 --- a/_api-reference/cat/cat-health.md +++ b/_api-reference/cat/cat-health.md @@ -36,7 +36,6 @@ include_deprecated: false ## Query parameters - Parameter | Type | Description | Default :--- | :--- | :--- | :--- `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | diff --git a/_api-reference/cat/cat-indices.md b/_api-reference/cat/cat-indices.md index 3975128195..d146716eec 100644 --- a/_api-reference/cat/cat-indices.md +++ b/_api-reference/cat/cat-indices.md @@ -37,7 +37,6 @@ include_deprecated: false ## Query parameters - Parameter | Type | Description | Default :--- | :--- | :--- | :--- `bytes` | String | The units used to display byte values. | diff --git a/_api-reference/cat/cat-nodeattrs.md b/_api-reference/cat/cat-nodeattrs.md index 1ccd6a8c51..d3fa2f25e3 100644 --- a/_api-reference/cat/cat-nodeattrs.md +++ b/_api-reference/cat/cat-nodeattrs.md @@ -36,7 +36,6 @@ include_deprecated: false ## Query parameters - Parameter | Type | Description | Default :--- | :--- | :--- | :--- `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | diff --git a/_api-reference/cat/cat-nodes.md b/_api-reference/cat/cat-nodes.md index 935b86fd60..5fcb25d8ca 100644 --- a/_api-reference/cat/cat-nodes.md +++ b/_api-reference/cat/cat-nodes.md @@ -38,7 +38,6 @@ include_deprecated: false ## Query parameters - Parameter | Type | Description | Default :--- | :--- | :--- | :--- `bytes` | String | The units used to display byte values. | diff --git a/_api-reference/cat/cat-pending-tasks.md b/_api-reference/cat/cat-pending-tasks.md index b1f37fd3cb..230820a76b 100644 --- a/_api-reference/cat/cat-pending-tasks.md +++ b/_api-reference/cat/cat-pending-tasks.md @@ -36,7 +36,6 @@ include_deprecated: false ## Query parameters - Parameter | Type | Description | Default :--- | :--- | :--- | :--- `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | diff --git a/_api-reference/cat/cat-pit-segments.md b/_api-reference/cat/cat-pit-segments.md index bbc65c77af..80f659a5c1 100644 --- a/_api-reference/cat/cat-pit-segments.md +++ b/_api-reference/cat/cat-pit-segments.md @@ -42,7 +42,6 @@ include_deprecated: false ## Query parameters - Parameter | Type | Description | Default :--- | :--- | :--- | :--- `bytes` | String | The units used to display byte values. | diff --git a/_api-reference/cat/cat-plugins.md b/_api-reference/cat/cat-plugins.md index f345dd0166..6df3d570d7 100644 --- a/_api-reference/cat/cat-plugins.md +++ b/_api-reference/cat/cat-plugins.md @@ -35,7 +35,6 @@ include_deprecated: false ## Query parameters - Parameter | Type | Description | Default :--- | :--- | :--- | :--- `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | diff --git a/_api-reference/cat/cat-recovery.md b/_api-reference/cat/cat-recovery.md index febe6d1fae..74d14124d9 100644 --- a/_api-reference/cat/cat-recovery.md +++ b/_api-reference/cat/cat-recovery.md @@ -37,7 +37,6 @@ include_deprecated: false ## Query parameters - Parameter | Type | Description | Default :--- | :--- | :--- | :--- `active_only` | Boolean | If `true`, the response only includes ongoing shard recoveries. | `false` diff --git a/_api-reference/cat/cat-repositories.md b/_api-reference/cat/cat-repositories.md index 236d8c4698..77a0c9e3e1 100644 --- a/_api-reference/cat/cat-repositories.md +++ b/_api-reference/cat/cat-repositories.md @@ -35,7 +35,6 @@ include_deprecated: false ## Query parameters - Parameter | Type | Description | Default :--- | :--- | :--- | :--- `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | diff --git a/_api-reference/cat/cat-segment-replication.md b/_api-reference/cat/cat-segment-replication.md index e8ba122b01..2d23e9fa07 100644 --- a/_api-reference/cat/cat-segment-replication.md +++ b/_api-reference/cat/cat-segment-replication.md @@ -50,7 +50,6 @@ include_deprecated: false ## Query parameters - Parameter | Type | Description | Default :--- | :--- | :--- | :--- `active_only` | Boolean | When `true`, the response only includes ongoing segment replication events. | `false` diff --git a/_api-reference/cat/cat-segments.md b/_api-reference/cat/cat-segments.md index e60cd54032..3e1415e063 100644 --- a/_api-reference/cat/cat-segments.md +++ b/_api-reference/cat/cat-segments.md @@ -37,7 +37,6 @@ include_deprecated: false ## Query parameters - Parameter | Type | Description | Default :--- | :--- | :--- | :--- `bytes` | String | The units used to display byte values. | diff --git a/_api-reference/cat/cat-shards.md b/_api-reference/cat/cat-shards.md index 69ce951eea..8d441c8c2a 100644 --- a/_api-reference/cat/cat-shards.md +++ b/_api-reference/cat/cat-shards.md @@ -37,7 +37,6 @@ include_deprecated: false ## Query parameters - Parameter | Type | Description | Default :--- | :--- | :--- | :--- `bytes` | String | The units used to display byte values. | diff --git a/_api-reference/cat/cat-snapshots.md b/_api-reference/cat/cat-snapshots.md index 5c8f5d4de5..4468e47c55 100644 --- a/_api-reference/cat/cat-snapshots.md +++ b/_api-reference/cat/cat-snapshots.md @@ -37,7 +37,6 @@ include_deprecated: false ## Query parameters - Parameter | Type | Description | Default :--- | :--- | :--- | :--- `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | diff --git a/_api-reference/cat/cat-tasks.md b/_api-reference/cat/cat-tasks.md index 470c6a71d1..29dc1dd601 100644 --- a/_api-reference/cat/cat-tasks.md +++ b/_api-reference/cat/cat-tasks.md @@ -35,7 +35,6 @@ include_deprecated: false ## Query parameters - Parameter | Type | Description | Default :--- | :--- | :--- | :--- `actions` | List | The task action names used to limit the response. | diff --git a/_api-reference/cat/cat-templates.md b/_api-reference/cat/cat-templates.md index 08bce5ce51..95b4aae3b9 100644 --- a/_api-reference/cat/cat-templates.md +++ b/_api-reference/cat/cat-templates.md @@ -37,7 +37,6 @@ include_deprecated: false ## Query parameters - Parameter | Type | Description | Default :--- | :--- | :--- | :--- `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | diff --git a/_api-reference/cat/cat-thread-pool.md b/_api-reference/cat/cat-thread-pool.md index 8ac1d11ed6..75c92b5795 100644 --- a/_api-reference/cat/cat-thread-pool.md +++ b/_api-reference/cat/cat-thread-pool.md @@ -37,7 +37,6 @@ include_deprecated: false ## Query parameters - Parameter | Type | Description | Default :--- | :--- | :--- | :--- `cluster_manager_timeout` | String | A timeout for connection to the cluster manager node. | diff --git a/spec-insert/lib/renderers/parameter_table_renderer.rb b/spec-insert/lib/renderers/parameter_table_renderer.rb index 80d7891c3c..0deefaa9ba 100644 --- a/spec-insert/lib/renderers/parameter_table_renderer.rb +++ b/spec-insert/lib/renderers/parameter_table_renderer.rb @@ -28,7 +28,7 @@ def row(param) 'Parameter' => "`#{param.name}`#{'
_DEPRECATED_' if param.deprecated}", 'Description' => description(param), 'Required' => param.required ? 'Required' : nil, - 'Data Type' => param.doc_type, + 'Type' => param.doc_type, 'Default' => param.default.nil? ? nil : "`#{param.default}`" } end diff --git a/spec-insert/spec/_fixtures/expected_output/param_tables.md b/spec-insert/spec/_fixtures/expected_output/param_tables.md index 63ce4830cc..97fd074234 100644 --- a/spec-insert/spec/_fixtures/expected_output/param_tables.md +++ b/spec-insert/spec/_fixtures/expected_output/param_tables.md @@ -18,16 +18,16 @@ api: search component: query_parameters include_global: true pretty: true -columns: Parameter, Type Description, Required, Default +columns: Type, Parameter, Description, Required, Default --> ## Query parameters -| Parameter | Data Type | Description | Required | Default | - :--- | :--- | :--- |:--- | :--- -| `analyze_wildcard` | Boolean | If true, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified. | Required | `false` | -| `analyzer` | String | Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified. | | | -| `pretty` | Boolean | Whether to pretty format the returned JSON response. | | | -| `human`
_DEPRECATED_ | Boolean | _(Deprecated since 3.0: Use the `format` parameter instead.)_ Whether to return human readable values for statistics. | | `true` | +| Type | Parameter | Description | Required | Default | +|:--------|:--------------------------|:-----------------------------------------------------------------------------------------------------------------------------------|:---------|:--------| +| Boolean | `analyze_wildcard` | If true, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified. | Required | `false` | +| String | `analyzer` | Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified. | | | +| Boolean | `pretty` | Whether to pretty format the returned JSON response. | | | +| Boolean | `human`
_DEPRECATED_ | _(Deprecated since 3.0: Use the `format` parameter instead.)_ Whether to return human readable values for statistics. | | `true` | Query Parameters Example with only Parameter and Description Columns From cbdd6c1430c3909e5052920007db1c101bb9d95a Mon Sep 17 00:00:00 2001 From: Archer Date: Thu, 9 Jan 2025 14:54:13 -0600 Subject: [PATCH 08/32] Fix pretty test expected result Signed-off-by: Archer --- spec-insert/spec/_fixtures/expected_output/param_tables.md | 1 + 1 file changed, 1 insertion(+) diff --git a/spec-insert/spec/_fixtures/expected_output/param_tables.md b/spec-insert/spec/_fixtures/expected_output/param_tables.md index 97fd074234..0180b161cc 100644 --- a/spec-insert/spec/_fixtures/expected_output/param_tables.md +++ b/spec-insert/spec/_fixtures/expected_output/param_tables.md @@ -22,6 +22,7 @@ columns: Type, Parameter, Description, Required, Default --> ## Query parameters + | Type | Parameter | Description | Required | Default | |:--------|:--------------------------|:-----------------------------------------------------------------------------------------------------------------------------------|:---------|:--------| | Boolean | `analyze_wildcard` | If true, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified. | Required | `false` | From 1aea84070104b49eeb611f12b2629d5187b0b292 Mon Sep 17 00:00:00 2001 From: Archer Date: Mon, 13 Jan 2025 09:52:58 -0600 Subject: [PATCH 09/32] Add updated tables. Signed-off-by: Archer --- _api-reference/cat/cat-cluster_manager.md | 2 +- _api-reference/cat/cat-count.md | 2 +- _api-reference/cat/cat-field-data.md | 2 +- _api-reference/cat/cat-health.md | 2 +- _api-reference/cat/cat-indices.md | 4 ++-- _api-reference/cat/cat-nodeattrs.md | 2 +- _api-reference/cat/cat-nodes.md | 2 +- _api-reference/cat/cat-pending-tasks.md | 2 +- _api-reference/cat/cat-pit-segments.md | 2 +- _api-reference/cat/cat-plugins.md | 2 +- _api-reference/cat/cat-recovery.md | 2 +- _api-reference/cat/cat-repositories.md | 2 +- _api-reference/cat/cat-segment-replication.md | 4 ++-- _api-reference/cat/cat-shards.md | 2 +- _api-reference/cat/cat-snapshots.md | 2 +- _api-reference/cat/cat-tasks.md | 2 +- _api-reference/cat/cat-templates.md | 2 +- _api-reference/cat/cat-thread-pool.md | 2 +- 18 files changed, 20 insertions(+), 20 deletions(-) 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. | From e27ec683837ccc477e5513e77a24337a98993e1c Mon Sep 17 00:00:00 2001 From: Archer Date: Mon, 13 Jan 2025 16:37:07 -0600 Subject: [PATCH 10/32] Add CAT API automation with updated spec-insert Signed-off-by: Archer --- _api-reference/cat/cat-aliases.md | 6 +++--- _api-reference/cat/cat-allocation.md | 6 +++--- _api-reference/cat/cat-cluster_manager.md | 6 +++--- _api-reference/cat/cat-count.md | 6 +++--- _api-reference/cat/cat-field-data.md | 6 +++--- _api-reference/cat/cat-health.md | 6 +++--- _api-reference/cat/cat-indices.md | 6 +++--- _api-reference/cat/cat-nodeattrs.md | 6 +++--- _api-reference/cat/cat-nodes.md | 6 +++--- _api-reference/cat/cat-pending-tasks.md | 6 +++--- _api-reference/cat/cat-pit-segments.md | 7 +++---- _api-reference/cat/cat-plugins.md | 6 +++--- _api-reference/cat/cat-recovery.md | 6 +++--- _api-reference/cat/cat-repositories.md | 6 +++--- _api-reference/cat/cat-segment-replication.md | 2 +- _api-reference/cat/cat-segments.md | 2 +- _api-reference/cat/cat-shards.md | 2 +- _api-reference/cat/cat-snapshots.md | 2 +- _api-reference/cat/cat-tasks.md | 2 +- _api-reference/cat/cat-templates.md | 2 +- _api-reference/cat/cat-thread-pool.md | 2 +- spec-insert/lib/renderers/templates/endpoints.mustache | 1 - .../lib/renderers/templates/path_parameters.mustache | 1 - .../lib/renderers/templates/query_parameters.mustache | 1 - spec-insert/spec/_fixtures/expected_output/endpoints.md | 2 -- spec-insert/spec/_fixtures/expected_output/param_tables.md | 1 - 26 files changed, 49 insertions(+), 56 deletions(-) diff --git a/_api-reference/cat/cat-aliases.md b/_api-reference/cat/cat-aliases.md index d6ef4138d3..3a4580932a 100644 --- a/_api-reference/cat/cat-aliases.md +++ b/_api-reference/cat/cat-aliases.md @@ -22,7 +22,6 @@ api: cat.aliases component: endpoints --> ## Endpoints - ```json GET /_cat/aliases GET /_cat/aliases/{name} @@ -33,13 +32,14 @@ GET /_cat/aliases/{name} ## Query parameters +The following table lists the available query parameters. All query parameters are optional. -Parameter | Type | Description | Default +Parameter | Data type | Description | Default :--- | :--- | :--- | :--- `expand_wildcards` | List or String | Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | diff --git a/_api-reference/cat/cat-allocation.md b/_api-reference/cat/cat-allocation.md index 6476d2ef2d..eba28f9e3b 100644 --- a/_api-reference/cat/cat-allocation.md +++ b/_api-reference/cat/cat-allocation.md @@ -21,7 +21,6 @@ api: cat.allocation component: endpoints --> ## Endpoints - ```json GET /_cat/allocation GET /_cat/allocation/{node_id} @@ -32,13 +31,14 @@ GET /_cat/allocation/{node_id} ## Query parameters +The following table lists the available query parameters. All query parameters are optional. -Parameter | Type | Description | Default +Parameter | Data type | Description | Default :--- | :--- | :--- | :--- `bytes` | String | The units used to display byte values. | `cluster_manager_timeout` | String | A timeout for connection to the cluster manager node. | diff --git a/_api-reference/cat/cat-cluster_manager.md b/_api-reference/cat/cat-cluster_manager.md index 6081f949a3..39baf2a236 100644 --- a/_api-reference/cat/cat-cluster_manager.md +++ b/_api-reference/cat/cat-cluster_manager.md @@ -20,7 +20,6 @@ api: cat.cluster_manager component: endpoints --> ## Endpoints - ```json GET /_cat/cluster_manager ``` @@ -30,13 +29,14 @@ GET /_cat/cluster_manager ## Query parameters +The following table lists the available query parameters. All query parameters are optional. -Parameter | Type | Description | Default +Parameter | Data 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`. | diff --git a/_api-reference/cat/cat-count.md b/_api-reference/cat/cat-count.md index 152977da30..85e9babb1b 100644 --- a/_api-reference/cat/cat-count.md +++ b/_api-reference/cat/cat-count.md @@ -21,7 +21,6 @@ api: cat.count component: endpoints --> ## Endpoints - ```json GET /_cat/count GET /_cat/count/{index} @@ -32,13 +31,14 @@ GET /_cat/count/{index} ## Query parameters +The following table lists the available query parameters. All query parameters are optional. -Parameter | Type | Description | Default +Parameter | Data 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. | diff --git a/_api-reference/cat/cat-field-data.md b/_api-reference/cat/cat-field-data.md index d01ef8ba3f..708ce2584f 100644 --- a/_api-reference/cat/cat-field-data.md +++ b/_api-reference/cat/cat-field-data.md @@ -19,7 +19,6 @@ api: cat.fielddata component: endpoints --> ## Endpoints - ```json GET /_cat/fielddata GET /_cat/fielddata/{fields} @@ -30,13 +29,14 @@ GET /_cat/fielddata/{fields} ## Query parameters +The following table lists the available query parameters. All query parameters are optional. -Parameter | Type | Description | Default +Parameter | Data 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`. | diff --git a/_api-reference/cat/cat-health.md b/_api-reference/cat/cat-health.md index 841459742a..0268b6ac4b 100644 --- a/_api-reference/cat/cat-health.md +++ b/_api-reference/cat/cat-health.md @@ -20,7 +20,6 @@ api: cat.health component: endpoints --> ## Endpoints - ```json GET /_cat/health ``` @@ -30,13 +29,14 @@ GET /_cat/health ## Query parameters +The following table lists the available query parameters. All query parameters are optional. -Parameter | Type | Description | Default +Parameter | Data 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. | diff --git a/_api-reference/cat/cat-indices.md b/_api-reference/cat/cat-indices.md index 7aade8f959..2373dbe10c 100644 --- a/_api-reference/cat/cat-indices.md +++ b/_api-reference/cat/cat-indices.md @@ -20,7 +20,6 @@ api: cat.indices component: endpoints --> ## Endpoints - ```json GET /_cat/indices GET /_cat/indices/{index} @@ -31,13 +30,14 @@ GET /_cat/indices/{index} ## Query parameters +The following table lists the available query parameters. All query parameters are optional. -Parameter | Type | Description | Default +Parameter | Data 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. | diff --git a/_api-reference/cat/cat-nodeattrs.md b/_api-reference/cat/cat-nodeattrs.md index 229f77f8b6..04459050ef 100644 --- a/_api-reference/cat/cat-nodeattrs.md +++ b/_api-reference/cat/cat-nodeattrs.md @@ -20,7 +20,6 @@ api: cat.nodeattrs component: endpoints --> ## Endpoints - ```json GET /_cat/nodeattrs ``` @@ -30,13 +29,14 @@ GET /_cat/nodeattrs ## Query parameters +The following table lists the available query parameters. All query parameters are optional. -Parameter | Type | Description | Default +Parameter | Data 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`. | diff --git a/_api-reference/cat/cat-nodes.md b/_api-reference/cat/cat-nodes.md index 50e2dc6de2..3121071b58 100644 --- a/_api-reference/cat/cat-nodes.md +++ b/_api-reference/cat/cat-nodes.md @@ -22,7 +22,6 @@ api: cat.nodes component: endpoints --> ## Endpoints - ```json GET /_cat/nodes ``` @@ -32,13 +31,14 @@ GET /_cat/nodes ## Query parameters +The following table lists the available query parameters. All query parameters are optional. -Parameter | Type | Description | Default +Parameter | Data 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. | diff --git a/_api-reference/cat/cat-pending-tasks.md b/_api-reference/cat/cat-pending-tasks.md index 7a7222dcb1..15fa159531 100644 --- a/_api-reference/cat/cat-pending-tasks.md +++ b/_api-reference/cat/cat-pending-tasks.md @@ -20,7 +20,6 @@ api: cat.pending_tasks component: endpoints --> ## Endpoints - ```json GET /_cat/pending_tasks ``` @@ -30,13 +29,14 @@ GET /_cat/pending_tasks ## Query parameters +The following table lists the available query parameters. All query parameters are optional. -Parameter | Type | Description | Default +Parameter | Data 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`. | diff --git a/_api-reference/cat/cat-pit-segments.md b/_api-reference/cat/cat-pit-segments.md index a7a64e842e..76b46c03de 100644 --- a/_api-reference/cat/cat-pit-segments.md +++ b/_api-reference/cat/cat-pit-segments.md @@ -16,7 +16,6 @@ api: cat.pit_segments component: endpoints omit_header: true --> - ```json GET /_cat/pit_segments ``` @@ -27,7 +26,6 @@ api: cat.all_pit_segments component: endpoints omit_header: true --> - ```json GET /_cat/pit_segments/_all ``` @@ -36,13 +34,14 @@ GET /_cat/pit_segments/_all ## Query parameters +The following table lists the available query parameters. All query parameters are optional. -Parameter | Type | Description | Default +Parameter | Data 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`. | diff --git a/_api-reference/cat/cat-plugins.md b/_api-reference/cat/cat-plugins.md index 012ed0dfd8..c931f72a52 100644 --- a/_api-reference/cat/cat-plugins.md +++ b/_api-reference/cat/cat-plugins.md @@ -19,7 +19,6 @@ api: cat.plugins component: endpoints --> ## Endpoints - ```json GET /_cat/plugins ``` @@ -29,13 +28,14 @@ GET /_cat/plugins ## Query parameters +The following table lists the available query parameters. All query parameters are optional. -Parameter | Type | Description | Default +Parameter | Data 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`. | diff --git a/_api-reference/cat/cat-recovery.md b/_api-reference/cat/cat-recovery.md index aab281d983..4326fb552e 100644 --- a/_api-reference/cat/cat-recovery.md +++ b/_api-reference/cat/cat-recovery.md @@ -20,7 +20,6 @@ api: cat.recovery component: endpoints --> ## Endpoints - ```json GET /_cat/recovery GET /_cat/recovery/{index} @@ -31,13 +30,14 @@ GET /_cat/recovery/{index} ## Query parameters +The following table lists the available query parameters. All query parameters are optional. -Parameter | Type | Description | Default +Parameter | Data type | Description | Default :--- | :--- | :--- | :--- `active_only` | Boolean | If `true`, the response only includes ongoing shard recoveries. | `false` `bytes` | String | The units used to display byte values. | diff --git a/_api-reference/cat/cat-repositories.md b/_api-reference/cat/cat-repositories.md index c25235a4f4..00e8e49b97 100644 --- a/_api-reference/cat/cat-repositories.md +++ b/_api-reference/cat/cat-repositories.md @@ -19,7 +19,6 @@ api: cat.repositories component: endpoints --> ## Endpoints - ```json GET /_cat/repositories ``` @@ -29,13 +28,14 @@ GET /_cat/repositories ## Query parameters +The following table lists the available query parameters. All query parameters are optional. -Parameter | Type | Description | Default +Parameter | Data 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`. | diff --git a/_api-reference/cat/cat-segment-replication.md b/_api-reference/cat/cat-segment-replication.md index 74235e881c..025d2b2c29 100644 --- a/_api-reference/cat/cat-segment-replication.md +++ b/_api-reference/cat/cat-segment-replication.md @@ -44,7 +44,7 @@ Parameter | Type | Description ## Query parameters diff --git a/_api-reference/cat/cat-segments.md b/_api-reference/cat/cat-segments.md index 3e1415e063..620e133eb5 100644 --- a/_api-reference/cat/cat-segments.md +++ b/_api-reference/cat/cat-segments.md @@ -31,7 +31,7 @@ GET /_cat/segments/{index} ## Query parameters diff --git a/_api-reference/cat/cat-shards.md b/_api-reference/cat/cat-shards.md index ef270ee999..ce47c9f29e 100644 --- a/_api-reference/cat/cat-shards.md +++ b/_api-reference/cat/cat-shards.md @@ -31,7 +31,7 @@ GET /_cat/shards/{index} ## Query parameters diff --git a/_api-reference/cat/cat-snapshots.md b/_api-reference/cat/cat-snapshots.md index 9aa16f2916..1b061bc4d3 100644 --- a/_api-reference/cat/cat-snapshots.md +++ b/_api-reference/cat/cat-snapshots.md @@ -31,7 +31,7 @@ GET /_cat/snapshots/{repository} ## Query parameters diff --git a/_api-reference/cat/cat-tasks.md b/_api-reference/cat/cat-tasks.md index 1b67e9cdc2..02e10105f3 100644 --- a/_api-reference/cat/cat-tasks.md +++ b/_api-reference/cat/cat-tasks.md @@ -29,7 +29,7 @@ GET /_cat/tasks ## Query parameters diff --git a/_api-reference/cat/cat-templates.md b/_api-reference/cat/cat-templates.md index b9d4a58e0a..7bb361f3f2 100644 --- a/_api-reference/cat/cat-templates.md +++ b/_api-reference/cat/cat-templates.md @@ -31,7 +31,7 @@ GET /_cat/templates/{name} ## Query parameters diff --git a/_api-reference/cat/cat-thread-pool.md b/_api-reference/cat/cat-thread-pool.md index 82d49e5126..9c82e283a6 100644 --- a/_api-reference/cat/cat-thread-pool.md +++ b/_api-reference/cat/cat-thread-pool.md @@ -31,7 +31,7 @@ GET /_cat/thread_pool/{thread_pool_patterns} ## Query parameters diff --git a/spec-insert/lib/renderers/templates/endpoints.mustache b/spec-insert/lib/renderers/templates/endpoints.mustache index 83fc7db1ec..0541921aa8 100644 --- a/spec-insert/lib/renderers/templates/endpoints.mustache +++ b/spec-insert/lib/renderers/templates/endpoints.mustache @@ -1,7 +1,6 @@ {{^omit_header}} ## Endpoints {{/omit_header}} - ```json {{#operations}} {{{verb}}} {{{path}}} diff --git a/spec-insert/lib/renderers/templates/path_parameters.mustache b/spec-insert/lib/renderers/templates/path_parameters.mustache index e6700217d1..ad69f4d589 100644 --- a/spec-insert/lib/renderers/templates/path_parameters.mustache +++ b/spec-insert/lib/renderers/templates/path_parameters.mustache @@ -4,5 +4,4 @@ The following table lists the available path parameters.{{#optional}} All path parameters are optional.{{/optional}} {{/omit_header}} - {{{table}}} \ No newline at end of file diff --git a/spec-insert/lib/renderers/templates/query_parameters.mustache b/spec-insert/lib/renderers/templates/query_parameters.mustache index 96baaf0be3..5cc7bc9241 100644 --- a/spec-insert/lib/renderers/templates/query_parameters.mustache +++ b/spec-insert/lib/renderers/templates/query_parameters.mustache @@ -4,5 +4,4 @@ The following table lists the available query parameters.{{#optional}} All query parameters are optional.{{/optional}} {{/omit_header}} - {{{table}}} \ No newline at end of file diff --git a/spec-insert/spec/_fixtures/expected_output/endpoints.md b/spec-insert/spec/_fixtures/expected_output/endpoints.md index 32768d8f4a..cffad018cb 100644 --- a/spec-insert/spec/_fixtures/expected_output/endpoints.md +++ b/spec-insert/spec/_fixtures/expected_output/endpoints.md @@ -4,12 +4,10 @@ api: search component: endpoints --> ## Endpoints - ```json GET /_search POST /_search GET /{index}/_search POST /{index}/_search ``` - diff --git a/spec-insert/spec/_fixtures/expected_output/param_tables.md b/spec-insert/spec/_fixtures/expected_output/param_tables.md index f182f132f0..203ddf722c 100644 --- a/spec-insert/spec/_fixtures/expected_output/param_tables.md +++ b/spec-insert/spec/_fixtures/expected_output/param_tables.md @@ -24,7 +24,6 @@ columns: Data type, Parameter, Description, Required, Default --> ## Query parameters - The following table lists the available query parameters. | Data type | Parameter | Description | Required | Default | From 62ef5e42e2307452a44704345befabdeb08b6591 Mon Sep 17 00:00:00 2001 From: Archer Date: Fri, 17 Jan 2025 14:03:07 -0600 Subject: [PATCH 11/32] Add updated CAT API tables Signed-off-by: Archer --- _api-reference/cat/cat-aliases.md | 18 +++---- _api-reference/cat/cat-allocation.md | 20 ++++---- _api-reference/cat/cat-cluster_manager.md | 18 +++---- _api-reference/cat/cat-count.md | 14 +++--- _api-reference/cat/cat-field-data.md | 16 +++--- _api-reference/cat/cat-health.md | 18 +++---- _api-reference/cat/cat-indices.md | 30 +++++------ _api-reference/cat/cat-nodeattrs.md | 18 +++---- _api-reference/cat/cat-nodes.md | 22 ++++---- _api-reference/cat/cat-pending-tasks.md | 20 ++++---- _api-reference/cat/cat-pit-segments.md | 16 +++--- _api-reference/cat/cat-plugins.md | 18 +++---- _api-reference/cat/cat-recovery.md | 22 ++++---- _api-reference/cat/cat-repositories.md | 18 +++---- _api-reference/cat/cat-segment-replication.md | 50 ++++++++++--------- _api-reference/cat/cat-segments.md | 22 ++++---- _api-reference/cat/cat-shards.md | 26 +++++----- _api-reference/cat/cat-snapshots.md | 22 ++++---- _api-reference/cat/cat-tasks.md | 26 +++++----- _api-reference/cat/cat-templates.md | 22 ++++---- _api-reference/cat/cat-thread-pool.md | 24 ++++----- .../query-group-lifecycle-api.md | 4 -- 22 files changed, 231 insertions(+), 233 deletions(-) diff --git a/_api-reference/cat/cat-aliases.md b/_api-reference/cat/cat-aliases.md index 3a4580932a..b7cbc2f742 100644 --- a/_api-reference/cat/cat-aliases.md +++ b/_api-reference/cat/cat-aliases.md @@ -39,15 +39,15 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. -Parameter | Data type | Description | Default -:--- | :--- | :--- | :--- -`expand_wildcards` | List or String | Expands wildcard expressions to concrete indexes. Combine multiple values with commas. 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 | Returns help information. | `false` -`local` | Boolean | Whether to return information from the local node only instead of 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` +| Parameter | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `expand_wildcards` | List or String | Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
Valid values are:
- `all`: Match any index, including hidden ones.
- `closed`: Match closed, non-hidden indexes.
- `hidden`: Match hidden indexes. Must be combined with open, closed, or both.
- `none`: Wildcard expressions are not accepted.
- `open`: Match open, non-hidden indexes. | N/A | +| `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | +| `h` | List | A comma-separated list of column names to display. | N/A | +| `help` | Boolean | Returns help information. | `false` | +| `local` | Boolean | Whether to return information from the local node only instead of from the cluster manager node. | `false` | +| `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | +| `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | diff --git a/_api-reference/cat/cat-allocation.md b/_api-reference/cat/cat-allocation.md index eba28f9e3b..17143f4689 100644 --- a/_api-reference/cat/cat-allocation.md +++ b/_api-reference/cat/cat-allocation.md @@ -38,16 +38,16 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. -Parameter | Data type | Description | Default -:--- | :--- | :--- | :--- -`bytes` | String | The units used to display byte values. | -`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 | Returns help information. | `false` -`local` | Boolean | Returns local information but does not retrieve the state from 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` +| Parameter | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | +| `cluster_manager_timeout` | String | A timeout for connection to the cluster manager node. | N/A | +| `format` | String | A short version of the HTTP `Accept` header, such as `json` or `yaml`. | N/A | +| `h` | List | A comma-separated list of column names to display. | N/A | +| `help` | Boolean | Returns help information. | `false` | +| `local` | Boolean | Returns local information but does not retrieve the state from cluster-manager node. | `false` | +| `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | +| `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | ## Example requests diff --git a/_api-reference/cat/cat-cluster_manager.md b/_api-reference/cat/cat-cluster_manager.md index 39baf2a236..da160daf48 100644 --- a/_api-reference/cat/cat-cluster_manager.md +++ b/_api-reference/cat/cat-cluster_manager.md @@ -36,15 +36,15 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. -Parameter | Data 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 | 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` +| Parameter | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `cluster_manager_timeout` | String | A timeout for connection to the cluster manager node. | N/A | +| `format` | String | A short version of the HTTP `Accept` header, such as `json` or `yaml`. | N/A | +| `h` | List | A comma-separated list of column names to display. | N/A | +| `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. | N/A | +| `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 85e9babb1b..d40d252910 100644 --- a/_api-reference/cat/cat-count.md +++ b/_api-reference/cat/cat-count.md @@ -38,13 +38,13 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. -Parameter | Data 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 | 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` +| Parameter | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | +| `h` | List | A comma-separated list of column names to display. | N/A | +| `help` | Boolean | Returns help information. | `false` | +| `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | +| `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | ## Example requests diff --git a/_api-reference/cat/cat-field-data.md b/_api-reference/cat/cat-field-data.md index 708ce2584f..8418cf6c49 100644 --- a/_api-reference/cat/cat-field-data.md +++ b/_api-reference/cat/cat-field-data.md @@ -36,14 +36,14 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. -Parameter | Data 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 | 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` +| Parameter | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | +| `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | +| `h` | List | A comma-separated list of column names to display. | N/A | +| `help` | Boolean | Returns help information. | `false` | +| `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | +| `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | ## Example requests diff --git a/_api-reference/cat/cat-health.md b/_api-reference/cat/cat-health.md index 0268b6ac4b..812a583fc0 100644 --- a/_api-reference/cat/cat-health.md +++ b/_api-reference/cat/cat-health.md @@ -36,15 +36,15 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. -Parameter | Data 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 | 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` -`v` | Boolean | Enables verbose mode, which displays column headers. | `false` +| Parameter | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | +| `h` | List | A comma-separated list of column names to display. | N/A | +| `help` | Boolean | Returns help information. | `false` | +| `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | +| `time` | String | The unit used to display time values.
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | +| `ts` | Boolean | When `true`, returns `HH:MM:SS` and Unix epoch timestamps. | `true` | +| `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | ## Example request diff --git a/_api-reference/cat/cat-indices.md b/_api-reference/cat/cat-indices.md index 2373dbe10c..e29ad1795e 100644 --- a/_api-reference/cat/cat-indices.md +++ b/_api-reference/cat/cat-indices.md @@ -37,21 +37,21 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. -Parameter | Data 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. 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 | 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` -`s` | List | A comma-separated list of column names or column aliases to sort by. | -`time` | String | Specifies the time units. | -`v` | Boolean | Enables verbose mode, which displays column headers. | `false` +| Parameter | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | +| `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | +| `expand_wildcards` | List or String | The type of index that wildcard patterns can match. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
Valid values are:
- `all`: Match any index, including hidden ones.
- `closed`: Match closed, non-hidden indexes.
- `hidden`: Match hidden indexes. Must be combined with open, closed, or both.
- `none`: Wildcard expressions are not accepted.
- `open`: Match open, non-hidden indexes. | N/A | +| `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | +| `h` | List | A comma-separated list of column names to display. | N/A | +| `health` | String | Limits indexes based on their health status. Supported values are `green`, `yellow`, and `red`.
Valid values are: `green`, `GREEN`, `yellow`, `YELLOW`, `red`, `RED` | N/A | +| `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` | +| `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | +| `time` | String | Specifies the time units.
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | +| `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | ## Example requests diff --git a/_api-reference/cat/cat-nodeattrs.md b/_api-reference/cat/cat-nodeattrs.md index 04459050ef..3f0bb7febe 100644 --- a/_api-reference/cat/cat-nodeattrs.md +++ b/_api-reference/cat/cat-nodeattrs.md @@ -36,15 +36,15 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. -Parameter | Data 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 | 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` +| Parameter | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | +| `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | +| `h` | List | A comma-separated list of column names to display. | N/A | +| `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. | N/A | +| `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | ## Example request diff --git a/_api-reference/cat/cat-nodes.md b/_api-reference/cat/cat-nodes.md index 3121071b58..2b08c37c71 100644 --- a/_api-reference/cat/cat-nodes.md +++ b/_api-reference/cat/cat-nodes.md @@ -38,17 +38,17 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. -Parameter | Data 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. | -`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 | 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` +| Parameter | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | +| `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | +| `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | +| `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. | N/A | +| `help` | Boolean | Returns help information. | `false` | +| `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | +| `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | +| `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | ## Example request diff --git a/_api-reference/cat/cat-pending-tasks.md b/_api-reference/cat/cat-pending-tasks.md index 15fa159531..fcb1b746d6 100644 --- a/_api-reference/cat/cat-pending-tasks.md +++ b/_api-reference/cat/cat-pending-tasks.md @@ -36,16 +36,16 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. -Parameter | Data 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 | 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/). | -`v` | Boolean | Enables verbose mode, which displays column headers. | `false` +| Parameter | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | +| `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | +| `h` | List | A comma-separated list of column names to display. | N/A | +| `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. | N/A | +| `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | +| `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | ## Example request diff --git a/_api-reference/cat/cat-pit-segments.md b/_api-reference/cat/cat-pit-segments.md index 76b46c03de..9bde054118 100644 --- a/_api-reference/cat/cat-pit-segments.md +++ b/_api-reference/cat/cat-pit-segments.md @@ -41,14 +41,14 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. -Parameter | Data 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 | 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` +| Parameter | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | +| `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | +| `h` | List | A comma-separated list of column names to display. | N/A | +| `help` | Boolean | Returns help information. | `false` | +| `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | +| `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | ## Request body fields diff --git a/_api-reference/cat/cat-plugins.md b/_api-reference/cat/cat-plugins.md index c931f72a52..7b50ad9afa 100644 --- a/_api-reference/cat/cat-plugins.md +++ b/_api-reference/cat/cat-plugins.md @@ -35,15 +35,15 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. -Parameter | Data 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 | 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` +| Parameter | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | +| `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | +| `h` | List | A comma-separated list of column names to display. | N/A | +| `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. | N/A | +| `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | ## Example request diff --git a/_api-reference/cat/cat-recovery.md b/_api-reference/cat/cat-recovery.md index 4326fb552e..2bc5885bbd 100644 --- a/_api-reference/cat/cat-recovery.md +++ b/_api-reference/cat/cat-recovery.md @@ -37,17 +37,17 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. -Parameter | Data type | Description | Default -:--- | :--- | :--- | :--- -`active_only` | Boolean | If `true`, the response only includes ongoing shard recoveries. | `false` -`bytes` | String | The units used to display byte values. | -`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 | 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` +| Parameter | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `active_only` | Boolean | If `true`, the response only includes ongoing shard recoveries. | `false` | +| `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | +| `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`. | N/A | +| `h` | List | A comma-separated list of column names to display. | N/A | +| `help` | Boolean | Returns help information. | `false` | +| `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | +| `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | +| `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | ## Example requests diff --git a/_api-reference/cat/cat-repositories.md b/_api-reference/cat/cat-repositories.md index 00e8e49b97..0224f5fa7c 100644 --- a/_api-reference/cat/cat-repositories.md +++ b/_api-reference/cat/cat-repositories.md @@ -35,15 +35,15 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. -Parameter | Data 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 | 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` +| Parameter | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | +| `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | +| `h` | List | A comma-separated list of column names to display. | N/A | +| `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. | N/A | +| `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | ## Example request diff --git a/_api-reference/cat/cat-segment-replication.md b/_api-reference/cat/cat-segment-replication.md index 025d2b2c29..a2e7049387 100644 --- a/_api-reference/cat/cat-segment-replication.md +++ b/_api-reference/cat/cat-segment-replication.md @@ -20,7 +20,6 @@ api: cat.segment_replication component: endpoints --> ## Endpoints - ```json GET /_cat/segment_replication GET /_cat/segment_replication/{index} @@ -30,14 +29,16 @@ GET /_cat/segment_replication/{index} ## Path parameters -Parameter | Type | Description -:--- | :--- | :--- -`index` | List | A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. +The following table lists the available path parameters. All path parameters are optional. + +| Parameter | Data type | Description | +| :--- | :--- | :--- | +| `index` | List | A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. | @@ -49,25 +50,26 @@ include_deprecated: false --> ## Query parameters - -Parameter | Type | Description | Default -:--- | :--- | :--- | :--- -`active_only` | Boolean | When `true`, the response only includes ongoing segment replication events. | `false` -`allow_no_indices` | Boolean | Whether to ignore the index if a wildcard index expression resolves to no concrete indexes. This includes the `_all` string or when no indexes have been specified. | -`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 | 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 | 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. | -`shards` | List | A comma-separated list of shards to display. | -`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/). | -`timeout` | String | The operation timeout. | -`v` | Boolean | Enables verbose mode, which displays column headers. | `false` +The following table lists the available query parameters. All query parameters are optional. + +| Parameter | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `active_only` | Boolean | When `true`, the response only includes ongoing segment replication events. | `false` | +| `allow_no_indices` | Boolean | Whether to ignore the index if a wildcard index expression resolves to no concrete indexes. This includes the `_all` string or when no indexes have been specified. | N/A | +| `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | +| `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 | The type of index that wildcard patterns can match. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
Valid values are:
- `all`: Match any index, including hidden ones.
- `closed`: Match closed, non-hidden indexes.
- `hidden`: Match hidden indexes. Must be combined with open, closed, or both.
- `none`: Wildcard expressions are not accepted.
- `open`: Match open, non-hidden indexes. | N/A | +| `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | +| `h` | List | A comma-separated list of column names to display. | N/A | +| `help` | Boolean | Returns help information. | `false` | +| `ignore_throttled` | Boolean | Whether specified concrete, expanded, or aliased indexes should be ignored when throttled. | N/A | +| `ignore_unavailable` | Boolean | Whether the specified concrete indexes should be ignored when missing or closed. | N/A | +| `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | +| `shards` | List | A comma-separated list of shards to display. | N/A | +| `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | +| `timeout` | String | The operation timeout. | N/A | +| `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | ## Path parameters diff --git a/_api-reference/cat/cat-segments.md b/_api-reference/cat/cat-segments.md index 620e133eb5..780ebd69b9 100644 --- a/_api-reference/cat/cat-segments.md +++ b/_api-reference/cat/cat-segments.md @@ -20,7 +20,6 @@ api: cat.segments component: endpoints --> ## Endpoints - ```json GET /_cat/segments GET /_cat/segments/{index} @@ -36,16 +35,17 @@ include_deprecated: false --> ## Query parameters - -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. | -`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 | 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` +The following table lists the available query parameters. All query parameters are optional. + +| Parameter | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | +| `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | +| `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | +| `h` | List | A comma-separated list of column names to display. | N/A | +| `help` | Boolean | Returns help information. | `false` | +| `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | +| `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | ## Example requests diff --git a/_api-reference/cat/cat-shards.md b/_api-reference/cat/cat-shards.md index ce47c9f29e..c1c76465b0 100644 --- a/_api-reference/cat/cat-shards.md +++ b/_api-reference/cat/cat-shards.md @@ -20,7 +20,6 @@ api: cat.shards component: endpoints --> ## Endpoints - ```json GET /_cat/shards GET /_cat/shards/{index} @@ -36,18 +35,19 @@ include_deprecated: false --> ## Query parameters - -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. | -`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 | 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/). | -`v` | Boolean | Enables verbose mode, which displays column headers. | `false` +The following table lists the available query parameters. All query parameters are optional. + +| Parameter | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | +| `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | +| `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | +| `h` | List | A comma-separated list of column names to display. | N/A | +| `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. | N/A | +| `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | +| `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | ## Example requests diff --git a/_api-reference/cat/cat-snapshots.md b/_api-reference/cat/cat-snapshots.md index 1b061bc4d3..8e87c60be1 100644 --- a/_api-reference/cat/cat-snapshots.md +++ b/_api-reference/cat/cat-snapshots.md @@ -20,7 +20,6 @@ api: cat.snapshots component: endpoints --> ## Endpoints - ```json GET /_cat/snapshots GET /_cat/snapshots/{repository} @@ -36,17 +35,18 @@ include_deprecated: false --> ## Query parameters +The following table lists the available query parameters. All query parameters are optional. -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 | 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/). | -`v` | Boolean | Enables verbose mode, which displays column headers. | `false` +| Parameter | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | +| `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | +| `h` | List | A comma-separated list of column names to display. | N/A | +| `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. | N/A | +| `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | +| `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | ## Example request diff --git a/_api-reference/cat/cat-tasks.md b/_api-reference/cat/cat-tasks.md index 02e10105f3..c70cab80e3 100644 --- a/_api-reference/cat/cat-tasks.md +++ b/_api-reference/cat/cat-tasks.md @@ -19,7 +19,6 @@ api: cat.tasks component: endpoints --> ## Endpoints - ```json GET /_cat/tasks ``` @@ -34,19 +33,20 @@ include_deprecated: false --> ## Query parameters +The following table lists the available query parameters. All query parameters are optional. -Parameter | Type | Description | Default -:--- | :--- | :--- | :--- -`actions` | List | The task action names used to limit the response. | -`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 | 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. | -`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` +| Parameter | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `actions` | List | The task action names used to limit the response. | N/A | +| `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`. | N/A | +| `h` | List | A comma-separated list of column names to display. | N/A | +| `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. | N/A | +| `parent_task_id` | String | The parent task identifier, which is used to limit the response. | N/A | +| `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | +| `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | +| `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | ## Example request diff --git a/_api-reference/cat/cat-templates.md b/_api-reference/cat/cat-templates.md index 7bb361f3f2..3d4922abde 100644 --- a/_api-reference/cat/cat-templates.md +++ b/_api-reference/cat/cat-templates.md @@ -20,7 +20,6 @@ api: cat.templates component: endpoints --> ## Endpoints - ```json GET /_cat/templates GET /_cat/templates/{name} @@ -36,16 +35,17 @@ include_deprecated: false --> ## Query parameters - -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 | 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` +The following table lists the available query parameters. All query parameters are optional. + +| Parameter | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | +| `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | +| `h` | List | A comma-separated list of column names to display. | N/A | +| `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. | N/A | +| `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | ## Example requests diff --git a/_api-reference/cat/cat-thread-pool.md b/_api-reference/cat/cat-thread-pool.md index 9c82e283a6..d32945e737 100644 --- a/_api-reference/cat/cat-thread-pool.md +++ b/_api-reference/cat/cat-thread-pool.md @@ -20,7 +20,6 @@ api: cat.thread_pool component: endpoints --> ## Endpoints - ```json GET /_cat/thread_pool GET /_cat/thread_pool/{thread_pool_patterns} @@ -36,17 +35,18 @@ include_deprecated: false --> ## Query parameters - -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 | 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. | -`v` | Boolean | Enables verbose mode, which displays column headers. | `false` +The following table lists the available query parameters. All query parameters are optional. + +| Parameter | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `cluster_manager_timeout` | String | A timeout for connection to the cluster manager node. | N/A | +| `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | +| `h` | List | A comma-separated list of column names to display. | N/A | +| `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. | N/A | +| `size` | Integer | The multiplier in which to display values. | N/A | +| `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | ## Example requests diff --git a/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md b/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md index df4f542b61..d59fd4ecf2 100644 --- a/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md +++ b/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md @@ -20,7 +20,6 @@ api: wlm.create_query_group component: endpoints omit_header: true --> - ```json PUT /_wlm/query_group ``` @@ -33,7 +32,6 @@ api: wlm.create_query_group component: endpoints omit_header: true --> - ```json PUT /_wlm/query_group ``` @@ -46,7 +44,6 @@ api: wlm.get_query_group component: endpoints omit_header: true --> - ```json GET /_wlm/query_group GET /_wlm/query_group/{name} @@ -60,7 +57,6 @@ api: wlm.create_query_group component: endpoints omit_header: true --> - ```json PUT /_wlm/query_group ``` From 03a800d0c08a1cbf1c39172f03b6ff9d08e84d48 Mon Sep 17 00:00:00 2001 From: Archer Date: Fri, 17 Jan 2025 14:13:35 -0600 Subject: [PATCH 12/32] See if an extra space will fix the table. Signed-off-by: Archer --- _api-reference/cat/cat-aliases.md | 1 + 1 file changed, 1 insertion(+) diff --git a/_api-reference/cat/cat-aliases.md b/_api-reference/cat/cat-aliases.md index b7cbc2f742..f4eca4ddd5 100644 --- a/_api-reference/cat/cat-aliases.md +++ b/_api-reference/cat/cat-aliases.md @@ -48,6 +48,7 @@ The following table lists the available query parameters. All query parameters a | `local` | Boolean | Whether to return information from the local node only instead of from the cluster manager node. | `false` | | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + From e0f46663b11bf0e8aa9a1d805bf0a8868f21a66d Mon Sep 17 00:00:00 2001 From: Archer Date: Fri, 17 Jan 2025 14:23:34 -0600 Subject: [PATCH 13/32] Update mustache template to add spaces Signed-off-by: Archer --- spec-insert/lib/renderers/templates/spec_insert.mustache | 2 ++ 1 file changed, 2 insertions(+) diff --git a/spec-insert/lib/renderers/templates/spec_insert.mustache b/spec-insert/lib/renderers/templates/spec_insert.mustache index 63b6323d48..a1d5c49543 100644 --- a/spec-insert/lib/renderers/templates/spec_insert.mustache +++ b/spec-insert/lib/renderers/templates/spec_insert.mustache @@ -3,5 +3,7 @@ {{{key}}}: {{{value}}} {{/arguments}} --> + {{{content}}} + From 658063c1db169778c4b44ba6db83937551f130c6 Mon Sep 17 00:00:00 2001 From: Archer Date: Fri, 17 Jan 2025 14:26:11 -0600 Subject: [PATCH 14/32] Mustache template update Signed-off-by: Archer --- _api-reference/cat/cat-aliases.md | 3 +++ _api-reference/cat/cat-allocation.md | 4 ++++ _api-reference/cat/cat-cluster_manager.md | 4 ++++ _api-reference/cat/cat-count.md | 4 ++++ _api-reference/cat/cat-field-data.md | 4 ++++ _api-reference/cat/cat-health.md | 4 ++++ _api-reference/cat/cat-indices.md | 4 ++++ _api-reference/cat/cat-nodeattrs.md | 4 ++++ _api-reference/cat/cat-nodes.md | 4 ++++ _api-reference/cat/cat-pending-tasks.md | 4 ++++ _api-reference/cat/cat-pit-segments.md | 6 ++++++ _api-reference/cat/cat-plugins.md | 4 ++++ _api-reference/cat/cat-recovery.md | 4 ++++ _api-reference/cat/cat-repositories.md | 4 ++++ _api-reference/cat/cat-segment-replication.md | 6 ++++++ _api-reference/cat/cat-segments.md | 4 ++++ _api-reference/cat/cat-shards.md | 4 ++++ _api-reference/cat/cat-snapshots.md | 4 ++++ _api-reference/cat/cat-tasks.md | 4 ++++ _api-reference/cat/cat-templates.md | 4 ++++ _api-reference/cat/cat-thread-pool.md | 4 ++++ .../workload-management/query-group-lifecycle-api.md | 8 ++++++++ spec-insert/spec/_fixtures/expected_output/endpoints.md | 2 ++ .../spec/_fixtures/expected_output/param_tables.md | 6 ++++++ 24 files changed, 103 insertions(+) diff --git a/_api-reference/cat/cat-aliases.md b/_api-reference/cat/cat-aliases.md index f4eca4ddd5..9c208e9a60 100644 --- a/_api-reference/cat/cat-aliases.md +++ b/_api-reference/cat/cat-aliases.md @@ -21,11 +21,13 @@ The CAT aliases operation lists the mapping of aliases to indexes, plus routing api: cat.aliases component: endpoints --> + ## Endpoints ```json GET /_cat/aliases GET /_cat/aliases/{name} ``` + @@ -35,6 +37,7 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> + ## Query parameters The following table lists the available query parameters. All query parameters are optional. diff --git a/_api-reference/cat/cat-allocation.md b/_api-reference/cat/cat-allocation.md index 17143f4689..8ecf4ce89b 100644 --- a/_api-reference/cat/cat-allocation.md +++ b/_api-reference/cat/cat-allocation.md @@ -20,11 +20,13 @@ The CAT allocation operation lists the allocation of disk space for indexes and api: cat.allocation component: endpoints --> + ## Endpoints ```json GET /_cat/allocation GET /_cat/allocation/{node_id} ``` + @@ -34,6 +36,7 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> + ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -48,6 +51,7 @@ The following table lists the available query parameters. All query parameters a | `local` | Boolean | Returns local information but does not retrieve the state from cluster-manager node. | `false` | | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example requests diff --git a/_api-reference/cat/cat-cluster_manager.md b/_api-reference/cat/cat-cluster_manager.md index da160daf48..ecb5ca9387 100644 --- a/_api-reference/cat/cat-cluster_manager.md +++ b/_api-reference/cat/cat-cluster_manager.md @@ -19,10 +19,12 @@ The CAT cluster manager operation lists information that helps identify the elec api: cat.cluster_manager component: endpoints --> + ## Endpoints ```json GET /_cat/cluster_manager ``` + @@ -32,6 +34,7 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> + ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -45,6 +48,7 @@ The following table lists the available query parameters. All query parameters a | `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. | N/A | | `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 d40d252910..ed44efe2de 100644 --- a/_api-reference/cat/cat-count.md +++ b/_api-reference/cat/cat-count.md @@ -20,11 +20,13 @@ The CAT count operation lists the number of documents in your cluster. api: cat.count component: endpoints --> + ## Endpoints ```json GET /_cat/count GET /_cat/count/{index} ``` + @@ -34,6 +36,7 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> + ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -45,6 +48,7 @@ The following table lists the available query parameters. All query parameters a | `help` | Boolean | Returns help information. | `false` | | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example requests diff --git a/_api-reference/cat/cat-field-data.md b/_api-reference/cat/cat-field-data.md index 8418cf6c49..d1cfd019dc 100644 --- a/_api-reference/cat/cat-field-data.md +++ b/_api-reference/cat/cat-field-data.md @@ -18,11 +18,13 @@ The CAT Field Data operation lists the memory size used by each field per node. api: cat.fielddata component: endpoints --> + ## Endpoints ```json GET /_cat/fielddata GET /_cat/fielddata/{fields} ``` + @@ -32,6 +34,7 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> + ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -44,6 +47,7 @@ The following table lists the available query parameters. All query parameters a | `help` | Boolean | Returns help information. | `false` | | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example requests diff --git a/_api-reference/cat/cat-health.md b/_api-reference/cat/cat-health.md index 812a583fc0..2304188858 100644 --- a/_api-reference/cat/cat-health.md +++ b/_api-reference/cat/cat-health.md @@ -19,10 +19,12 @@ The CAT health operation lists the status of the cluster, how long the cluster h api: cat.health component: endpoints --> + ## Endpoints ```json GET /_cat/health ``` + @@ -32,6 +34,7 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> + ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -45,6 +48,7 @@ The following table lists the available query parameters. All query parameters a | `time` | String | The unit used to display time values.
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `ts` | Boolean | When `true`, returns `HH:MM:SS` and Unix epoch timestamps. | `true` | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example request diff --git a/_api-reference/cat/cat-indices.md b/_api-reference/cat/cat-indices.md index e29ad1795e..c99efaaf71 100644 --- a/_api-reference/cat/cat-indices.md +++ b/_api-reference/cat/cat-indices.md @@ -19,11 +19,13 @@ The CAT indices operation lists information related to indexes, that is, how muc api: cat.indices component: endpoints --> + ## Endpoints ```json GET /_cat/indices GET /_cat/indices/{index} ``` + @@ -33,6 +35,7 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> + ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -52,6 +55,7 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `time` | String | Specifies the time units.
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example requests diff --git a/_api-reference/cat/cat-nodeattrs.md b/_api-reference/cat/cat-nodeattrs.md index 3f0bb7febe..4c6f143c8b 100644 --- a/_api-reference/cat/cat-nodeattrs.md +++ b/_api-reference/cat/cat-nodeattrs.md @@ -19,10 +19,12 @@ The CAT nodeattrs operation lists the attributes of custom nodes. api: cat.nodeattrs component: endpoints --> + ## Endpoints ```json GET /_cat/nodeattrs ``` + @@ -32,6 +34,7 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> + ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -45,6 +48,7 @@ The following table lists the available query parameters. All query parameters a | `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. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example request diff --git a/_api-reference/cat/cat-nodes.md b/_api-reference/cat/cat-nodes.md index 2b08c37c71..21fa13b40a 100644 --- a/_api-reference/cat/cat-nodes.md +++ b/_api-reference/cat/cat-nodes.md @@ -21,10 +21,12 @@ A few important node metrics are `pid`, `name`, `cluster_manager`, `ip`, `port`, api: cat.nodes component: endpoints --> + ## Endpoints ```json GET /_cat/nodes ``` + @@ -34,6 +36,7 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> + ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -49,6 +52,7 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example request diff --git a/_api-reference/cat/cat-pending-tasks.md b/_api-reference/cat/cat-pending-tasks.md index fcb1b746d6..6677228e7f 100644 --- a/_api-reference/cat/cat-pending-tasks.md +++ b/_api-reference/cat/cat-pending-tasks.md @@ -19,10 +19,12 @@ The CAT pending tasks operation lists the progress of all pending tasks, includi api: cat.pending_tasks component: endpoints --> + ## Endpoints ```json GET /_cat/pending_tasks ``` + @@ -32,6 +34,7 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> + ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -46,6 +49,7 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example request diff --git a/_api-reference/cat/cat-pit-segments.md b/_api-reference/cat/cat-pit-segments.md index 9bde054118..24b6fc6243 100644 --- a/_api-reference/cat/cat-pit-segments.md +++ b/_api-reference/cat/cat-pit-segments.md @@ -16,9 +16,11 @@ api: cat.pit_segments component: endpoints omit_header: true --> + ```json GET /_cat/pit_segments ``` + + ```json GET /_cat/pit_segments/_all ``` + + ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -49,6 +54,7 @@ The following table lists the available query parameters. All query parameters a | `help` | Boolean | Returns help information. | `false` | | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Request body fields diff --git a/_api-reference/cat/cat-plugins.md b/_api-reference/cat/cat-plugins.md index 7b50ad9afa..c989aa012b 100644 --- a/_api-reference/cat/cat-plugins.md +++ b/_api-reference/cat/cat-plugins.md @@ -18,10 +18,12 @@ The CAT plugins operation lists the names, components, and versions of the insta api: cat.plugins component: endpoints --> + ## Endpoints ```json GET /_cat/plugins ``` + @@ -31,6 +33,7 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> + ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -44,6 +47,7 @@ The following table lists the available query parameters. All query parameters a | `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. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example request diff --git a/_api-reference/cat/cat-recovery.md b/_api-reference/cat/cat-recovery.md index 2bc5885bbd..7f4afc6276 100644 --- a/_api-reference/cat/cat-recovery.md +++ b/_api-reference/cat/cat-recovery.md @@ -19,11 +19,13 @@ The CAT recovery operation lists all completed and ongoing index and shard recov api: cat.recovery component: endpoints --> + ## Endpoints ```json GET /_cat/recovery GET /_cat/recovery/{index} ``` + @@ -33,6 +35,7 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> + ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -48,6 +51,7 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example requests diff --git a/_api-reference/cat/cat-repositories.md b/_api-reference/cat/cat-repositories.md index 0224f5fa7c..83d0828759 100644 --- a/_api-reference/cat/cat-repositories.md +++ b/_api-reference/cat/cat-repositories.md @@ -18,10 +18,12 @@ The CAT repositories operation lists all snapshot repositories for a cluster. api: cat.repositories component: endpoints --> + ## Endpoints ```json GET /_cat/repositories ``` + @@ -31,6 +33,7 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> + ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -44,6 +47,7 @@ The following table lists the available query parameters. All query parameters a | `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. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example request diff --git a/_api-reference/cat/cat-segment-replication.md b/_api-reference/cat/cat-segment-replication.md index a2e7049387..60d7360a9f 100644 --- a/_api-reference/cat/cat-segment-replication.md +++ b/_api-reference/cat/cat-segment-replication.md @@ -19,11 +19,13 @@ Call the CAT Segment Replication API only on indexes with segment replication en api: cat.segment_replication component: endpoints --> + ## Endpoints ```json GET /_cat/segment_replication GET /_cat/segment_replication/{index} ``` + + ## Path parameters The following table lists the available path parameters. All path parameters are optional. @@ -39,6 +42,7 @@ The following table lists the available path parameters. All path parameters are | Parameter | Data type | Description | | :--- | :--- | :--- | | `index` | List | A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. | + @@ -48,6 +52,7 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> + ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -70,6 +75,7 @@ The following table lists the available query parameters. All query parameters a | `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `timeout` | String | The operation timeout. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Path parameters diff --git a/_api-reference/cat/cat-segments.md b/_api-reference/cat/cat-segments.md index 780ebd69b9..0e3a29c8ad 100644 --- a/_api-reference/cat/cat-segments.md +++ b/_api-reference/cat/cat-segments.md @@ -19,11 +19,13 @@ The cat segments operation lists Lucene segment-level information for each index api: cat.segments component: endpoints --> + ## Endpoints ```json GET /_cat/segments GET /_cat/segments/{index} ``` + @@ -33,6 +35,7 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> + ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -46,6 +49,7 @@ The following table lists the available query parameters. All query parameters a | `help` | Boolean | Returns help information. | `false` | | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example requests diff --git a/_api-reference/cat/cat-shards.md b/_api-reference/cat/cat-shards.md index c1c76465b0..649640ab06 100644 --- a/_api-reference/cat/cat-shards.md +++ b/_api-reference/cat/cat-shards.md @@ -19,11 +19,13 @@ The CAT shards operation lists the state of all primary and replica shards and h api: cat.shards component: endpoints --> + ## Endpoints ```json GET /_cat/shards GET /_cat/shards/{index} ``` + @@ -33,6 +35,7 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> + ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -48,6 +51,7 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example requests diff --git a/_api-reference/cat/cat-snapshots.md b/_api-reference/cat/cat-snapshots.md index 8e87c60be1..208ab91e48 100644 --- a/_api-reference/cat/cat-snapshots.md +++ b/_api-reference/cat/cat-snapshots.md @@ -19,11 +19,13 @@ The CAT snapshots operation lists all snapshots for a repository. api: cat.snapshots component: endpoints --> + ## Endpoints ```json GET /_cat/snapshots GET /_cat/snapshots/{repository} ``` + @@ -33,6 +35,7 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> + ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -47,6 +50,7 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example request diff --git a/_api-reference/cat/cat-tasks.md b/_api-reference/cat/cat-tasks.md index c70cab80e3..18bdd89bc5 100644 --- a/_api-reference/cat/cat-tasks.md +++ b/_api-reference/cat/cat-tasks.md @@ -18,10 +18,12 @@ The CAT tasks operation lists the progress of all tasks currently running on you api: cat.tasks component: endpoints --> + ## Endpoints ```json GET /_cat/tasks ``` + @@ -31,6 +33,7 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> + ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -47,6 +50,7 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example request diff --git a/_api-reference/cat/cat-templates.md b/_api-reference/cat/cat-templates.md index 3d4922abde..c8cf73e976 100644 --- a/_api-reference/cat/cat-templates.md +++ b/_api-reference/cat/cat-templates.md @@ -19,11 +19,13 @@ The CAT templates operation lists the names, patterns, order numbers, and versio api: cat.templates component: endpoints --> + ## Endpoints ```json GET /_cat/templates GET /_cat/templates/{name} ``` + @@ -33,6 +35,7 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> + ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -46,6 +49,7 @@ The following table lists the available query parameters. All query parameters a | `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. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example requests diff --git a/_api-reference/cat/cat-thread-pool.md b/_api-reference/cat/cat-thread-pool.md index d32945e737..b6f380abd3 100644 --- a/_api-reference/cat/cat-thread-pool.md +++ b/_api-reference/cat/cat-thread-pool.md @@ -19,11 +19,13 @@ The CAT thread pool operation lists the active, queued, and rejected threads of api: cat.thread_pool component: endpoints --> + ## Endpoints ```json GET /_cat/thread_pool GET /_cat/thread_pool/{thread_pool_patterns} ``` + @@ -33,6 +35,7 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> + ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -47,6 +50,7 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `size` | Integer | The multiplier in which to display values. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example requests diff --git a/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md b/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md index d59fd4ecf2..e4b7bfd5c1 100644 --- a/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md +++ b/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md @@ -20,9 +20,11 @@ api: wlm.create_query_group component: endpoints omit_header: true --> + ```json PUT /_wlm/query_group ``` + ### Update a query group @@ -32,9 +34,11 @@ api: wlm.create_query_group component: endpoints omit_header: true --> + ```json PUT /_wlm/query_group ``` + ### Get a query group @@ -44,10 +48,12 @@ api: wlm.get_query_group component: endpoints omit_header: true --> + ```json GET /_wlm/query_group GET /_wlm/query_group/{name} ``` + ### Delete a query group @@ -57,9 +63,11 @@ api: wlm.create_query_group component: endpoints omit_header: true --> + ```json PUT /_wlm/query_group ``` + diff --git a/spec-insert/spec/_fixtures/expected_output/endpoints.md b/spec-insert/spec/_fixtures/expected_output/endpoints.md index cffad018cb..81abf711bd 100644 --- a/spec-insert/spec/_fixtures/expected_output/endpoints.md +++ b/spec-insert/spec/_fixtures/expected_output/endpoints.md @@ -3,6 +3,7 @@ api: search component: endpoints --> + ## Endpoints ```json GET /_search @@ -10,4 +11,5 @@ POST /_search GET /{index}/_search POST /{index}/_search ``` + diff --git a/spec-insert/spec/_fixtures/expected_output/param_tables.md b/spec-insert/spec/_fixtures/expected_output/param_tables.md index 910ea89e57..b1d228b7c5 100644 --- a/spec-insert/spec/_fixtures/expected_output/param_tables.md +++ b/spec-insert/spec/_fixtures/expected_output/param_tables.md @@ -22,6 +22,7 @@ include_global: true pretty: true columns: Data type, Parameter, Description, Required, Default --> + ## Query parameters The following table lists the available query parameters. @@ -33,6 +34,7 @@ The following table lists the available query parameters. | List or String | `expand_wildcards` | Comma-separated list of expand wildcard options.
Valid values are: `open`, `closed`, `none`, `all` | _Optional_ | N/A | | Boolean | `pretty` | Whether to pretty format the returned JSON response. | _Optional_ | N/A | | Boolean | `human`
_DEPRECATED_ | _(Deprecated since 3.0: Use the `format` parameter instead.)_ Whether to return human readable values for statistics. | _Optional_ | `true` | + Query Parameters Example with only Parameter and Description Columns @@ -43,11 +45,13 @@ component: query_parameters columns: Parameter, Description omit_header: true --> + | Parameter | Description | | :--- | :--- | | `analyze_wildcard` | **(Required)** If true, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified. _(Default: `false`)_ | | `analyzer` | Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified. | | `expand_wildcards` | Comma-separated list of expand wildcard options.
Valid values are: `open`, `closed`, `none`, `all` | + Optional Params Text @@ -57,6 +61,7 @@ api: cat.health component: query_parameters include_global: true --> + ## Query parameters The following table lists the available query parameters. @@ -66,4 +71,5 @@ The following table lists the available query parameters. | `expand_wildcard` | **Required** | String | Whether to expand wildcard expression to concrete indices that are open, closed, or both.
Valid values are:
- `open`: Expand wildcards to open indices only.
- `closed`: Expand wildcards to closed indices only.
- `none`: Do not expand wildcards. | N/A | | `pretty` | _Optional_ | Boolean | Whether to pretty format the returned JSON response. | N/A | | `human`
_DEPRECATED_ | _Optional_ | Boolean | _(Deprecated since 3.0: Use the `format` parameter instead.)_ Whether to return human readable values for statistics. | `true` | + From db7760db60b9fdfeb0fd7cf085fb82d634e8616c Mon Sep 17 00:00:00 2001 From: Archer Date: Fri, 17 Jan 2025 14:29:13 -0600 Subject: [PATCH 15/32] Update expected output. Signed-off-by: Archer --- spec-insert/spec/_fixtures/expected_output/param_tables.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/spec-insert/spec/_fixtures/expected_output/param_tables.md b/spec-insert/spec/_fixtures/expected_output/param_tables.md index b1d228b7c5..6491d5347f 100644 --- a/spec-insert/spec/_fixtures/expected_output/param_tables.md +++ b/spec-insert/spec/_fixtures/expected_output/param_tables.md @@ -4,6 +4,7 @@ Typical Path Parameters Example api: search component: path_parameters --> + ## Path parameters The following table lists the available path parameters. All path parameters are optional. @@ -11,6 +12,7 @@ The following table lists the available path parameters. All path parameters are | Parameter | Data type | Description | | :--- | :--- | :--- | | `index` | List or String | Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams and indexes, omit this parameter or use `*` or `_all`.
Valid values are: `_all`, `_any`, `_none` | + Query Parameters Example with Global Parameters, Pretty Print, and Custom Columns From 4035f063c65a5fa9b7bdd4671b9fe76dac6b5013 Mon Sep 17 00:00:00 2001 From: Archer Date: Fri, 17 Jan 2025 14:40:52 -0600 Subject: [PATCH 16/32] Add lines to renderer. Signed-off-by: Archer --- spec-insert/lib/renderers/table_renderer.rb | 2 ++ spec-insert/lib/renderers/templates/spec_insert.mustache | 2 -- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/spec-insert/lib/renderers/table_renderer.rb b/spec-insert/lib/renderers/table_renderer.rb index afd2921c1d..89b81ed4d0 100644 --- a/spec-insert/lib/renderers/table_renderer.rb +++ b/spec-insert/lib/renderers/table_renderer.rb @@ -25,11 +25,13 @@ def initialize(columns, rows, pretty:) @pretty = pretty end + # @return [Array] def render_lines calculate_column_widths if @pretty [render_column, render_divider] + render_rows end + private diff --git a/spec-insert/lib/renderers/templates/spec_insert.mustache b/spec-insert/lib/renderers/templates/spec_insert.mustache index a1d5c49543..63b6323d48 100644 --- a/spec-insert/lib/renderers/templates/spec_insert.mustache +++ b/spec-insert/lib/renderers/templates/spec_insert.mustache @@ -3,7 +3,5 @@ {{{key}}}: {{{value}}} {{/arguments}} --> - {{{content}}} - From d27cd84da5a3dc1135a6ec475adb609b4d081404 Mon Sep 17 00:00:00 2001 From: Archer Date: Fri, 17 Jan 2025 14:48:32 -0600 Subject: [PATCH 17/32] Add new lines Signed-off-by: Archer --- spec-insert/lib/renderers/table_renderer.rb | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/spec-insert/lib/renderers/table_renderer.rb b/spec-insert/lib/renderers/table_renderer.rb index 89b81ed4d0..0375529618 100644 --- a/spec-insert/lib/renderers/table_renderer.rb +++ b/spec-insert/lib/renderers/table_renderer.rb @@ -25,13 +25,11 @@ def initialize(columns, rows, pretty:) @pretty = pretty end - # @return [Array] def render_lines calculate_column_widths if @pretty - [render_column, render_divider] + render_rows + \n [render_column, render_divider] \n + render_rows end - private From ac5421a2dee58e413bea84d07e900bd3f5afe8d0 Mon Sep 17 00:00:00 2001 From: Archer Date: Fri, 17 Jan 2025 14:50:45 -0600 Subject: [PATCH 18/32] Try another way Signed-off-by: Archer --- spec-insert/lib/renderers/table_renderer.rb | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/spec-insert/lib/renderers/table_renderer.rb b/spec-insert/lib/renderers/table_renderer.rb index 0375529618..7d2ea6348c 100644 --- a/spec-insert/lib/renderers/table_renderer.rb +++ b/spec-insert/lib/renderers/table_renderer.rb @@ -27,8 +27,10 @@ def initialize(columns, rows, pretty:) # @return [Array] def render_lines + \n calculate_column_widths if @pretty - \n [render_column, render_divider] \n + render_rows + [render_column, render_divider] + render_rows + \n end private From 8dcf38a99f8afdeed4d4a413388d0d8386862f2d Mon Sep 17 00:00:00 2001 From: Archer Date: Fri, 17 Jan 2025 15:01:34 -0600 Subject: [PATCH 19/32] Fix mustache spec Signed-off-by: Archer --- spec-insert/lib/renderers/table_renderer.rb | 2 -- spec-insert/lib/renderers/templates/spec_insert.mustache | 2 ++ 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/spec-insert/lib/renderers/table_renderer.rb b/spec-insert/lib/renderers/table_renderer.rb index 7d2ea6348c..afd2921c1d 100644 --- a/spec-insert/lib/renderers/table_renderer.rb +++ b/spec-insert/lib/renderers/table_renderer.rb @@ -27,10 +27,8 @@ def initialize(columns, rows, pretty:) # @return [Array] def render_lines - \n calculate_column_widths if @pretty [render_column, render_divider] + render_rows - \n end private diff --git a/spec-insert/lib/renderers/templates/spec_insert.mustache b/spec-insert/lib/renderers/templates/spec_insert.mustache index 63b6323d48..a1d5c49543 100644 --- a/spec-insert/lib/renderers/templates/spec_insert.mustache +++ b/spec-insert/lib/renderers/templates/spec_insert.mustache @@ -3,5 +3,7 @@ {{{key}}}: {{{value}}} {{/arguments}} --> + {{{content}}} + From daec3e417963c95c149b876216fbdd5896a84642 Mon Sep 17 00:00:00 2001 From: Archer Date: Fri, 17 Jan 2025 15:05:03 -0600 Subject: [PATCH 20/32] Add line breaks correctly. Signed-off-by: Archer --- spec-insert/lib/renderers/table_renderer.rb | 2 +- spec-insert/lib/renderers/templates/spec_insert.mustache | 2 -- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/spec-insert/lib/renderers/table_renderer.rb b/spec-insert/lib/renderers/table_renderer.rb index afd2921c1d..b1a88b6b6d 100644 --- a/spec-insert/lib/renderers/table_renderer.rb +++ b/spec-insert/lib/renderers/table_renderer.rb @@ -28,7 +28,7 @@ def initialize(columns, rows, pretty:) # @return [Array] def render_lines calculate_column_widths if @pretty - [render_column, render_divider] + render_rows + ["\n", render_column, render_divider] + render_rows + ["\n"] + render_rows end private diff --git a/spec-insert/lib/renderers/templates/spec_insert.mustache b/spec-insert/lib/renderers/templates/spec_insert.mustache index a1d5c49543..63b6323d48 100644 --- a/spec-insert/lib/renderers/templates/spec_insert.mustache +++ b/spec-insert/lib/renderers/templates/spec_insert.mustache @@ -3,7 +3,5 @@ {{{key}}}: {{{value}}} {{/arguments}} --> - {{{content}}} - From e1fc7db0ac208ddefc64ce1be36c908929c74b64 Mon Sep 17 00:00:00 2001 From: Archer Date: Fri, 17 Jan 2025 15:31:46 -0600 Subject: [PATCH 21/32] Update endpoint expected output. Signed-off-by: Archer --- spec-insert/spec/_fixtures/expected_output/endpoints.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/spec-insert/spec/_fixtures/expected_output/endpoints.md b/spec-insert/spec/_fixtures/expected_output/endpoints.md index 81abf711bd..cffad018cb 100644 --- a/spec-insert/spec/_fixtures/expected_output/endpoints.md +++ b/spec-insert/spec/_fixtures/expected_output/endpoints.md @@ -3,7 +3,6 @@ api: search component: endpoints --> - ## Endpoints ```json GET /_search @@ -11,5 +10,4 @@ POST /_search GET /{index}/_search POST /{index}/_search ``` - From 7fc3b0e2f1bee25765df7eeb98a68a9468bbbcc5 Mon Sep 17 00:00:00 2001 From: Archer Date: Fri, 17 Jan 2025 15:54:35 -0600 Subject: [PATCH 22/32] Fix renderer spacing. Fix tests. Signed-off-by: Archer --- _api-reference/cat/cat-aliases.md | 4 +--- _api-reference/cat/cat-allocation.md | 4 +--- _api-reference/cat/cat-cluster_manager.md | 4 +--- _api-reference/cat/cat-count.md | 4 +--- _api-reference/cat/cat-field-data.md | 4 +--- _api-reference/cat/cat-health.md | 4 +--- _api-reference/cat/cat-indices.md | 4 +--- _api-reference/cat/cat-nodeattrs.md | 4 +--- _api-reference/cat/cat-nodes.md | 4 +--- _api-reference/cat/cat-pending-tasks.md | 4 +--- _api-reference/cat/cat-pit-segments.md | 6 +----- _api-reference/cat/cat-plugins.md | 4 +--- _api-reference/cat/cat-recovery.md | 4 +--- _api-reference/cat/cat-repositories.md | 4 +--- _api-reference/cat/cat-segment-replication.md | 6 ++---- _api-reference/cat/cat-segments.md | 4 +--- _api-reference/cat/cat-shards.md | 4 +--- _api-reference/cat/cat-snapshots.md | 4 +--- _api-reference/cat/cat-tasks.md | 4 +--- _api-reference/cat/cat-templates.md | 4 +--- _api-reference/cat/cat-thread-pool.md | 4 +--- .../workload-management/query-group-lifecycle-api.md | 8 -------- spec-insert/lib/renderers/table_renderer.rb | 2 +- .../spec/_fixtures/expected_output/param_tables.md | 4 ++++ 24 files changed, 27 insertions(+), 75 deletions(-) diff --git a/_api-reference/cat/cat-aliases.md b/_api-reference/cat/cat-aliases.md index 9c208e9a60..90da9c4842 100644 --- a/_api-reference/cat/cat-aliases.md +++ b/_api-reference/cat/cat-aliases.md @@ -21,13 +21,11 @@ The CAT aliases operation lists the mapping of aliases to indexes, plus routing api: cat.aliases component: endpoints --> - ## Endpoints ```json GET /_cat/aliases GET /_cat/aliases/{name} ``` - @@ -37,7 +35,6 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> - ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -52,6 +49,7 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + diff --git a/_api-reference/cat/cat-allocation.md b/_api-reference/cat/cat-allocation.md index 8ecf4ce89b..af7b0d5ef7 100644 --- a/_api-reference/cat/cat-allocation.md +++ b/_api-reference/cat/cat-allocation.md @@ -20,13 +20,11 @@ The CAT allocation operation lists the allocation of disk space for indexes and api: cat.allocation component: endpoints --> - ## Endpoints ```json GET /_cat/allocation GET /_cat/allocation/{node_id} ``` - @@ -36,7 +34,6 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> - ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -52,6 +49,7 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example requests diff --git a/_api-reference/cat/cat-cluster_manager.md b/_api-reference/cat/cat-cluster_manager.md index ecb5ca9387..92495cf218 100644 --- a/_api-reference/cat/cat-cluster_manager.md +++ b/_api-reference/cat/cat-cluster_manager.md @@ -19,12 +19,10 @@ The CAT cluster manager operation lists information that helps identify the elec api: cat.cluster_manager component: endpoints --> - ## Endpoints ```json GET /_cat/cluster_manager ``` - @@ -34,7 +32,6 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> - ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -49,6 +46,7 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `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 ed44efe2de..d1655e4fcf 100644 --- a/_api-reference/cat/cat-count.md +++ b/_api-reference/cat/cat-count.md @@ -20,13 +20,11 @@ The CAT count operation lists the number of documents in your cluster. api: cat.count component: endpoints --> - ## Endpoints ```json GET /_cat/count GET /_cat/count/{index} ``` - @@ -36,7 +34,6 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> - ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -49,6 +46,7 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example requests diff --git a/_api-reference/cat/cat-field-data.md b/_api-reference/cat/cat-field-data.md index d1cfd019dc..5bee414a24 100644 --- a/_api-reference/cat/cat-field-data.md +++ b/_api-reference/cat/cat-field-data.md @@ -18,13 +18,11 @@ The CAT Field Data operation lists the memory size used by each field per node. api: cat.fielddata component: endpoints --> - ## Endpoints ```json GET /_cat/fielddata GET /_cat/fielddata/{fields} ``` - @@ -34,7 +32,6 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> - ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -48,6 +45,7 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example requests diff --git a/_api-reference/cat/cat-health.md b/_api-reference/cat/cat-health.md index 2304188858..cabdb2d999 100644 --- a/_api-reference/cat/cat-health.md +++ b/_api-reference/cat/cat-health.md @@ -19,12 +19,10 @@ The CAT health operation lists the status of the cluster, how long the cluster h api: cat.health component: endpoints --> - ## Endpoints ```json GET /_cat/health ``` - @@ -34,7 +32,6 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> - ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -49,6 +46,7 @@ The following table lists the available query parameters. All query parameters a | `ts` | Boolean | When `true`, returns `HH:MM:SS` and Unix epoch timestamps. | `true` | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example request diff --git a/_api-reference/cat/cat-indices.md b/_api-reference/cat/cat-indices.md index c99efaaf71..df48f64f02 100644 --- a/_api-reference/cat/cat-indices.md +++ b/_api-reference/cat/cat-indices.md @@ -19,13 +19,11 @@ The CAT indices operation lists information related to indexes, that is, how muc api: cat.indices component: endpoints --> - ## Endpoints ```json GET /_cat/indices GET /_cat/indices/{index} ``` - @@ -35,7 +33,6 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> - ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -56,6 +53,7 @@ The following table lists the available query parameters. All query parameters a | `time` | String | Specifies the time units.
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example requests diff --git a/_api-reference/cat/cat-nodeattrs.md b/_api-reference/cat/cat-nodeattrs.md index 4c6f143c8b..518080e4ad 100644 --- a/_api-reference/cat/cat-nodeattrs.md +++ b/_api-reference/cat/cat-nodeattrs.md @@ -19,12 +19,10 @@ The CAT nodeattrs operation lists the attributes of custom nodes. api: cat.nodeattrs component: endpoints --> - ## Endpoints ```json GET /_cat/nodeattrs ``` - @@ -34,7 +32,6 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> - ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -49,6 +46,7 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example request diff --git a/_api-reference/cat/cat-nodes.md b/_api-reference/cat/cat-nodes.md index 21fa13b40a..270d638863 100644 --- a/_api-reference/cat/cat-nodes.md +++ b/_api-reference/cat/cat-nodes.md @@ -21,12 +21,10 @@ A few important node metrics are `pid`, `name`, `cluster_manager`, `ip`, `port`, api: cat.nodes component: endpoints --> - ## Endpoints ```json GET /_cat/nodes ``` - @@ -36,7 +34,6 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> - ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -53,6 +50,7 @@ The following table lists the available query parameters. All query parameters a | `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example request diff --git a/_api-reference/cat/cat-pending-tasks.md b/_api-reference/cat/cat-pending-tasks.md index 6677228e7f..15b4d2a562 100644 --- a/_api-reference/cat/cat-pending-tasks.md +++ b/_api-reference/cat/cat-pending-tasks.md @@ -19,12 +19,10 @@ The CAT pending tasks operation lists the progress of all pending tasks, includi api: cat.pending_tasks component: endpoints --> - ## Endpoints ```json GET /_cat/pending_tasks ``` - @@ -34,7 +32,6 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> - ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -50,6 +47,7 @@ The following table lists the available query parameters. All query parameters a | `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example request diff --git a/_api-reference/cat/cat-pit-segments.md b/_api-reference/cat/cat-pit-segments.md index 24b6fc6243..411349f75c 100644 --- a/_api-reference/cat/cat-pit-segments.md +++ b/_api-reference/cat/cat-pit-segments.md @@ -16,11 +16,9 @@ api: cat.pit_segments component: endpoints omit_header: true --> - ```json GET /_cat/pit_segments ``` - - ```json GET /_cat/pit_segments/_all ``` - - ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -55,6 +50,7 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Request body fields diff --git a/_api-reference/cat/cat-plugins.md b/_api-reference/cat/cat-plugins.md index c989aa012b..ab5e4653a7 100644 --- a/_api-reference/cat/cat-plugins.md +++ b/_api-reference/cat/cat-plugins.md @@ -18,12 +18,10 @@ The CAT plugins operation lists the names, components, and versions of the insta api: cat.plugins component: endpoints --> - ## Endpoints ```json GET /_cat/plugins ``` - @@ -33,7 +31,6 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> - ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -48,6 +45,7 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example request diff --git a/_api-reference/cat/cat-recovery.md b/_api-reference/cat/cat-recovery.md index 7f4afc6276..877ad00d1d 100644 --- a/_api-reference/cat/cat-recovery.md +++ b/_api-reference/cat/cat-recovery.md @@ -19,13 +19,11 @@ The CAT recovery operation lists all completed and ongoing index and shard recov api: cat.recovery component: endpoints --> - ## Endpoints ```json GET /_cat/recovery GET /_cat/recovery/{index} ``` - @@ -35,7 +33,6 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> - ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -52,6 +49,7 @@ The following table lists the available query parameters. All query parameters a | `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example requests diff --git a/_api-reference/cat/cat-repositories.md b/_api-reference/cat/cat-repositories.md index 83d0828759..d91f817525 100644 --- a/_api-reference/cat/cat-repositories.md +++ b/_api-reference/cat/cat-repositories.md @@ -18,12 +18,10 @@ The CAT repositories operation lists all snapshot repositories for a cluster. api: cat.repositories component: endpoints --> - ## Endpoints ```json GET /_cat/repositories ``` - @@ -33,7 +31,6 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> - ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -48,6 +45,7 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example request diff --git a/_api-reference/cat/cat-segment-replication.md b/_api-reference/cat/cat-segment-replication.md index 60d7360a9f..b631530782 100644 --- a/_api-reference/cat/cat-segment-replication.md +++ b/_api-reference/cat/cat-segment-replication.md @@ -19,13 +19,11 @@ Call the CAT Segment Replication API only on indexes with segment replication en api: cat.segment_replication component: endpoints --> - ## Endpoints ```json GET /_cat/segment_replication GET /_cat/segment_replication/{index} ``` - - ## Path parameters The following table lists the available path parameters. All path parameters are optional. @@ -43,6 +40,7 @@ The following table lists the available path parameters. All path parameters are | :--- | :--- | :--- | | `index` | List | A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. | + @@ -52,7 +50,6 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> - ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -76,6 +73,7 @@ The following table lists the available query parameters. All query parameters a | `timeout` | String | The operation timeout. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Path parameters diff --git a/_api-reference/cat/cat-segments.md b/_api-reference/cat/cat-segments.md index 0e3a29c8ad..9f722aaad9 100644 --- a/_api-reference/cat/cat-segments.md +++ b/_api-reference/cat/cat-segments.md @@ -19,13 +19,11 @@ The cat segments operation lists Lucene segment-level information for each index api: cat.segments component: endpoints --> - ## Endpoints ```json GET /_cat/segments GET /_cat/segments/{index} ``` - @@ -35,7 +33,6 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> - ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -50,6 +47,7 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example requests diff --git a/_api-reference/cat/cat-shards.md b/_api-reference/cat/cat-shards.md index 649640ab06..1a0f662670 100644 --- a/_api-reference/cat/cat-shards.md +++ b/_api-reference/cat/cat-shards.md @@ -19,13 +19,11 @@ The CAT shards operation lists the state of all primary and replica shards and h api: cat.shards component: endpoints --> - ## Endpoints ```json GET /_cat/shards GET /_cat/shards/{index} ``` - @@ -35,7 +33,6 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> - ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -52,6 +49,7 @@ The following table lists the available query parameters. All query parameters a | `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example requests diff --git a/_api-reference/cat/cat-snapshots.md b/_api-reference/cat/cat-snapshots.md index 208ab91e48..42a525c2c7 100644 --- a/_api-reference/cat/cat-snapshots.md +++ b/_api-reference/cat/cat-snapshots.md @@ -19,13 +19,11 @@ The CAT snapshots operation lists all snapshots for a repository. api: cat.snapshots component: endpoints --> - ## Endpoints ```json GET /_cat/snapshots GET /_cat/snapshots/{repository} ``` - @@ -35,7 +33,6 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> - ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -51,6 +48,7 @@ The following table lists the available query parameters. All query parameters a | `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example request diff --git a/_api-reference/cat/cat-tasks.md b/_api-reference/cat/cat-tasks.md index 18bdd89bc5..6a0346fc1f 100644 --- a/_api-reference/cat/cat-tasks.md +++ b/_api-reference/cat/cat-tasks.md @@ -18,12 +18,10 @@ The CAT tasks operation lists the progress of all tasks currently running on you api: cat.tasks component: endpoints --> - ## Endpoints ```json GET /_cat/tasks ``` - @@ -33,7 +31,6 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> - ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -51,6 +48,7 @@ The following table lists the available query parameters. All query parameters a | `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example request diff --git a/_api-reference/cat/cat-templates.md b/_api-reference/cat/cat-templates.md index c8cf73e976..86b7c4b574 100644 --- a/_api-reference/cat/cat-templates.md +++ b/_api-reference/cat/cat-templates.md @@ -19,13 +19,11 @@ The CAT templates operation lists the names, patterns, order numbers, and versio api: cat.templates component: endpoints --> - ## Endpoints ```json GET /_cat/templates GET /_cat/templates/{name} ``` - @@ -35,7 +33,6 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> - ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -50,6 +47,7 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example requests diff --git a/_api-reference/cat/cat-thread-pool.md b/_api-reference/cat/cat-thread-pool.md index b6f380abd3..7d7e7b71e5 100644 --- a/_api-reference/cat/cat-thread-pool.md +++ b/_api-reference/cat/cat-thread-pool.md @@ -19,13 +19,11 @@ The CAT thread pool operation lists the active, queued, and rejected threads of api: cat.thread_pool component: endpoints --> - ## Endpoints ```json GET /_cat/thread_pool GET /_cat/thread_pool/{thread_pool_patterns} ``` - @@ -35,7 +33,6 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> - ## Query parameters The following table lists the available query parameters. All query parameters are optional. @@ -51,6 +48,7 @@ The following table lists the available query parameters. All query parameters a | `size` | Integer | The multiplier in which to display values. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | + ## Example requests diff --git a/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md b/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md index e4b7bfd5c1..d59fd4ecf2 100644 --- a/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md +++ b/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md @@ -20,11 +20,9 @@ api: wlm.create_query_group component: endpoints omit_header: true --> - ```json PUT /_wlm/query_group ``` - ### Update a query group @@ -34,11 +32,9 @@ api: wlm.create_query_group component: endpoints omit_header: true --> - ```json PUT /_wlm/query_group ``` - ### Get a query group @@ -48,12 +44,10 @@ api: wlm.get_query_group component: endpoints omit_header: true --> - ```json GET /_wlm/query_group GET /_wlm/query_group/{name} ``` - ### Delete a query group @@ -63,11 +57,9 @@ api: wlm.create_query_group component: endpoints omit_header: true --> - ```json PUT /_wlm/query_group ``` - diff --git a/spec-insert/lib/renderers/table_renderer.rb b/spec-insert/lib/renderers/table_renderer.rb index b1a88b6b6d..1f67bb326d 100644 --- a/spec-insert/lib/renderers/table_renderer.rb +++ b/spec-insert/lib/renderers/table_renderer.rb @@ -28,7 +28,7 @@ def initialize(columns, rows, pretty:) # @return [Array] def render_lines calculate_column_widths if @pretty - ["\n", render_column, render_divider] + render_rows + ["\n"] + render_rows + [render_column, render_divider] + render_rows + ["\n"] end private diff --git a/spec-insert/spec/_fixtures/expected_output/param_tables.md b/spec-insert/spec/_fixtures/expected_output/param_tables.md index 6491d5347f..bf6adeaf3f 100644 --- a/spec-insert/spec/_fixtures/expected_output/param_tables.md +++ b/spec-insert/spec/_fixtures/expected_output/param_tables.md @@ -13,6 +13,7 @@ The following table lists the available path parameters. All path parameters are | :--- | :--- | :--- | | `index` | List or String | Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams and indexes, omit this parameter or use `*` or `_all`.
Valid values are: `_all`, `_any`, `_none` | + Query Parameters Example with Global Parameters, Pretty Print, and Custom Columns @@ -37,6 +38,7 @@ The following table lists the available query parameters. | Boolean | `pretty` | Whether to pretty format the returned JSON response. | _Optional_ | N/A | | Boolean | `human`
_DEPRECATED_ | _(Deprecated since 3.0: Use the `format` parameter instead.)_ Whether to return human readable values for statistics. | _Optional_ | `true` | + Query Parameters Example with only Parameter and Description Columns @@ -54,6 +56,7 @@ omit_header: true | `analyzer` | Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified. | | `expand_wildcards` | Comma-separated list of expand wildcard options.
Valid values are: `open`, `closed`, `none`, `all` | + Optional Params Text @@ -74,4 +77,5 @@ The following table lists the available query parameters. | `pretty` | _Optional_ | Boolean | Whether to pretty format the returned JSON response. | N/A | | `human`
_DEPRECATED_ | _Optional_ | Boolean | _(Deprecated since 3.0: Use the `format` parameter instead.)_ Whether to return human readable values for statistics. | `true` | + From 8da5e7a985ba0d06a77e1020bcc7c1b019a00034 Mon Sep 17 00:00:00 2001 From: Archer Date: Fri, 17 Jan 2025 16:01:24 -0600 Subject: [PATCH 23/32] Fix expected output. Signed-off-by: Archer --- spec-insert/spec/_fixtures/expected_output/param_tables.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/spec-insert/spec/_fixtures/expected_output/param_tables.md b/spec-insert/spec/_fixtures/expected_output/param_tables.md index bf6adeaf3f..8674988309 100644 --- a/spec-insert/spec/_fixtures/expected_output/param_tables.md +++ b/spec-insert/spec/_fixtures/expected_output/param_tables.md @@ -4,7 +4,6 @@ Typical Path Parameters Example api: search component: path_parameters --> - ## Path parameters The following table lists the available path parameters. All path parameters are optional. @@ -25,7 +24,6 @@ include_global: true pretty: true columns: Data type, Parameter, Description, Required, Default --> - ## Query parameters The following table lists the available query parameters. @@ -66,7 +64,6 @@ api: cat.health component: query_parameters include_global: true --> - ## Query parameters The following table lists the available query parameters. From 2ff38f196cfb857d5e7bb62da6e8748882650367 Mon Sep 17 00:00:00 2001 From: Archer Date: Fri, 17 Jan 2025 16:15:48 -0600 Subject: [PATCH 24/32] Fix table Signed-off-by: Archer --- _api-reference/cat/cat-aliases.md | 2 -- _api-reference/cat/cat-allocation.md | 2 ++ _api-reference/cat/cat-cluster_manager.md | 2 ++ _api-reference/cat/cat-count.md | 2 ++ _api-reference/cat/cat-field-data.md | 2 ++ _api-reference/cat/cat-health.md | 2 ++ _api-reference/cat/cat-indices.md | 2 ++ _api-reference/cat/cat-nodeattrs.md | 2 ++ _api-reference/cat/cat-nodes.md | 2 ++ _api-reference/cat/cat-pending-tasks.md | 2 ++ _api-reference/cat/cat-pit-segments.md | 2 ++ _api-reference/cat/cat-plugins.md | 2 ++ _api-reference/cat/cat-recovery.md | 2 ++ _api-reference/cat/cat-repositories.md | 2 ++ _api-reference/cat/cat-segment-replication.md | 4 ++++ _api-reference/cat/cat-segments.md | 2 ++ _api-reference/cat/cat-shards.md | 2 ++ _api-reference/cat/cat-snapshots.md | 2 ++ _api-reference/cat/cat-tasks.md | 2 ++ _api-reference/cat/cat-templates.md | 2 ++ _api-reference/cat/cat-thread-pool.md | 2 ++ spec-insert/lib/renderers/table_renderer.rb | 2 +- spec-insert/spec/_fixtures/expected_output/param_tables.md | 4 ++++ 23 files changed, 47 insertions(+), 3 deletions(-) diff --git a/_api-reference/cat/cat-aliases.md b/_api-reference/cat/cat-aliases.md index 90da9c4842..84231acc31 100644 --- a/_api-reference/cat/cat-aliases.md +++ b/_api-reference/cat/cat-aliases.md @@ -35,9 +35,7 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> -## Query parameters -The following table lists the available query parameters. All query parameters are optional. | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | diff --git a/_api-reference/cat/cat-allocation.md b/_api-reference/cat/cat-allocation.md index af7b0d5ef7..031ed8adbc 100644 --- a/_api-reference/cat/cat-allocation.md +++ b/_api-reference/cat/cat-allocation.md @@ -38,6 +38,8 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. + + | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | diff --git a/_api-reference/cat/cat-cluster_manager.md b/_api-reference/cat/cat-cluster_manager.md index 92495cf218..f96d1b7366 100644 --- a/_api-reference/cat/cat-cluster_manager.md +++ b/_api-reference/cat/cat-cluster_manager.md @@ -36,6 +36,8 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. + + | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `cluster_manager_timeout` | String | A timeout for connection to the cluster manager node. | N/A | diff --git a/_api-reference/cat/cat-count.md b/_api-reference/cat/cat-count.md index d1655e4fcf..4aa5dd0eb1 100644 --- a/_api-reference/cat/cat-count.md +++ b/_api-reference/cat/cat-count.md @@ -38,6 +38,8 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. + + | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | diff --git a/_api-reference/cat/cat-field-data.md b/_api-reference/cat/cat-field-data.md index 5bee414a24..3a63813163 100644 --- a/_api-reference/cat/cat-field-data.md +++ b/_api-reference/cat/cat-field-data.md @@ -36,6 +36,8 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. + + | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | diff --git a/_api-reference/cat/cat-health.md b/_api-reference/cat/cat-health.md index cabdb2d999..aef1def915 100644 --- a/_api-reference/cat/cat-health.md +++ b/_api-reference/cat/cat-health.md @@ -36,6 +36,8 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. + + | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | diff --git a/_api-reference/cat/cat-indices.md b/_api-reference/cat/cat-indices.md index df48f64f02..2713469356 100644 --- a/_api-reference/cat/cat-indices.md +++ b/_api-reference/cat/cat-indices.md @@ -37,6 +37,8 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. + + | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | diff --git a/_api-reference/cat/cat-nodeattrs.md b/_api-reference/cat/cat-nodeattrs.md index 518080e4ad..630dc9456e 100644 --- a/_api-reference/cat/cat-nodeattrs.md +++ b/_api-reference/cat/cat-nodeattrs.md @@ -36,6 +36,8 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. + + | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | diff --git a/_api-reference/cat/cat-nodes.md b/_api-reference/cat/cat-nodes.md index 270d638863..5b97d78551 100644 --- a/_api-reference/cat/cat-nodes.md +++ b/_api-reference/cat/cat-nodes.md @@ -38,6 +38,8 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. + + | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | diff --git a/_api-reference/cat/cat-pending-tasks.md b/_api-reference/cat/cat-pending-tasks.md index 15b4d2a562..7fa92c8926 100644 --- a/_api-reference/cat/cat-pending-tasks.md +++ b/_api-reference/cat/cat-pending-tasks.md @@ -36,6 +36,8 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. + + | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | diff --git a/_api-reference/cat/cat-pit-segments.md b/_api-reference/cat/cat-pit-segments.md index 411349f75c..f39a4f297d 100644 --- a/_api-reference/cat/cat-pit-segments.md +++ b/_api-reference/cat/cat-pit-segments.md @@ -41,6 +41,8 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. + + | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | diff --git a/_api-reference/cat/cat-plugins.md b/_api-reference/cat/cat-plugins.md index ab5e4653a7..886cda4f93 100644 --- a/_api-reference/cat/cat-plugins.md +++ b/_api-reference/cat/cat-plugins.md @@ -35,6 +35,8 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. + + | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | diff --git a/_api-reference/cat/cat-recovery.md b/_api-reference/cat/cat-recovery.md index 877ad00d1d..a8e3f51499 100644 --- a/_api-reference/cat/cat-recovery.md +++ b/_api-reference/cat/cat-recovery.md @@ -37,6 +37,8 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. + + | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `active_only` | Boolean | If `true`, the response only includes ongoing shard recoveries. | `false` | diff --git a/_api-reference/cat/cat-repositories.md b/_api-reference/cat/cat-repositories.md index d91f817525..a64954520e 100644 --- a/_api-reference/cat/cat-repositories.md +++ b/_api-reference/cat/cat-repositories.md @@ -35,6 +35,8 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. + + | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | diff --git a/_api-reference/cat/cat-segment-replication.md b/_api-reference/cat/cat-segment-replication.md index b631530782..5dc22e7881 100644 --- a/_api-reference/cat/cat-segment-replication.md +++ b/_api-reference/cat/cat-segment-replication.md @@ -36,6 +36,8 @@ include_deprecated: false The following table lists the available path parameters. All path parameters are optional. + + | Parameter | Data type | Description | | :--- | :--- | :--- | | `index` | List | A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. | @@ -54,6 +56,8 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. + + | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `active_only` | Boolean | When `true`, the response only includes ongoing segment replication events. | `false` | diff --git a/_api-reference/cat/cat-segments.md b/_api-reference/cat/cat-segments.md index 9f722aaad9..c445f33b35 100644 --- a/_api-reference/cat/cat-segments.md +++ b/_api-reference/cat/cat-segments.md @@ -37,6 +37,8 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. + + | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | diff --git a/_api-reference/cat/cat-shards.md b/_api-reference/cat/cat-shards.md index 1a0f662670..fedbdcf494 100644 --- a/_api-reference/cat/cat-shards.md +++ b/_api-reference/cat/cat-shards.md @@ -37,6 +37,8 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. + + | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | diff --git a/_api-reference/cat/cat-snapshots.md b/_api-reference/cat/cat-snapshots.md index 42a525c2c7..75d94d6553 100644 --- a/_api-reference/cat/cat-snapshots.md +++ b/_api-reference/cat/cat-snapshots.md @@ -37,6 +37,8 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. + + | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | diff --git a/_api-reference/cat/cat-tasks.md b/_api-reference/cat/cat-tasks.md index 6a0346fc1f..525c84b6a2 100644 --- a/_api-reference/cat/cat-tasks.md +++ b/_api-reference/cat/cat-tasks.md @@ -35,6 +35,8 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. + + | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `actions` | List | The task action names used to limit the response. | N/A | diff --git a/_api-reference/cat/cat-templates.md b/_api-reference/cat/cat-templates.md index 86b7c4b574..31bcd40a69 100644 --- a/_api-reference/cat/cat-templates.md +++ b/_api-reference/cat/cat-templates.md @@ -37,6 +37,8 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. + + | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | diff --git a/_api-reference/cat/cat-thread-pool.md b/_api-reference/cat/cat-thread-pool.md index 7d7e7b71e5..6bf0a4a812 100644 --- a/_api-reference/cat/cat-thread-pool.md +++ b/_api-reference/cat/cat-thread-pool.md @@ -37,6 +37,8 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. + + | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `cluster_manager_timeout` | String | A timeout for connection to the cluster manager node. | N/A | diff --git a/spec-insert/lib/renderers/table_renderer.rb b/spec-insert/lib/renderers/table_renderer.rb index 1f67bb326d..aaaad09d1e 100644 --- a/spec-insert/lib/renderers/table_renderer.rb +++ b/spec-insert/lib/renderers/table_renderer.rb @@ -28,7 +28,7 @@ def initialize(columns, rows, pretty:) # @return [Array] def render_lines calculate_column_widths if @pretty - [render_column, render_divider] + render_rows + ["\n"] + ["\n", render_column, render_divider] + render_rows + ["\n"] end private diff --git a/spec-insert/spec/_fixtures/expected_output/param_tables.md b/spec-insert/spec/_fixtures/expected_output/param_tables.md index 8674988309..87f962f8e4 100644 --- a/spec-insert/spec/_fixtures/expected_output/param_tables.md +++ b/spec-insert/spec/_fixtures/expected_output/param_tables.md @@ -8,6 +8,7 @@ component: path_parameters The following table lists the available path parameters. All path parameters are optional. + | Parameter | Data type | Description | | :--- | :--- | :--- | | `index` | List or String | Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams and indexes, omit this parameter or use `*` or `_all`.
Valid values are: `_all`, `_any`, `_none` | @@ -28,6 +29,7 @@ columns: Data type, Parameter, Description, Required, Default The following table lists the available query parameters. + | Data type | Parameter | Description | Required | Default | |:---------------|:--------------------------|:-----------------------------------------------------------------------------------------------------------------------------------|:-------------|:--------| | Boolean | `analyze_wildcard` | If true, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified. | **Required** | `false` | @@ -48,6 +50,7 @@ columns: Parameter, Description omit_header: true --> + | Parameter | Description | | :--- | :--- | | `analyze_wildcard` | **(Required)** If true, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified. _(Default: `false`)_ | @@ -68,6 +71,7 @@ include_global: true The following table lists the available query parameters. + | Parameter | Required | Data type | Description | Default | | :--- | :--- | :--- | :--- | :--- | | `expand_wildcard` | **Required** | String | Whether to expand wildcard expression to concrete indices that are open, closed, or both.
Valid values are:
- `open`: Expand wildcards to open indices only.
- `closed`: Expand wildcards to closed indices only.
- `none`: Do not expand wildcards. | N/A | From 5159c333d1d909755cdc2956fdce4abb567c4f8a Mon Sep 17 00:00:00 2001 From: Archer Date: Fri, 17 Jan 2025 17:14:27 -0600 Subject: [PATCH 25/32] Update expected results Signed-off-by: Archer --- _api-reference/cat/cat-aliases.md | 4 ++++ spec-insert/spec/_fixtures/expected_output/param_tables.md | 4 +++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/_api-reference/cat/cat-aliases.md b/_api-reference/cat/cat-aliases.md index 84231acc31..4dc29ae43e 100644 --- a/_api-reference/cat/cat-aliases.md +++ b/_api-reference/cat/cat-aliases.md @@ -35,6 +35,10 @@ component: query_parameters columns: Parameter, Data type, Description, Default include_deprecated: false --> +## Query parameters + +The following table lists the available query parameters. All query parameters are optional. + | Parameter | Data type | Description | Default | diff --git a/spec-insert/spec/_fixtures/expected_output/param_tables.md b/spec-insert/spec/_fixtures/expected_output/param_tables.md index 87f962f8e4..3b50b9903b 100644 --- a/spec-insert/spec/_fixtures/expected_output/param_tables.md +++ b/spec-insert/spec/_fixtures/expected_output/param_tables.md @@ -8,7 +8,6 @@ component: path_parameters The following table lists the available path parameters. All path parameters are optional. - | Parameter | Data type | Description | | :--- | :--- | :--- | | `index` | List or String | Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams and indexes, omit this parameter or use `*` or `_all`.
Valid values are: `_all`, `_any`, `_none` | @@ -30,6 +29,7 @@ columns: Data type, Parameter, Description, Required, Default The following table lists the available query parameters. + | Data type | Parameter | Description | Required | Default | |:---------------|:--------------------------|:-----------------------------------------------------------------------------------------------------------------------------------|:-------------|:--------| | Boolean | `analyze_wildcard` | If true, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified. | **Required** | `false` | @@ -51,6 +51,7 @@ omit_header: true --> + | Parameter | Description | | :--- | :--- | | `analyze_wildcard` | **(Required)** If true, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified. _(Default: `false`)_ | @@ -72,6 +73,7 @@ include_global: true The following table lists the available query parameters. + | Parameter | Required | Data type | Description | Default | | :--- | :--- | :--- | :--- | :--- | | `expand_wildcard` | **Required** | String | Whether to expand wildcard expression to concrete indices that are open, closed, or both.
Valid values are:
- `open`: Expand wildcards to open indices only.
- `closed`: Expand wildcards to closed indices only.
- `none`: Do not expand wildcards. | N/A | From 6eabb6af844a7c46e8522b9429eb20ea4a0b6a1d Mon Sep 17 00:00:00 2001 From: Archer Date: Fri, 17 Jan 2025 17:18:03 -0600 Subject: [PATCH 26/32] Fix output, again. Signed-off-by: Archer --- spec-insert/spec/_fixtures/expected_output/param_tables.md | 1 + 1 file changed, 1 insertion(+) diff --git a/spec-insert/spec/_fixtures/expected_output/param_tables.md b/spec-insert/spec/_fixtures/expected_output/param_tables.md index 3b50b9903b..cb76586049 100644 --- a/spec-insert/spec/_fixtures/expected_output/param_tables.md +++ b/spec-insert/spec/_fixtures/expected_output/param_tables.md @@ -8,6 +8,7 @@ component: path_parameters The following table lists the available path parameters. All path parameters are optional. + | Parameter | Data type | Description | | :--- | :--- | :--- | | `index` | List or String | Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams and indexes, omit this parameter or use `*` or `_all`.
Valid values are: `_all`, `_any`, `_none` | From 92bd3d671827375e32063b476711cc41ca86f88b Mon Sep 17 00:00:00 2001 From: Archer Date: Fri, 17 Jan 2025 17:19:30 -0600 Subject: [PATCH 27/32] Add another test Signed-off-by: Archer --- spec-insert/spec/_fixtures/expected_output/param_tables.md | 1 + 1 file changed, 1 insertion(+) diff --git a/spec-insert/spec/_fixtures/expected_output/param_tables.md b/spec-insert/spec/_fixtures/expected_output/param_tables.md index cb76586049..23536135d8 100644 --- a/spec-insert/spec/_fixtures/expected_output/param_tables.md +++ b/spec-insert/spec/_fixtures/expected_output/param_tables.md @@ -9,6 +9,7 @@ component: path_parameters The following table lists the available path parameters. All path parameters are optional. + | Parameter | Data type | Description | | :--- | :--- | :--- | | `index` | List or String | Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams and indexes, omit this parameter or use `*` or `_all`.
Valid values are: `_all`, `_any`, `_none` | From d6de5f941d286f6218706012fe26237586c6d0f5 Mon Sep 17 00:00:00 2001 From: Archer Date: Fri, 17 Jan 2025 17:26:08 -0600 Subject: [PATCH 28/32] Theoretically the correct spacing. Signed-off-by: Archer --- spec-insert/spec/_fixtures/expected_output/param_tables.md | 1 - 1 file changed, 1 deletion(-) diff --git a/spec-insert/spec/_fixtures/expected_output/param_tables.md b/spec-insert/spec/_fixtures/expected_output/param_tables.md index 23536135d8..c608e8bf39 100644 --- a/spec-insert/spec/_fixtures/expected_output/param_tables.md +++ b/spec-insert/spec/_fixtures/expected_output/param_tables.md @@ -53,7 +53,6 @@ omit_header: true --> - | Parameter | Description | | :--- | :--- | | `analyze_wildcard` | **(Required)** If true, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified. _(Default: `false`)_ | From 6437c1d0952100b6b5b63321a09d0ebc3e19dfed Mon Sep 17 00:00:00 2001 From: Archer Date: Fri, 17 Jan 2025 17:56:43 -0600 Subject: [PATCH 29/32] Add Theo's suggestions Signed-off-by: Archer --- _api-reference/cat/cat-aliases.md | 3 --- _api-reference/cat/cat-allocation.md | 3 --- _api-reference/cat/cat-cluster_manager.md | 3 --- _api-reference/cat/cat-count.md | 3 --- _api-reference/cat/cat-field-data.md | 3 --- _api-reference/cat/cat-health.md | 3 --- _api-reference/cat/cat-indices.md | 3 --- _api-reference/cat/cat-nodeattrs.md | 3 --- _api-reference/cat/cat-nodes.md | 3 --- _api-reference/cat/cat-pending-tasks.md | 3 --- _api-reference/cat/cat-pit-segments.md | 3 --- _api-reference/cat/cat-plugins.md | 3 --- _api-reference/cat/cat-recovery.md | 3 --- _api-reference/cat/cat-repositories.md | 3 --- _api-reference/cat/cat-segment-replication.md | 6 ------ _api-reference/cat/cat-segments.md | 3 --- _api-reference/cat/cat-shards.md | 3 --- _api-reference/cat/cat-snapshots.md | 3 --- _api-reference/cat/cat-tasks.md | 3 --- _api-reference/cat/cat-templates.md | 3 --- _api-reference/cat/cat-thread-pool.md | 3 --- spec-insert/lib/renderers/table_renderer.rb | 2 +- .../lib/renderers/templates/path_parameters.mustache | 1 - .../lib/renderers/templates/query_parameters.mustache | 1 - .../spec/_fixtures/expected_output/param_tables.md | 11 ----------- 25 files changed, 1 insertion(+), 80 deletions(-) diff --git a/_api-reference/cat/cat-aliases.md b/_api-reference/cat/cat-aliases.md index 4dc29ae43e..f4eca4ddd5 100644 --- a/_api-reference/cat/cat-aliases.md +++ b/_api-reference/cat/cat-aliases.md @@ -39,8 +39,6 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. - - | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `expand_wildcards` | List or String | Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
Valid values are:
- `all`: Match any index, including hidden ones.
- `closed`: Match closed, non-hidden indexes.
- `hidden`: Match hidden indexes. Must be combined with open, closed, or both.
- `none`: Wildcard expressions are not accepted.
- `open`: Match open, non-hidden indexes. | N/A | @@ -51,7 +49,6 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | - diff --git a/_api-reference/cat/cat-allocation.md b/_api-reference/cat/cat-allocation.md index 031ed8adbc..c1393d5135 100644 --- a/_api-reference/cat/cat-allocation.md +++ b/_api-reference/cat/cat-allocation.md @@ -38,8 +38,6 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. - - | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | @@ -51,7 +49,6 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | - ## Example requests diff --git a/_api-reference/cat/cat-cluster_manager.md b/_api-reference/cat/cat-cluster_manager.md index f96d1b7366..cded9431ac 100644 --- a/_api-reference/cat/cat-cluster_manager.md +++ b/_api-reference/cat/cat-cluster_manager.md @@ -36,8 +36,6 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. - - | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `cluster_manager_timeout` | String | A timeout for connection to the cluster manager node. | N/A | @@ -48,7 +46,6 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `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 4aa5dd0eb1..3c2c491315 100644 --- a/_api-reference/cat/cat-count.md +++ b/_api-reference/cat/cat-count.md @@ -38,8 +38,6 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. - - | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | @@ -48,7 +46,6 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | - ## Example requests diff --git a/_api-reference/cat/cat-field-data.md b/_api-reference/cat/cat-field-data.md index 3a63813163..01d207a016 100644 --- a/_api-reference/cat/cat-field-data.md +++ b/_api-reference/cat/cat-field-data.md @@ -36,8 +36,6 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. - - | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | @@ -47,7 +45,6 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | - ## Example requests diff --git a/_api-reference/cat/cat-health.md b/_api-reference/cat/cat-health.md index aef1def915..8477134b28 100644 --- a/_api-reference/cat/cat-health.md +++ b/_api-reference/cat/cat-health.md @@ -36,8 +36,6 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. - - | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | @@ -48,7 +46,6 @@ The following table lists the available query parameters. All query parameters a | `ts` | Boolean | When `true`, returns `HH:MM:SS` and Unix epoch timestamps. | `true` | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | - ## Example request diff --git a/_api-reference/cat/cat-indices.md b/_api-reference/cat/cat-indices.md index 2713469356..319592dfaa 100644 --- a/_api-reference/cat/cat-indices.md +++ b/_api-reference/cat/cat-indices.md @@ -37,8 +37,6 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. - - | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | @@ -55,7 +53,6 @@ The following table lists the available query parameters. All query parameters a | `time` | String | Specifies the time units.
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | - ## Example requests diff --git a/_api-reference/cat/cat-nodeattrs.md b/_api-reference/cat/cat-nodeattrs.md index 630dc9456e..e7f86ddc52 100644 --- a/_api-reference/cat/cat-nodeattrs.md +++ b/_api-reference/cat/cat-nodeattrs.md @@ -36,8 +36,6 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. - - | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | @@ -48,7 +46,6 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | - ## Example request diff --git a/_api-reference/cat/cat-nodes.md b/_api-reference/cat/cat-nodes.md index 5b97d78551..5a570ca23c 100644 --- a/_api-reference/cat/cat-nodes.md +++ b/_api-reference/cat/cat-nodes.md @@ -38,8 +38,6 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. - - | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | @@ -52,7 +50,6 @@ The following table lists the available query parameters. All query parameters a | `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | - ## Example request diff --git a/_api-reference/cat/cat-pending-tasks.md b/_api-reference/cat/cat-pending-tasks.md index 7fa92c8926..38cc295ee7 100644 --- a/_api-reference/cat/cat-pending-tasks.md +++ b/_api-reference/cat/cat-pending-tasks.md @@ -36,8 +36,6 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. - - | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | @@ -49,7 +47,6 @@ The following table lists the available query parameters. All query parameters a | `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | - ## Example request diff --git a/_api-reference/cat/cat-pit-segments.md b/_api-reference/cat/cat-pit-segments.md index f39a4f297d..bad46ae15c 100644 --- a/_api-reference/cat/cat-pit-segments.md +++ b/_api-reference/cat/cat-pit-segments.md @@ -41,8 +41,6 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. - - | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | @@ -52,7 +50,6 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | - ## Request body fields diff --git a/_api-reference/cat/cat-plugins.md b/_api-reference/cat/cat-plugins.md index 886cda4f93..38c9b82e7c 100644 --- a/_api-reference/cat/cat-plugins.md +++ b/_api-reference/cat/cat-plugins.md @@ -35,8 +35,6 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. - - | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | @@ -47,7 +45,6 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | - ## Example request diff --git a/_api-reference/cat/cat-recovery.md b/_api-reference/cat/cat-recovery.md index a8e3f51499..1a3e6857f7 100644 --- a/_api-reference/cat/cat-recovery.md +++ b/_api-reference/cat/cat-recovery.md @@ -37,8 +37,6 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. - - | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `active_only` | Boolean | If `true`, the response only includes ongoing shard recoveries. | `false` | @@ -51,7 +49,6 @@ The following table lists the available query parameters. All query parameters a | `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | - ## Example requests diff --git a/_api-reference/cat/cat-repositories.md b/_api-reference/cat/cat-repositories.md index a64954520e..1a0f1f8e98 100644 --- a/_api-reference/cat/cat-repositories.md +++ b/_api-reference/cat/cat-repositories.md @@ -35,8 +35,6 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. - - | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | @@ -47,7 +45,6 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | - ## Example request diff --git a/_api-reference/cat/cat-segment-replication.md b/_api-reference/cat/cat-segment-replication.md index 5dc22e7881..b3d3bc1f35 100644 --- a/_api-reference/cat/cat-segment-replication.md +++ b/_api-reference/cat/cat-segment-replication.md @@ -36,13 +36,10 @@ include_deprecated: false The following table lists the available path parameters. All path parameters are optional. - - | Parameter | Data type | Description | | :--- | :--- | :--- | | `index` | List | A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. | - @@ -56,8 +53,6 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. - - | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `active_only` | Boolean | When `true`, the response only includes ongoing segment replication events. | `false` | @@ -77,7 +72,6 @@ The following table lists the available query parameters. All query parameters a | `timeout` | String | The operation timeout. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | - ## Path parameters diff --git a/_api-reference/cat/cat-segments.md b/_api-reference/cat/cat-segments.md index c445f33b35..03df94492e 100644 --- a/_api-reference/cat/cat-segments.md +++ b/_api-reference/cat/cat-segments.md @@ -37,8 +37,6 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. - - | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | @@ -49,7 +47,6 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | - ## Example requests diff --git a/_api-reference/cat/cat-shards.md b/_api-reference/cat/cat-shards.md index fedbdcf494..5d2f873702 100644 --- a/_api-reference/cat/cat-shards.md +++ b/_api-reference/cat/cat-shards.md @@ -37,8 +37,6 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. - - | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | @@ -51,7 +49,6 @@ The following table lists the available query parameters. All query parameters a | `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | - ## Example requests diff --git a/_api-reference/cat/cat-snapshots.md b/_api-reference/cat/cat-snapshots.md index 75d94d6553..5e2add5de6 100644 --- a/_api-reference/cat/cat-snapshots.md +++ b/_api-reference/cat/cat-snapshots.md @@ -37,8 +37,6 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. - - | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | @@ -50,7 +48,6 @@ The following table lists the available query parameters. All query parameters a | `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | - ## Example request diff --git a/_api-reference/cat/cat-tasks.md b/_api-reference/cat/cat-tasks.md index 525c84b6a2..2d30c92727 100644 --- a/_api-reference/cat/cat-tasks.md +++ b/_api-reference/cat/cat-tasks.md @@ -35,8 +35,6 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. - - | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `actions` | List | The task action names used to limit the response. | N/A | @@ -50,7 +48,6 @@ The following table lists the available query parameters. All query parameters a | `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/).
Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | - ## Example request diff --git a/_api-reference/cat/cat-templates.md b/_api-reference/cat/cat-templates.md index 31bcd40a69..de3e087581 100644 --- a/_api-reference/cat/cat-templates.md +++ b/_api-reference/cat/cat-templates.md @@ -37,8 +37,6 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. - - | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | @@ -49,7 +47,6 @@ The following table lists the available query parameters. All query parameters a | `s` | List | A comma-separated list of column names or column aliases to sort by. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | - ## Example requests diff --git a/_api-reference/cat/cat-thread-pool.md b/_api-reference/cat/cat-thread-pool.md index 6bf0a4a812..6779157283 100644 --- a/_api-reference/cat/cat-thread-pool.md +++ b/_api-reference/cat/cat-thread-pool.md @@ -37,8 +37,6 @@ include_deprecated: false The following table lists the available query parameters. All query parameters are optional. - - | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | | `cluster_manager_timeout` | String | A timeout for connection to the cluster manager node. | N/A | @@ -50,7 +48,6 @@ The following table lists the available query parameters. All query parameters a | `size` | Integer | The multiplier in which to display values. | N/A | | `v` | Boolean | Enables verbose mode, which displays column headers. | `false` | - ## Example requests diff --git a/spec-insert/lib/renderers/table_renderer.rb b/spec-insert/lib/renderers/table_renderer.rb index aaaad09d1e..447e119cd3 100644 --- a/spec-insert/lib/renderers/table_renderer.rb +++ b/spec-insert/lib/renderers/table_renderer.rb @@ -28,7 +28,7 @@ def initialize(columns, rows, pretty:) # @return [Array] def render_lines calculate_column_widths if @pretty - ["\n", render_column, render_divider] + render_rows + ["\n"] + ['', render_column, render_divider] + render_rows + [''] end private diff --git a/spec-insert/lib/renderers/templates/path_parameters.mustache b/spec-insert/lib/renderers/templates/path_parameters.mustache index ad69f4d589..47c96cdecc 100644 --- a/spec-insert/lib/renderers/templates/path_parameters.mustache +++ b/spec-insert/lib/renderers/templates/path_parameters.mustache @@ -2,6 +2,5 @@ ## Path parameters The following table lists the available path parameters.{{#optional}} All path parameters are optional.{{/optional}} - {{/omit_header}} {{{table}}} \ No newline at end of file diff --git a/spec-insert/lib/renderers/templates/query_parameters.mustache b/spec-insert/lib/renderers/templates/query_parameters.mustache index 5cc7bc9241..4d7f57fe4e 100644 --- a/spec-insert/lib/renderers/templates/query_parameters.mustache +++ b/spec-insert/lib/renderers/templates/query_parameters.mustache @@ -2,6 +2,5 @@ ## Query parameters The following table lists the available query parameters.{{#optional}} All query parameters are optional.{{/optional}} - {{/omit_header}} {{{table}}} \ No newline at end of file diff --git a/spec-insert/spec/_fixtures/expected_output/param_tables.md b/spec-insert/spec/_fixtures/expected_output/param_tables.md index c608e8bf39..9ec4ae07f1 100644 --- a/spec-insert/spec/_fixtures/expected_output/param_tables.md +++ b/spec-insert/spec/_fixtures/expected_output/param_tables.md @@ -8,13 +8,10 @@ component: path_parameters The following table lists the available path parameters. All path parameters are optional. - - | Parameter | Data type | Description | | :--- | :--- | :--- | | `index` | List or String | Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams and indexes, omit this parameter or use `*` or `_all`.
Valid values are: `_all`, `_any`, `_none` | - Query Parameters Example with Global Parameters, Pretty Print, and Custom Columns @@ -30,8 +27,6 @@ columns: Data type, Parameter, Description, Required, Default The following table lists the available query parameters. - - | Data type | Parameter | Description | Required | Default | |:---------------|:--------------------------|:-----------------------------------------------------------------------------------------------------------------------------------|:-------------|:--------| | Boolean | `analyze_wildcard` | If true, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified. | **Required** | `false` | @@ -40,7 +35,6 @@ The following table lists the available query parameters. | Boolean | `pretty` | Whether to pretty format the returned JSON response. | _Optional_ | N/A | | Boolean | `human`
_DEPRECATED_ | _(Deprecated since 3.0: Use the `format` parameter instead.)_ Whether to return human readable values for statistics. | _Optional_ | `true` | - Query Parameters Example with only Parameter and Description Columns @@ -52,14 +46,12 @@ columns: Parameter, Description omit_header: true --> - | Parameter | Description | | :--- | :--- | | `analyze_wildcard` | **(Required)** If true, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified. _(Default: `false`)_ | | `analyzer` | Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified. | | `expand_wildcards` | Comma-separated list of expand wildcard options.
Valid values are: `open`, `closed`, `none`, `all` | - Optional Params Text @@ -73,13 +65,10 @@ include_global: true The following table lists the available query parameters. - - | Parameter | Required | Data type | Description | Default | | :--- | :--- | :--- | :--- | :--- | | `expand_wildcard` | **Required** | String | Whether to expand wildcard expression to concrete indices that are open, closed, or both.
Valid values are:
- `open`: Expand wildcards to open indices only.
- `closed`: Expand wildcards to closed indices only.
- `none`: Do not expand wildcards. | N/A | | `pretty` | _Optional_ | Boolean | Whether to pretty format the returned JSON response. | N/A | | `human`
_DEPRECATED_ | _Optional_ | Boolean | _(Deprecated since 3.0: Use the `format` parameter instead.)_ Whether to return human readable values for statistics. | `true` | - From 9a848c05c7214a07dd296c2e88ee9d67c7a3cae1 Mon Sep 17 00:00:00 2001 From: Archer Date: Tue, 21 Jan 2025 10:28:09 -0600 Subject: [PATCH 30/32] Fix BR tags Signed-off-by: Archer --- _api-reference/cat/cat-aliases.md | 2 +- _api-reference/cat/cat-indices.md | 2 +- _api-reference/cat/cat-segment-replication.md | 2 +- spec-insert/lib/renderers/parameter_table_renderer.rb | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/_api-reference/cat/cat-aliases.md b/_api-reference/cat/cat-aliases.md index f4eca4ddd5..03385469c9 100644 --- a/_api-reference/cat/cat-aliases.md +++ b/_api-reference/cat/cat-aliases.md @@ -41,7 +41,7 @@ The following table lists the available query parameters. All query parameters a | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | -| `expand_wildcards` | List or String | Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
Valid values are:
- `all`: Match any index, including hidden ones.
- `closed`: Match closed, non-hidden indexes.
- `hidden`: Match hidden indexes. Must be combined with open, closed, or both.
- `none`: Wildcard expressions are not accepted.
- `open`: Match open, non-hidden indexes. | N/A | +| `expand_wildcards` | List or String | Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
Valid values are:
- `all`: Match any index, including hidden ones.
- `closed`: Match closed, non-hidden indexes.
- `hidden`: Match hidden indexes. Must be combined with open, closed, or both.
- `none`: Wildcard expressions are not accepted.
- `open`: Match open, non-hidden indexes. | N/A | | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | | `h` | List | A comma-separated list of column names to display. | N/A | | `help` | Boolean | Returns help information. | `false` | diff --git a/_api-reference/cat/cat-indices.md b/_api-reference/cat/cat-indices.md index 319592dfaa..1cd423d437 100644 --- a/_api-reference/cat/cat-indices.md +++ b/_api-reference/cat/cat-indices.md @@ -41,7 +41,7 @@ The following table lists the available query parameters. All query parameters a | :--- | :--- | :--- | :--- | | `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | | `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | -| `expand_wildcards` | List or String | The type of index that wildcard patterns can match. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
Valid values are:
- `all`: Match any index, including hidden ones.
- `closed`: Match closed, non-hidden indexes.
- `hidden`: Match hidden indexes. Must be combined with open, closed, or both.
- `none`: Wildcard expressions are not accepted.
- `open`: Match open, non-hidden indexes. | N/A | +| `expand_wildcards` | List or String | The type of index that wildcard patterns can match. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
Valid values are:
- `all`: Match any index, including hidden ones.
- `closed`: Match closed, non-hidden indexes.
- `hidden`: Match hidden indexes. Must be combined with open, closed, or both.
- `none`: Wildcard expressions are not accepted.
- `open`: Match open, non-hidden indexes. | N/A | | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | | `h` | List | A comma-separated list of column names to display. | N/A | | `health` | String | Limits indexes based on their health status. Supported values are `green`, `yellow`, and `red`.
Valid values are: `green`, `GREEN`, `yellow`, `YELLOW`, `red`, `RED` | N/A | diff --git a/_api-reference/cat/cat-segment-replication.md b/_api-reference/cat/cat-segment-replication.md index b3d3bc1f35..1f6c04da67 100644 --- a/_api-reference/cat/cat-segment-replication.md +++ b/_api-reference/cat/cat-segment-replication.md @@ -60,7 +60,7 @@ The following table lists the available query parameters. All query parameters a | `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | | `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 | The type of index that wildcard patterns can match. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
Valid values are:
- `all`: Match any index, including hidden ones.
- `closed`: Match closed, non-hidden indexes.
- `hidden`: Match hidden indexes. Must be combined with open, closed, or both.
- `none`: Wildcard expressions are not accepted.
- `open`: Match open, non-hidden indexes. | N/A | +| `expand_wildcards` | List or String | The type of index that wildcard patterns can match. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
Valid values are:
- `all`: Match any index, including hidden ones.
- `closed`: Match closed, non-hidden indexes.
- `hidden`: Match hidden indexes. Must be combined with open, closed, or both.
- `none`: Wildcard expressions are not accepted.
- `open`: Match open, non-hidden indexes. | N/A | | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | | `h` | List | A comma-separated list of column names to display. | N/A | | `help` | Boolean | Returns help information. | `false` | diff --git a/spec-insert/lib/renderers/parameter_table_renderer.rb b/spec-insert/lib/renderers/parameter_table_renderer.rb index 29c68ce46a..2ab439be5c 100644 --- a/spec-insert/lib/renderers/parameter_table_renderer.rb +++ b/spec-insert/lib/renderers/parameter_table_renderer.rb @@ -75,7 +75,7 @@ def valid_values(param) "
Valid values are: #{enums.map { |enum| "`#{enum[:value]}`" }.join(', ')}" else "
Valid values are:
#{enums.map { |enum| "- `#{enum[:value]}`: #{enum[:description]}" } - .join('
')}" + .join('
')}" end end From bc95b507a5b8e63cb4602a6755f1722c34bf28a8 Mon Sep 17 00:00:00 2001 From: Archer Date: Tue, 21 Jan 2025 10:29:10 -0600 Subject: [PATCH 31/32] Fix expected output. Signed-off-by: Archer --- spec-insert/spec/_fixtures/expected_output/param_tables.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec-insert/spec/_fixtures/expected_output/param_tables.md b/spec-insert/spec/_fixtures/expected_output/param_tables.md index 9ec4ae07f1..7eda4ba6c1 100644 --- a/spec-insert/spec/_fixtures/expected_output/param_tables.md +++ b/spec-insert/spec/_fixtures/expected_output/param_tables.md @@ -67,7 +67,7 @@ The following table lists the available query parameters. | Parameter | Required | Data type | Description | Default | | :--- | :--- | :--- | :--- | :--- | -| `expand_wildcard` | **Required** | String | Whether to expand wildcard expression to concrete indices that are open, closed, or both.
Valid values are:
- `open`: Expand wildcards to open indices only.
- `closed`: Expand wildcards to closed indices only.
- `none`: Do not expand wildcards. | N/A | +| `expand_wildcard` | **Required** | String | Whether to expand wildcard expression to concrete indices that are open, closed, or both.
Valid values are:
- `open`: Expand wildcards to open indices only.
- `closed`: Expand wildcards to closed indices only.
- `none`: Do not expand wildcards. | N/A | | `pretty` | _Optional_ | Boolean | Whether to pretty format the returned JSON response. | N/A | | `human`
_DEPRECATED_ | _Optional_ | Boolean | _(Deprecated since 3.0: Use the `format` parameter instead.)_ Whether to return human readable values for statistics. | `true` | From 1495f2a1ca3af5de94a4faa35d18b3b03e791822 Mon Sep 17 00:00:00 2001 From: Archer Date: Tue, 21 Jan 2025 15:04:01 -0600 Subject: [PATCH 32/32] Make wildcard defintion consistent. Signed-off-by: Archer --- _api-reference/cat/cat-aliases.md | 2 +- _api-reference/cat/cat-indices.md | 2 +- _api-reference/cat/cat-segment-replication.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/_api-reference/cat/cat-aliases.md b/_api-reference/cat/cat-aliases.md index 03385469c9..0c5fb7b15a 100644 --- a/_api-reference/cat/cat-aliases.md +++ b/_api-reference/cat/cat-aliases.md @@ -41,7 +41,7 @@ The following table lists the available query parameters. All query parameters a | Parameter | Data type | Description | Default | | :--- | :--- | :--- | :--- | -| `expand_wildcards` | List or String | Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
Valid values are:
- `all`: Match any index, including hidden ones.
- `closed`: Match closed, non-hidden indexes.
- `hidden`: Match hidden indexes. Must be combined with open, closed, or both.
- `none`: Wildcard expressions are not accepted.
- `open`: Match open, non-hidden indexes. | N/A | +| `expand_wildcards` | List or String | Specifies the type of index that wildcard expressions can match. Supports comma-separated values.
Valid values are:
- `all`: Match any index, including hidden ones.
- `closed`: Match closed, non-hidden indexes.
- `hidden`: Match hidden indexes. Must be combined with open, closed, or both.
- `none`: Wildcard expressions are not accepted.
- `open`: Match open, non-hidden indexes. | N/A | | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | | `h` | List | A comma-separated list of column names to display. | N/A | | `help` | Boolean | Returns help information. | `false` | diff --git a/_api-reference/cat/cat-indices.md b/_api-reference/cat/cat-indices.md index 1cd423d437..23cc44f69f 100644 --- a/_api-reference/cat/cat-indices.md +++ b/_api-reference/cat/cat-indices.md @@ -41,7 +41,7 @@ The following table lists the available query parameters. All query parameters a | :--- | :--- | :--- | :--- | | `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | | `cluster_manager_timeout` | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A | -| `expand_wildcards` | List or String | The type of index that wildcard patterns can match. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
Valid values are:
- `all`: Match any index, including hidden ones.
- `closed`: Match closed, non-hidden indexes.
- `hidden`: Match hidden indexes. Must be combined with open, closed, or both.
- `none`: Wildcard expressions are not accepted.
- `open`: Match open, non-hidden indexes. | N/A | +| `expand_wildcards` | List or String | Specifies the type of index that wildcard expressions can match. Supports comma-separated values.
Valid values are:
- `all`: Match any index, including hidden ones.
- `closed`: Match closed, non-hidden indexes.
- `hidden`: Match hidden indexes. Must be combined with open, closed, or both.
- `none`: Wildcard expressions are not accepted.
- `open`: Match open, non-hidden indexes. | N/A | | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | | `h` | List | A comma-separated list of column names to display. | N/A | | `health` | String | Limits indexes based on their health status. Supported values are `green`, `yellow`, and `red`.
Valid values are: `green`, `GREEN`, `yellow`, `YELLOW`, `red`, `RED` | N/A | diff --git a/_api-reference/cat/cat-segment-replication.md b/_api-reference/cat/cat-segment-replication.md index 1f6c04da67..4e867e7ecf 100644 --- a/_api-reference/cat/cat-segment-replication.md +++ b/_api-reference/cat/cat-segment-replication.md @@ -60,7 +60,7 @@ The following table lists the available query parameters. All query parameters a | `bytes` | String | The units used to display byte values.
Valid values are: `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p` | N/A | | `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 | The type of index that wildcard patterns can match. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
Valid values are:
- `all`: Match any index, including hidden ones.
- `closed`: Match closed, non-hidden indexes.
- `hidden`: Match hidden indexes. Must be combined with open, closed, or both.
- `none`: Wildcard expressions are not accepted.
- `open`: Match open, non-hidden indexes. | N/A | +| `expand_wildcards` | List or String | Specifies the type of index that wildcard expressions can match. Supports comma-separated values.
Valid values are:
- `all`: Match any index, including hidden ones.
- `closed`: Match closed, non-hidden indexes.
- `hidden`: Match hidden indexes. Must be combined with open, closed, or both.
- `none`: Wildcard expressions are not accepted.
- `open`: Match open, non-hidden indexes. | N/A | | `format` | String | A short version of the `Accept` header, such as `json` or `yaml`. | N/A | | `h` | List | A comma-separated list of column names to display. | N/A | | `help` | Boolean | Returns help information. | `false` |