Skip to content

Commit

Permalink
Updates to generated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshMock committed Dec 5, 2024
1 parent 86a5736 commit 36d61ed
Show file tree
Hide file tree
Showing 30 changed files with 383 additions and 130 deletions.
5 changes: 1 addition & 4 deletions docs/reference/async_search.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ Get the async search status. Get the status of a previously submitted async sear
----
interface AsyncSearchStatusRequest extends <<RequestBase>> {
id: <<Id>>
keep_alive?: <<Duration>>
}
----
Expand Down Expand Up @@ -172,7 +173,6 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
index?: <<Indices>>
wait_for_completion_timeout?: <<Duration>>
keep_on_completion?: boolean
keep_alive?: <<Duration>>
allow_no_indices?: boolean
allow_partial_search_results?: boolean
analyzer?: string
Expand All @@ -186,12 +186,9 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
ignore_unavailable?: boolean
lenient?: boolean
max_concurrent_shard_requests?: <<long>>
min_compatible_shard_node?: <<VersionString>>
preference?: string
pre_filter_shard_size?: <<long>>
request_cache?: boolean
routing?: <<Routing>>
scroll?: <<Duration>>
search_type?: <<SearchType>>
suggest_field?: <<Field>>
suggest_mode?: <<SuggestMode>>
Expand Down
9 changes: 8 additions & 1 deletion docs/reference/autoscaling.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ Delete an autoscaling policy. NOTE: This feature is designed for indirect use by
----
interface AutoscalingDeleteAutoscalingPolicyRequest extends <<RequestBase>> {
name: <<Name>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
Expand Down Expand Up @@ -91,7 +93,9 @@ Get the autoscaling capacity. NOTE: This feature is designed for indirect use by

[source,ts,subs=+macros]
----
interface AutoscalingGetAutoscalingCapacityRequest extends <<RequestBase>> {}
interface AutoscalingGetAutoscalingCapacityRequest extends <<RequestBase>> {
master_timeout?: <<Duration>>
}
----

Expand Down Expand Up @@ -130,6 +134,7 @@ Get an autoscaling policy. NOTE: This feature is designed for indirect use by El
----
interface AutoscalingGetAutoscalingPolicyRequest extends <<RequestBase>> {
name: <<Name>>
master_timeout?: <<Duration>>
}
----
Expand Down Expand Up @@ -167,6 +172,8 @@ Create or update an autoscaling policy. NOTE: This feature is designed for indir
----
interface AutoscalingPutAutoscalingPolicyRequest extends <<RequestBase>> {
name: <<Name>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
policy?: <<AutoscalingAutoscalingPolicy>>
}
Expand Down
55 changes: 34 additions & 21 deletions docs/reference/cat.asciidoc

Large diffs are not rendered by default.

20 changes: 11 additions & 9 deletions docs/reference/ccr.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -94,18 +94,20 @@ Creates a new follower index configured to follow the referenced leader index.
interface CcrFollowRequest extends <<RequestBase>> {
index: <<IndexName>>
wait_for_active_shards?: <<WaitForActiveShards>>
leader_index?: <<IndexName>>
data_stream_name?: string
leader_index: <<IndexName>>
max_outstanding_read_requests?: <<long>>
max_outstanding_write_requests?: <<long>>
max_read_request_operation_count?: <<long>>
max_read_request_size?: string
max_outstanding_write_requests?: <<integer>>
max_read_request_operation_count?: <<integer>>
max_read_request_size?: <<ByteSize>>
max_retry_delay?: <<Duration>>
max_write_buffer_count?: <<long>>
max_write_buffer_size?: string
max_write_request_operation_count?: <<long>>
max_write_request_size?: string
max_write_buffer_count?: <<integer>>
max_write_buffer_size?: <<ByteSize>>
max_write_request_operation_count?: <<integer>>
max_write_request_size?: <<ByteSize>>
read_poll_timeout?: <<Duration>>
remote_cluster?: string
remote_cluster: string
settings?: <<IndicesIndexSettings>>
}
----
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/count.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
[[client.count]]
== `client.count()`

Returns number of documents matching a query.
Count search results. Get the number of documents matching a query.

{ref}/search-count.html[{es} documentation]
[discrete]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/enrich.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ type EnrichDeletePolicyResponse = <<AcknowledgedResponseBase>>
[[client.enrich.executePolicy]]
== `client.enrich.executePolicy()`

Creates the enrich index for an existing enrich policy.
Run an enrich policy. Create the enrich index for an existing enrich policy.

{ref}/execute-enrich-policy-api.html[{es} documentation]
[discrete]
Expand Down
9 changes: 5 additions & 4 deletions docs/reference/eql.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
[[client.eql.delete]]
== `client.eql.delete()`

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

{ref}/eql-search-api.html[{es} documentation]
[discrete]
Expand Down Expand Up @@ -75,7 +75,7 @@ type EqlDeleteResponse = <<AcknowledgedResponseBase>>
[[client.eql.get]]
== `client.eql.get()`

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

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

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

{ref}/get-async-eql-status-api.html[{es} documentation]
[discrete]
Expand Down Expand Up @@ -158,7 +158,7 @@ interface EqlGetStatusResponse {
[[client.eql.search]]
== `client.eql.search()`

Returns results matching a query expressed in Event Query Language (EQL)
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.

{ref}/eql-search-api.html[{es} documentation]
[discrete]
Expand Down Expand Up @@ -193,6 +193,7 @@ interface EqlSearchRequest extends <<RequestBase>> {
fields?: <<QueryDslFieldAndFormat>> | <<Field>> | (<<QueryDslFieldAndFormat>> | <<Field>>)[]
result_position?: EqlSearchResultPosition
runtime_mappings?: <<MappingRuntimeFields>>
max_samples_per_key?: <<integer>>
}
----
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/esql.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Retrieves the results of a previously submitted async query request given its ID
[[client.esql.query]]
== `client.esql.query()`

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

{ref}/esql-rest.html[{es} documentation]
[discrete]
Expand Down
7 changes: 3 additions & 4 deletions docs/reference/fleet.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
[[client.fleet.globalCheckpoints]]
== `client.fleet.globalCheckpoints()`

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

{ref}/get-global-checkpoints.html[{es} documentation]
[discrete]
Expand Down Expand Up @@ -82,7 +82,7 @@ interface FleetGlobalCheckpointsResponse {
[[client.fleet.msearch]]
== `client.fleet.msearch()`

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.
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.
[discrete]
=== Function signature

Expand Down Expand Up @@ -133,7 +133,7 @@ interface FleetMsearchResponse<TDocument = unknown> {
[[client.fleet.search]]
== `client.fleet.search()`

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.
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.
[discrete]
=== Function signature

Expand Down Expand Up @@ -161,7 +161,6 @@ interface FleetSearchRequest extends <<RequestBase>> {
ignore_unavailable?: boolean
lenient?: boolean
max_concurrent_shard_requests?: <<long>>
min_compatible_shard_node?: <<VersionString>>
preference?: string
pre_filter_shard_size?: <<long>>
request_cache?: boolean
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/graph.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
[[client.graph.explore]]
== `client.graph.explore()`

Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index.
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.

{ref}/graph-explore-api.html[{es} documentation]
[discrete]
Expand Down
12 changes: 5 additions & 7 deletions docs/reference/indices.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -788,7 +788,7 @@ interface IndicesExistsAliasRequest extends <<RequestBase>> {
allow_no_indices?: boolean
expand_wildcards?: <<ExpandWildcards>>
ignore_unavailable?: boolean
local?: boolean
master_timeout?: <<Duration>>
}
----
Expand All @@ -808,7 +808,7 @@ type IndicesExistsAliasResponse = boolean
[[client.indices.existsIndexTemplate]]
== `client.indices.existsIndexTemplate()`

Returns information about whether a particular index template exists.
Check index templates. Check whether index templates exist.

{ref}/index-templates.html[{es} documentation]
[discrete]
Expand Down Expand Up @@ -1124,7 +1124,7 @@ interface IndicesGetAliasRequest extends <<RequestBase>> {
allow_no_indices?: boolean
expand_wildcards?: <<ExpandWildcards>>
ignore_unavailable?: boolean
local?: boolean
master_timeout?: <<Duration>>
}
----
Expand Down Expand Up @@ -1668,8 +1668,7 @@ interface IndicesPutDataLifecycleRequest extends <<RequestBase>> {
expand_wildcards?: <<ExpandWildcards>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
data_retention?: <<Duration>>
downsampling?: <<IndicesDataStreamLifecycleDownsampling>>
lifecycle?: <<IndicesDataStreamLifecycle>>
}
----
Expand Down Expand Up @@ -2044,7 +2043,7 @@ type IndicesResolveClusterResponse = Record<<<ClusterAlias>>, IndicesResolveClus
[[client.indices.resolveIndex]]
== `client.indices.resolveIndex()`

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

{ref}/indices-resolve-index-api.html[{es} documentation]
[discrete]
Expand Down Expand Up @@ -2163,7 +2162,6 @@ interface IndicesSegmentsRequest extends <<RequestBase>> {
allow_no_indices?: boolean
expand_wildcards?: <<ExpandWildcards>>
ignore_unavailable?: boolean
verbose?: boolean
}
----
Expand Down
Loading

0 comments on commit 36d61ed

Please sign in to comment.