Skip to content

Commit 5371b37

Browse files
committed
Updates to generated docs
1 parent bcb5cfb commit 5371b37

30 files changed

+383
-130
lines changed

docs/reference/async_search.asciidoc

+1-4
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@ Get the async search status. Get the status of a previously submitted async sear
133133
----
134134
interface AsyncSearchStatusRequest extends <<RequestBase>> {
135135
id: <<Id>>
136+
keep_alive?: <<Duration>>
136137
}
137138
138139
----
@@ -172,7 +173,6 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
172173
index?: <<Indices>>
173174
wait_for_completion_timeout?: <<Duration>>
174175
keep_on_completion?: boolean
175-
keep_alive?: <<Duration>>
176176
allow_no_indices?: boolean
177177
allow_partial_search_results?: boolean
178178
analyzer?: string
@@ -186,12 +186,9 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
186186
ignore_unavailable?: boolean
187187
lenient?: boolean
188188
max_concurrent_shard_requests?: <<long>>
189-
min_compatible_shard_node?: <<VersionString>>
190189
preference?: string
191-
pre_filter_shard_size?: <<long>>
192190
request_cache?: boolean
193191
routing?: <<Routing>>
194-
scroll?: <<Duration>>
195192
search_type?: <<SearchType>>
196193
suggest_field?: <<Field>>
197194
suggest_mode?: <<SuggestMode>>

docs/reference/autoscaling.asciidoc

+8-1
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ Delete an autoscaling policy. NOTE: This feature is designed for indirect use by
5656
----
5757
interface AutoscalingDeleteAutoscalingPolicyRequest extends <<RequestBase>> {
5858
name: <<Name>>
59+
master_timeout?: <<Duration>>
60+
timeout?: <<Duration>>
5961
}
6062
6163
----
@@ -91,7 +93,9 @@ Get the autoscaling capacity. NOTE: This feature is designed for indirect use by
9193

9294
[source,ts,subs=+macros]
9395
----
94-
interface AutoscalingGetAutoscalingCapacityRequest extends <<RequestBase>> {}
96+
interface AutoscalingGetAutoscalingCapacityRequest extends <<RequestBase>> {
97+
master_timeout?: <<Duration>>
98+
}
9599
96100
----
97101

@@ -130,6 +134,7 @@ Get an autoscaling policy. NOTE: This feature is designed for indirect use by El
130134
----
131135
interface AutoscalingGetAutoscalingPolicyRequest extends <<RequestBase>> {
132136
name: <<Name>>
137+
master_timeout?: <<Duration>>
133138
}
134139
135140
----
@@ -167,6 +172,8 @@ Create or update an autoscaling policy. NOTE: This feature is designed for indir
167172
----
168173
interface AutoscalingPutAutoscalingPolicyRequest extends <<RequestBase>> {
169174
name: <<Name>>
175+
master_timeout?: <<Duration>>
176+
timeout?: <<Duration>>
170177
policy?: <<AutoscalingAutoscalingPolicy>>
171178
}
172179

docs/reference/cat.asciidoc

+34-21
Large diffs are not rendered by default.

docs/reference/ccr.asciidoc

+11-9
Original file line numberDiff line numberDiff line change
@@ -94,18 +94,20 @@ Creates a new follower index configured to follow the referenced leader index.
9494
interface CcrFollowRequest extends <<RequestBase>> {
9595
index: <<IndexName>>
9696
wait_for_active_shards?: <<WaitForActiveShards>>
97-
leader_index?: <<IndexName>>
97+
data_stream_name?: string
98+
leader_index: <<IndexName>>
9899
max_outstanding_read_requests?: <<long>>
99-
max_outstanding_write_requests?: <<long>>
100-
max_read_request_operation_count?: <<long>>
101-
max_read_request_size?: string
100+
max_outstanding_write_requests?: <<integer>>
101+
max_read_request_operation_count?: <<integer>>
102+
max_read_request_size?: <<ByteSize>>
102103
max_retry_delay?: <<Duration>>
103-
max_write_buffer_count?: <<long>>
104-
max_write_buffer_size?: string
105-
max_write_request_operation_count?: <<long>>
106-
max_write_request_size?: string
104+
max_write_buffer_count?: <<integer>>
105+
max_write_buffer_size?: <<ByteSize>>
106+
max_write_request_operation_count?: <<integer>>
107+
max_write_request_size?: <<ByteSize>>
107108
read_poll_timeout?: <<Duration>>
108-
remote_cluster?: string
109+
remote_cluster: string
110+
settings?: <<IndicesIndexSettings>>
109111
}
110112
111113
----

docs/reference/count.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
[[client.count]]
3939
== `client.count()`
4040

41-
Returns number of documents matching a query.
41+
Count search results. Get the number of documents matching a query.
4242

4343
{ref}/search-count.html[{es} documentation]
4444
[discrete]

docs/reference/enrich.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ type EnrichDeletePolicyResponse = <<AcknowledgedResponseBase>>
7575
[[client.enrich.executePolicy]]
7676
== `client.enrich.executePolicy()`
7777

78-
Creates the enrich index for an existing enrich policy.
78+
Run an enrich policy. Create the enrich index for an existing enrich policy.
7979

8080
{ref}/execute-enrich-policy-api.html[{es} documentation]
8181
[discrete]

docs/reference/eql.asciidoc

+5-4
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
[[client.eql.delete]]
3939
== `client.eql.delete()`
4040

41-
Deletes an async EQL search or a stored synchronous EQL search. The API also deletes results for the search.
41+
Delete an async EQL search. Delete an async EQL search or a stored synchronous EQL search. The API also deletes results for the search.
4242

4343
{ref}/eql-search-api.html[{es} documentation]
4444
[discrete]
@@ -75,7 +75,7 @@ type EqlDeleteResponse = <<AcknowledgedResponseBase>>
7575
[[client.eql.get]]
7676
== `client.eql.get()`
7777

78-
Returns the current status and available results for an async EQL search or a stored synchronous EQL search.
78+
Get async EQL search results. Get the current status and available results for an async EQL search or a stored synchronous EQL search.
7979

8080
{ref}/get-async-eql-search-api.html[{es} documentation]
8181
[discrete]
@@ -114,7 +114,7 @@ type EqlGetResponse<TEvent = unknown> = <<EqlEqlSearchResponseBase>><TEvent>
114114
[[client.eql.getStatus]]
115115
== `client.eql.getStatus()`
116116

117-
Returns the current status for an async EQL search or a stored synchronous EQL search without returning results.
117+
Get the async EQL status. Get the current status for an async EQL search or a stored synchronous EQL search without returning results.
118118

119119
{ref}/get-async-eql-status-api.html[{es} documentation]
120120
[discrete]
@@ -158,7 +158,7 @@ interface EqlGetStatusResponse {
158158
[[client.eql.search]]
159159
== `client.eql.search()`
160160

161-
Returns results matching a query expressed in Event Query Language (EQL)
161+
Get EQL search results. Returns search results for an Event Query Language (EQL) query. EQL assumes each document in a data stream or index corresponds to an event.
162162

163163
{ref}/eql-search-api.html[{es} documentation]
164164
[discrete]
@@ -193,6 +193,7 @@ interface EqlSearchRequest extends <<RequestBase>> {
193193
fields?: <<QueryDslFieldAndFormat>> | <<Field>> | (<<QueryDslFieldAndFormat>> | <<Field>>)[]
194194
result_position?: EqlSearchResultPosition
195195
runtime_mappings?: <<MappingRuntimeFields>>
196+
max_samples_per_key?: <<integer>>
196197
}
197198
198199
----

docs/reference/esql.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Retrieves the results of a previously submitted async query request given its ID
6868
[[client.esql.query]]
6969
== `client.esql.query()`
7070

71-
Executes an ES|QL request
71+
Run an ES|QL query. Get search results for an ES|QL (Elasticsearch query language) query.
7272

7373
{ref}/esql-rest.html[{es} documentation]
7474
[discrete]

docs/reference/fleet.asciidoc

+3-4
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
[[client.fleet.globalCheckpoints]]
3939
== `client.fleet.globalCheckpoints()`
4040

41-
Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project.
41+
Get global checkpoints. Get the current global checkpoints for an index. This API is designed for internal use by the Fleet server project.
4242

4343
{ref}/get-global-checkpoints.html[{es} documentation]
4444
[discrete]
@@ -82,7 +82,7 @@ interface FleetGlobalCheckpointsResponse {
8282
[[client.fleet.msearch]]
8383
== `client.fleet.msearch()`
8484

85-
Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request. The API follows the same structure as the [multi search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html) API. However, similar to the fleet search API, it supports the wait_for_checkpoints parameter.
85+
Run multiple Fleet searches. Run several Fleet searches with a single API request. The API follows the same structure as the multi search API. However, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter.
8686
[discrete]
8787
=== Function signature
8888

@@ -133,7 +133,7 @@ interface FleetMsearchResponse<TDocument = unknown> {
133133
[[client.fleet.search]]
134134
== `client.fleet.search()`
135135

136-
The purpose of the fleet search api is to provide a search api where the search will only be executed after provided checkpoint has been processed and is visible for searches inside of Elasticsearch.
136+
Run a Fleet search. The purpose of the Fleet search API is to provide an API where the search will be run only after the provided checkpoint has been processed and is visible for searches inside of Elasticsearch.
137137
[discrete]
138138
=== Function signature
139139

@@ -161,7 +161,6 @@ interface FleetSearchRequest extends <<RequestBase>> {
161161
ignore_unavailable?: boolean
162162
lenient?: boolean
163163
max_concurrent_shard_requests?: <<long>>
164-
min_compatible_shard_node?: <<VersionString>>
165164
preference?: string
166165
pre_filter_shard_size?: <<long>>
167166
request_cache?: boolean

docs/reference/graph.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
[[client.graph.explore]]
3939
== `client.graph.explore()`
4040

41-
Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index.
41+
Explore graph analytics. Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. An initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. Subsequent requests enable you to spider out from one more vertices of interest. You can exclude vertices that have already been returned.
4242

4343
{ref}/graph-explore-api.html[{es} documentation]
4444
[discrete]

docs/reference/indices.asciidoc

+5-7
Original file line numberDiff line numberDiff line change
@@ -788,7 +788,7 @@ interface IndicesExistsAliasRequest extends <<RequestBase>> {
788788
allow_no_indices?: boolean
789789
expand_wildcards?: <<ExpandWildcards>>
790790
ignore_unavailable?: boolean
791-
local?: boolean
791+
master_timeout?: <<Duration>>
792792
}
793793
794794
----
@@ -808,7 +808,7 @@ type IndicesExistsAliasResponse = boolean
808808
[[client.indices.existsIndexTemplate]]
809809
== `client.indices.existsIndexTemplate()`
810810

811-
Returns information about whether a particular index template exists.
811+
Check index templates. Check whether index templates exist.
812812

813813
{ref}/index-templates.html[{es} documentation]
814814
[discrete]
@@ -1124,7 +1124,7 @@ interface IndicesGetAliasRequest extends <<RequestBase>> {
11241124
allow_no_indices?: boolean
11251125
expand_wildcards?: <<ExpandWildcards>>
11261126
ignore_unavailable?: boolean
1127-
local?: boolean
1127+
master_timeout?: <<Duration>>
11281128
}
11291129
11301130
----
@@ -1668,8 +1668,7 @@ interface IndicesPutDataLifecycleRequest extends <<RequestBase>> {
16681668
expand_wildcards?: <<ExpandWildcards>>
16691669
master_timeout?: <<Duration>>
16701670
timeout?: <<Duration>>
1671-
data_retention?: <<Duration>>
1672-
downsampling?: <<IndicesDataStreamLifecycleDownsampling>>
1671+
lifecycle?: <<IndicesDataStreamLifecycle>>
16731672
}
16741673
16751674
----
@@ -2044,7 +2043,7 @@ type IndicesResolveClusterResponse = Record<<<ClusterAlias>>, IndicesResolveClus
20442043
[[client.indices.resolveIndex]]
20452044
== `client.indices.resolveIndex()`
20462045

2047-
Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported.
2046+
Resolve indices. Resolve the names and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported.
20482047

20492048
{ref}/indices-resolve-index-api.html[{es} documentation]
20502049
[discrete]
@@ -2163,7 +2162,6 @@ interface IndicesSegmentsRequest extends <<RequestBase>> {
21632162
allow_no_indices?: boolean
21642163
expand_wildcards?: <<ExpandWildcards>>
21652164
ignore_unavailable?: boolean
2166-
verbose?: boolean
21672165
}
21682166
21692167
----

0 commit comments

Comments
 (0)