Skip to content

Commit

Permalink
Add CAT API automation with updated spec-insert
Browse files Browse the repository at this point in the history 
Signed-off-by: Archer <[email protected]>
  • Loading branch information
@Naarcha-AWS
Naarcha-AWS committed Jan 13, 2025
1 parent 1aea840 commit e27ec68
Show file tree
Hide file tree
Showing 26 changed files with 49 additions and 56 deletions.
6 changes: 3 additions & 3 deletions _api-reference/cat/cat-aliases.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ api: cat.aliases
component: endpoints
-->
## Endpoints

```json
GET /_cat/aliases
GET /_cat/aliases/{name}
Expand All @@ -33,13 +32,14 @@ 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

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`. |
Expand Down
6 changes: 3 additions & 3 deletions _api-reference/cat/cat-allocation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ api: cat.allocation
component: endpoints
-->
## Endpoints

```json
GET /_cat/allocation
GET /_cat/allocation/{node_id}
Expand All @@ -32,13 +31,14 @@ 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

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. |
Expand Down
6 changes: 3 additions & 3 deletions _api-reference/cat/cat-cluster_manager.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ api: cat.cluster_manager
component: endpoints
-->
## Endpoints

```json
GET /_cat/cluster_manager
```
Expand All @@ -30,13 +29,14 @@ GET /_cat/cluster_manager
<!-- spec_insert_start
api: cat.cluster_manager
component: query_parameters
columns: Parameter,Type,Description,Default
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 | 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`. |
Expand Down
6 changes: 3 additions & 3 deletions _api-reference/cat/cat-count.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ api: cat.count
component: endpoints
-->
## Endpoints

```json
GET /_cat/count
GET /_cat/count/{index}
Expand All @@ -32,13 +31,14 @@ GET /_cat/count/{index}
<!-- spec_insert_start
api: cat.count
component: query_parameters
columns: Parameter,Type,Description,Default
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 | 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. |
Expand Down
6 changes: 3 additions & 3 deletions _api-reference/cat/cat-field-data.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ api: cat.fielddata
component: endpoints
-->
## Endpoints

```json
GET /_cat/fielddata
GET /_cat/fielddata/{fields}
Expand All @@ -30,13 +29,14 @@ GET /_cat/fielddata/{fields}
<!-- spec_insert_start
api: cat.fielddata
component: query_parameters
columns: Parameter,Type,Description,Default
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 | 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`. |
Expand Down
6 changes: 3 additions & 3 deletions _api-reference/cat/cat-health.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ api: cat.health
component: endpoints
-->
## Endpoints

```json
GET /_cat/health
```
Expand All @@ -30,13 +29,14 @@ GET /_cat/health
<!-- spec_insert_start
api: cat.health
component: query_parameters
columns: Parameter,Type,Description,Default
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 | 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. |
Expand Down
6 changes: 3 additions & 3 deletions _api-reference/cat/cat-indices.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ api: cat.indices
component: endpoints
-->
## Endpoints

```json
GET /_cat/indices
GET /_cat/indices/{index}
Expand All @@ -31,13 +30,14 @@ GET /_cat/indices/{index}
<!-- spec_insert_start
api: cat.indices
component: query_parameters
columns: Parameter,Type,Description,Default
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 | 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. |
Expand Down
6 changes: 3 additions & 3 deletions _api-reference/cat/cat-nodeattrs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ api: cat.nodeattrs
component: endpoints
-->
## Endpoints

```json
GET /_cat/nodeattrs
```
Expand All @@ -30,13 +29,14 @@ GET /_cat/nodeattrs
<!-- spec_insert_start
api: cat.nodeattrs
component: query_parameters
columns: Parameter,Type,Description,Default
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 | 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`. |
Expand Down
6 changes: 3 additions & 3 deletions _api-reference/cat/cat-nodes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ api: cat.nodes
component: endpoints
-->
## Endpoints

```json
GET /_cat/nodes
```
Expand All @@ -32,13 +31,14 @@ GET /_cat/nodes
<!-- spec_insert_start
api: cat.nodes
component: query_parameters
columns: Parameter,Type,Description,Default
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 | 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. |
Expand Down
6 changes: 3 additions & 3 deletions _api-reference/cat/cat-pending-tasks.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ api: cat.pending_tasks
component: endpoints
-->
## Endpoints

```json
GET /_cat/pending_tasks
```
Expand All @@ -30,13 +29,14 @@ GET /_cat/pending_tasks
<!-- spec_insert_start
api: cat.pending_tasks
component: query_parameters
columns: Parameter,Type,Description,Default
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 | 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`. |
Expand Down
7 changes: 3 additions & 4 deletions _api-reference/cat/cat-pit-segments.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ api: cat.pit_segments
component: endpoints
omit_header: true
-->

```json
GET /_cat/pit_segments
```
Expand All @@ -27,7 +26,6 @@ api: cat.all_pit_segments
component: endpoints
omit_header: true
-->

```json
GET /_cat/pit_segments/_all
```
Expand All @@ -36,13 +34,14 @@ GET /_cat/pit_segments/_all
<!-- spec_insert_start
api: cat.pit_segments
component: query_parameters
columns: Parameter,Type,Description,Default
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 | 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`. |
Expand Down
6 changes: 3 additions & 3 deletions _api-reference/cat/cat-plugins.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ api: cat.plugins
component: endpoints
-->
## Endpoints

```json
GET /_cat/plugins
```
Expand All @@ -29,13 +28,14 @@ GET /_cat/plugins
<!-- spec_insert_start
api: cat.plugins
component: query_parameters
columns: Parameter,Type,Description,Default
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 | 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`. |
Expand Down
6 changes: 3 additions & 3 deletions _api-reference/cat/cat-recovery.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ api: cat.recovery
component: endpoints
-->
## Endpoints

```json
GET /_cat/recovery
GET /_cat/recovery/{index}
Expand All @@ -31,13 +30,14 @@ GET /_cat/recovery/{index}
<!-- spec_insert_start
api: cat.recovery
component: query_parameters
columns: Parameter,Type,Description,Default
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 | 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. |
Expand Down
6 changes: 3 additions & 3 deletions _api-reference/cat/cat-repositories.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ api: cat.repositories
component: endpoints
-->
## Endpoints

```json
GET /_cat/repositories
```
Expand All @@ -29,13 +28,14 @@ GET /_cat/repositories
<!-- spec_insert_start
api: cat.repositories
component: query_parameters
columns: Parameter,Type,Description,Default
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 | 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`. |
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-segment-replication.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Parameter | Type | Description
<!-- spec_insert_start
api: cat.segment_replication
component: query_parameters
columns: Parameter,Type,Description,Default
columns: Parameter, Data type, Description, Default
include_deprecated: false
-->
## Query parameters
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-segments.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ GET /_cat/segments/{index}
<!-- spec_insert_start
api: cat.segments
component: query_parameters
columns: Parameter,Type,Description,Default
columns: Parameter, Data type, Description, Default
include_deprecated: false
-->
## Query parameters
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-shards.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ GET /_cat/shards/{index}
<!-- spec_insert_start
api: cat.shards
component: query_parameters
columns: Parameter,Type,Description,Default
columns: Parameter, Data type, Description, Default
include_deprecated: false
-->
## Query parameters
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-snapshots.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ GET /_cat/snapshots/{repository}
<!-- spec_insert_start
api: cat.snapshots
component: query_parameters
columns: Parameter,Type,Description,Default
columns: Parameter, Data type, Description, Default
include_deprecated: false
-->
## Query parameters
Expand Down
Loading

0 comments on commit e27ec68

Please sign in to comment.