CAT API automation (Part II)

_api-reference/cat/cat-aliases.md

@@ -32,19 +32,23 @@ GET /_cat/aliases/{name}
 <!-- spec_insert_start
 api: cat.aliases
 component: query_parameters
-columns: Parameter,Type,Description,Default
+columns: Parameter, Data 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`. | 
-`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`
+
+The following table lists the available query parameters. All query parameters are optional.
+
+| Parameter | Data type | Description | Default |
+| :--- | :--- | :--- | :--- |
+| `expand_wildcards` | List or String | Specifies the type of index that wildcard expressions can match. Supports comma-separated values. <br> Valid values are: <br> - `all`: Match any index, including hidden ones. <br> - `closed`: Match closed, non-hidden indexes. <br> - `hidden`: Match hidden indexes. Must be combined with open, closed, or both. <br> - `none`: Wildcard expressions are not accepted. <br> - `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` |
+
 <!-- spec_insert_end -->
 
 

_api-reference/cat/cat-allocation.md

@@ -31,20 +31,24 @@ GET /_cat/allocation/{node_id}
 <!-- spec_insert_start
 api: cat.allocation
 component: query_parameters
-columns: Parameter,Type,Description,Default
+columns: Parameter, Data type, Description, Default
 include_deprecated: false
 -->
 ## Query parameters
-Parameter | 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`
+
+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. <br> 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` |
+
 <!-- spec_insert_end -->
 
 ## Example requests

_api-reference/cat/cat-cluster_manager.md

@@ -15,19 +15,41 @@ has_children: false
 The CAT cluster manager operation lists information that helps identify the elected cluster manager node.
 
 
+<!-- spec_insert_start
+api: cat.cluster_manager
+component: endpoints
+-->
 ## Endpoints
-
 ```json
-GET _cat/cluster_manager
+GET /_cat/cluster_manager
 ```
+<!-- spec_insert_end -->
+
 
+<!-- spec_insert_start
+api: cat.cluster_manager
+component: query_parameters
+columns: Parameter, Data type, Description, Default
+include_deprecated: false
+-->
 ## 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.
+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 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` |
+
+<!-- spec_insert_end -->
+
 
-## Example requests
+## Example request
 
 ```
 GET _cat/cluster_manager?v

_api-reference/cat/cat-count.md

@@ -16,12 +16,37 @@ redirect_from:
 The CAT count operation lists the number of documents in your cluster.
 
 
+<!-- spec_insert_start
+api: cat.count
+component: endpoints
+-->
 ## Endpoints
-
 ```json
-GET _cat/count?v
-GET _cat/count/<index>?v
+GET /_cat/count
+GET /_cat/count/{index}
 ```
+<!-- spec_insert_end -->
+
+
+<!-- spec_insert_start
+api: cat.count
+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 |
+| :--- | :--- | :--- | :--- |
+| `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` |
+
+<!-- spec_insert_end -->
 
 ## Example requests
 

_api-reference/cat/cat-field-data.md

@@ -14,19 +14,38 @@ redirect_from:
 
 The CAT Field Data operation lists the memory size used by each field per node.
 
-
+<!-- spec_insert_start
+api: cat.fielddata
+component: endpoints
+-->
 ## Endpoints
-
 ```json
-GET _cat/fielddata?v
-GET _cat/fielddata/<field_name>?v
+GET /_cat/fielddata
+GET /_cat/fielddata/{fields}
 ```
+<!-- spec_insert_end -->
 
+
+<!-- spec_insert_start
+api: cat.fielddata
+component: query_parameters
+columns: Parameter, Data type, Description, Default
+include_deprecated: false
+-->
 ## 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/).
+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. <br> 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` |
+
+<!-- spec_insert_end -->
 
 ## Example requests
 

_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,38 @@ 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.
 
 
+<!-- spec_insert_start
+api: cat.health
+component: endpoints
+-->
 ## Endpoints
-
 ```json
-GET _cat/health?v
+GET /_cat/health
 ```
+<!-- spec_insert_end -->
+
 
+<!-- spec_insert_start
+api: cat.health
+component: query_parameters
+columns: Parameter, Data type, Description, Default
+include_deprecated: false
+-->
 ## 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`.
+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 |
+| `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. <br> 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` |
+
+<!-- spec_insert_end -->
 
 ## Example request
 

_api-reference/cat/cat-indices.md

@@ -15,24 +15,45 @@ 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.
 
 
+<!-- spec_insert_start
+api: cat.indices
+component: endpoints
+-->
 ## Endpoints
-
 ```json
-GET _cat/indices/<index>
-GET _cat/indices
+GET /_cat/indices
+GET /_cat/indices/{index}
 ```
+<!-- spec_insert_end -->
+
 
+<!-- spec_insert_start
+api: cat.indices
+component: query_parameters
+columns: Parameter, Data type, Description, Default
+include_deprecated: false
+-->
 ## 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`.
+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. <br> 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 | Specifies the type of index that wildcard expressions can match. Supports comma-separated values. <br> Valid values are: <br> - `all`: Match any index, including hidden ones. <br> - `closed`: Match closed, non-hidden indexes. <br> - `hidden`: Match hidden indexes. Must be combined with open, closed, or both. <br> - `none`: Wildcard expressions are not accepted. <br> - `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`. <br> 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. <br> Valid values are: `nanos`, `micros`, `ms`, `s`, `m`, `h`, `d` | N/A |
+| `v` | Boolean | Enables verbose mode, which displays column headers. | `false` |
+
+<!-- spec_insert_end -->
 
 ## Example requests
 

_api-reference/cat/cat-nodeattrs.md

@@ -15,18 +15,38 @@ redirect_from:
 The CAT nodeattrs operation lists the attributes of custom nodes.
 
 
+<!-- spec_insert_start
+api: cat.nodeattrs
+component: endpoints
+-->
 ## Endpoints
-
 ```json
-GET _cat/nodeattrs
+GET /_cat/nodeattrs
 ```
+<!-- spec_insert_end -->
+
 
+<!-- spec_insert_start
+api: cat.nodeattrs
+component: query_parameters
+columns: Parameter, Data type, Description, Default
+include_deprecated: false
+-->
 ## 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.
+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` |
+
+<!-- spec_insert_end -->
 
 ## Example request