Skip to content

Commit a14b170

Browse files
committed
Generate heading IDs
1 parent df3959c commit a14b170

File tree

500 files changed

+12670
-104
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

500 files changed

+12670
-104
lines changed

docs/reference-async_search-delete.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
////////
2727

2828
[discrete]
29+
[[client.asyncSearch.delete]]
2930
=== client.asyncSearch.delete
3031

3132
Delete an async search. If the asynchronous search is still running, it is cancelled. Otherwise, the saved search results are deleted. If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.

docs/reference-async_search-get.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
////////
2727

2828
[discrete]
29+
[[client.asyncSearch.get]]
2930
=== client.asyncSearch.get
3031

3132
Get async search results. Retrieve the results of a previously submitted asynchronous search request. If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.
@@ -65,7 +66,7 @@ interface AsyncSearchGetRequest extends <<RequestBase>> {
6566
++++
6667
<pre>
6768
++++
68-
type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
69+
type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
6970

7071
[pass]
7172
++++

docs/reference-async_search-status.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
////////
2727

2828
[discrete]
29+
[[client.asyncSearch.status]]
2930
=== client.asyncSearch.status
3031

3132
Get the async search status. Get the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.

docs/reference-async_search-submit.asciidoc

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
////////
2727

2828
[discrete]
29+
[[client.asyncSearch.submit]]
2930
=== client.asyncSearch.submit
3031

3132
Run an async search. When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.
@@ -58,7 +59,7 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
5859
analyze_wildcard?: boolean
5960
batched_reduce_size?: <<_long, long>>
6061
ccs_minimize_roundtrips?: boolean
61-
default_operator?: QueryDslOperator
62+
default_operator?: <<QueryDslOperator>>
6263
df?: string
6364
expand_wildcards?: <<ExpandWildcards>>
6465
ignore_throttled?: boolean
@@ -81,30 +82,30 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
8182
_source_excludes?: <<Fields>>
8283
_source_includes?: <<Fields>>
8384
q?: string
84-
aggregations?: Record<string, AggregationsAggregationContainer>
85+
aggregations?: Record<string, <<AggregationsAggregationContainer>>>
8586
pass:[/**] @alias aggregations */
86-
aggs?: Record<string, AggregationsAggregationContainer>
87+
aggs?: Record<string, <<AggregationsAggregationContainer>>>
8788
collapse?: SearchFieldCollapse
8889
explain?: boolean
8990
ext?: Record<string, any>
9091
from?: <<_integer, integer>>
9192
highlight?: SearchHighlight
9293
track_total_hits?: SearchTrackHits
9394
indices_boost?: Record<<<IndexName>>, <<_double, double>>>[]
94-
docvalue_fields?: (QueryDslFieldAndFormat | <<Field>>)[]
95+
docvalue_fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[]
9596
knn?: <<KnnSearch>> | <<KnnSearch>>[]
9697
min_score?: <<_double, double>>
97-
post_filter?: QueryDslQueryContainer
98+
post_filter?: <<QueryDslQueryContainer>>
9899
profile?: boolean
99-
query?: QueryDslQueryContainer
100+
query?: <<QueryDslQueryContainer>>
100101
rescore?: SearchRescore | SearchRescore[]
101102
script_fields?: Record<string, <<ScriptField>>>
102103
search_after?: <<SortResults>>
103104
size?: <<_integer, integer>>
104105
slice?: <<SlicedScroll>>
105106
sort?: <<Sort>>
106107
_source?: SearchSourceConfig
107-
fields?: (QueryDslFieldAndFormat | <<Field>>)[]
108+
fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[]
108109
suggest?: SearchSuggester
109110
terminate_after?: <<_long, long>>
110111
timeout?: string
@@ -113,7 +114,7 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
113114
seq_no_primary_term?: boolean
114115
stored_fields?: <<Fields>>
115116
pit?: SearchPointInTimeReference
116-
runtime_mappings?: MappingRuntimeFields
117+
runtime_mappings?: <<MappingRuntimeFields>>
117118
stats?: string[]
118119
}
119120

@@ -128,7 +129,7 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
128129
++++
129130
<pre>
130131
++++
131-
type AsyncSearchSubmitResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
132+
type AsyncSearchSubmitResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
132133

133134
[pass]
134135
++++

docs/reference-autoscaling-delete_autoscaling_policy.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
////////
2727

2828
[discrete]
29+
[[client.autoscaling.deleteAutoscalingPolicy]]
2930
=== client.autoscaling.deleteAutoscalingPolicy
3031

3132
Delete an autoscaling policy. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.

docs/reference-autoscaling-get_autoscaling_capacity.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
////////
2727

2828
[discrete]
29+
[[client.autoscaling.getAutoscalingCapacity]]
2930
=== client.autoscaling.getAutoscalingCapacity
3031

3132
Get the autoscaling capacity. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. This API gets the current autoscaling capacity based on the configured autoscaling policy. It will return information to size the cluster appropriately to the current workload. The `required_capacity` is calculated as the maximum of the `required_capacity` result of all individual deciders that are enabled for the policy. The operator should verify that the `current_nodes` match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information. The response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required. This information is provided for diagnosis only. Do not use this information to make autoscaling decisions.

docs/reference-autoscaling-get_autoscaling_policy.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
////////
2727

2828
[discrete]
29+
[[client.autoscaling.getAutoscalingPolicy]]
2930
=== client.autoscaling.getAutoscalingPolicy
3031

3132
Get an autoscaling policy. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.

docs/reference-autoscaling-put_autoscaling_policy.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
////////
2727

2828
[discrete]
29+
[[client.autoscaling.putAutoscalingPolicy]]
2930
=== client.autoscaling.putAutoscalingPolicy
3031

3132
Create or update an autoscaling policy. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.

docs/reference-bulk.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
////////
2727

2828
[discrete]
29+
[[client.bulk]]
2930
=== client.bulk
3031

3132
Bulk index or delete documents. Performs multiple indexing or delete operations in a single API call. This reduces overhead and can greatly increase indexing speed.

docs/reference-cat-aliases.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
////////
2727

2828
[discrete]
29+
[[client.cat.aliases]]
2930
=== client.cat.aliases
3031

3132
Get aliases. Retrieves the cluster’s index aliases, including filter and routing information. The API does not return data stream aliases. CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.

0 commit comments

Comments
 (0)