habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

More iteration on generated docs

Browse Source
This commit is contained in:
Josh Mock
2024-11-19 17:04:50 -06:00
parent 4afd72b173
commit e0372eea89
503 changed files with 11653 additions and 6026 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/basic-config.asciidoc
View File

@ -85,7 +85,7 @@ _Default:_ `3`
_Default:_ `30000`
|`pingTimeout`
|`number` - Max ping request timeout in milliseconds for each request. +
|`number` - Max number of milliseconds a `ClusterConnectionPool` will wait when pinging nodes before marking them dead. +
_Default:_ `3000`
|`sniffInterval`
@ -105,17 +105,13 @@ _Default:_ `'_nodes/_all/http'`
_Default:_ `false`
|`resurrectStrategy`
|`string` - Configure the node resurrection strategy. +
|`string` - Strategy for resurrecting dead nodes when using `ClusterConnectionPool`. 'ping' will issue a test request to a node and resurrect it if it responds. 'optimistic' marks a node as alive without testing it. 'none' will never attempt to revive a dead connection. +
_Options:_ `'ping'`, `'optimistic'`, `'none'` +
_Default:_ `'ping'`
|`suggestCompression`
|`boolean` - Adds `accept-encoding` header to every request. +
_Default:_ `false`
|`compression`
|`string, boolean` - Enables gzip request body compression. +
_Options:_ `'gzip'`, `false` +
_Options:_ `true`, `false` +
_Default:_ `false`
|`tls`

4
docs/index.asciidoc
View File

@ -1,8 +1,5 @@
= Elasticsearch JavaScript Client
include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[]
include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
include::introduction.asciidoc[]
include::getting-started.asciidoc[]
include::changelog.asciidoc[]
@ -20,5 +17,4 @@ include::typescript.asciidoc[]
include::reference-main-index.asciidoc[]
include::examples/index.asciidoc[]
include::helpers.asciidoc[]
include::redirects.asciidoc[]
include::timeout-best-practices.asciidoc[]

26
docs/reference-async_search-delete.asciidoc
View File

@ -41,20 +41,30 @@ Delete an async search. If the asynchronous search is still running, it is cance
----
[discrete]
===== `AsyncSearchDeleteRequest`
==== AsyncSearchDeleteRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface AsyncSearchDeleteRequest extends <<RequestBase>> {
id: <<Id>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `AsyncSearchDeleteResponse`
==== AsyncSearchDeleteResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type AsyncSearchDeleteResponse = <<AcknowledgedResponseBase>>
----
[pass]
++++
</pre>
++++

26
docs/reference-async_search-get.asciidoc
View File

@ -41,23 +41,33 @@ Get async search results. Retrieve the results of a previously submitted asynchr
----
[discrete]
===== `AsyncSearchGetRequest`
==== AsyncSearchGetRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface AsyncSearchGetRequest extends <<RequestBase>> {
id: <<Id>>
keep_alive?: <<Duration>>
typed_keys?: boolean
wait_for_completion_timeout?: <<Duration>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `AsyncSearchGetResponse`
==== AsyncSearchGetResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
----
[pass]
++++
</pre>
++++

26
docs/reference-async_search-status.asciidoc
View File

@ -41,20 +41,30 @@ Get the async search status. Get the status of a previously submitted async sear
----
[discrete]
===== `AsyncSearchStatusRequest`
==== AsyncSearchStatusRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface AsyncSearchStatusRequest extends <<RequestBase>> {
id: <<Id>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `AsyncSearchStatusResponse`
==== AsyncSearchStatusResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type AsyncSearchStatusResponse = AsyncSearchStatusStatusResponseBase
----
[pass]
++++
</pre>
++++

44
docs/reference-async_search-submit.asciidoc
View File

@ -41,10 +41,12 @@ Run an async search. When the primary sort of the results is an indexed field, s
----
[discrete]
===== `AsyncSearchSubmitRequest`
==== AsyncSearchSubmitRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface AsyncSearchSubmitRequest extends <<RequestBase>> {
index?: <<Indices>>
wait_for_completion_timeout?: <<Duration>>
@ -54,7 +56,7 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
allow_partial_search_results?: boolean
analyzer?: string
analyze_wildcard?: boolean
batched_reduce_size?: <<long>>
batched_reduce_size?: number
ccs_minimize_roundtrips?: boolean
default_operator?: QueryDslOperator
df?: string
@ -62,17 +64,17 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
ignore_throttled?: boolean
ignore_unavailable?: boolean
lenient?: boolean
max_concurrent_shard_requests?: <<long>>
max_concurrent_shard_requests?: number
min_compatible_shard_node?: <<VersionString>>
preference?: string
pre_filter_shard_size?: <<long>>
pre_filter_shard_size?: number
request_cache?: boolean
routing?: <<Routing>>
scroll?: <<Duration>>
search_type?: <<SearchType>>
suggest_field?: <<Field>>
suggest_mode?: <<SuggestMode>>
suggest_size?: <<long>>
suggest_size?: number
suggest_text?: string
typed_keys?: boolean
rest_total_hits_as_int?: boolean
@ -85,26 +87,26 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
collapse?: SearchFieldCollapse
explain?: boolean
ext?: Record<string, any>
from?: <<integer>>
from?: number
highlight?: SearchHighlight
track_total_hits?: SearchTrackHits
indices_boost?: Record<<<IndexName>>, <<double>>>[]
indices_boost?: Record<<<IndexName>>, number>[]
docvalue_fields?: (QueryDslFieldAndFormat | <<Field>>)[]
knn?: <<KnnSearch>> | <<KnnSearch>>[]
min_score?: <<double>>
min_score?: number
post_filter?: QueryDslQueryContainer
profile?: boolean
query?: QueryDslQueryContainer
rescore?: SearchRescore | SearchRescore[]
script_fields?: Record<string, <<ScriptField>>>
search_after?: <<SortResults>>
size?: <<integer>>
size?: number
slice?: <<SlicedScroll>>
sort?: <<Sort>>
_source?: SearchSourceConfig
fields?: (QueryDslFieldAndFormat | <<Field>>)[]
suggest?: SearchSuggester
terminate_after?: <<long>>
terminate_after?: number
timeout?: string
track_scores?: boolean
version?: boolean
@ -114,13 +116,21 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
runtime_mappings?: MappingRuntimeFields
stats?: string[]
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `AsyncSearchSubmitResponse`
==== AsyncSearchSubmitResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type AsyncSearchSubmitResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
----
[pass]
++++
</pre>
++++

26
docs/reference-autoscaling-delete_autoscaling_policy.asciidoc
View File

@ -41,20 +41,30 @@ Delete an autoscaling policy. NOTE: This feature is designed for indirect use by
----
[discrete]
===== `AutoscalingDeleteAutoscalingPolicyRequest`
==== AutoscalingDeleteAutoscalingPolicyRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface AutoscalingDeleteAutoscalingPolicyRequest extends <<RequestBase>> {
name: <<Name>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `AutoscalingDeleteAutoscalingPolicyResponse`
==== AutoscalingDeleteAutoscalingPolicyResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type AutoscalingDeleteAutoscalingPolicyResponse = <<AcknowledgedResponseBase>>
----
[pass]
++++
</pre>
++++

26
docs/reference-autoscaling-get_autoscaling_capacity.asciidoc
View File

@ -41,21 +41,31 @@ Get the autoscaling capacity. NOTE: This feature is designed for indirect use by
----
[discrete]
===== `AutoscalingGetAutoscalingCapacityRequest`
==== AutoscalingGetAutoscalingCapacityRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface AutoscalingGetAutoscalingCapacityRequest extends <<RequestBase>> {
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `AutoscalingGetAutoscalingCapacityResponse`
==== AutoscalingGetAutoscalingCapacityResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface AutoscalingGetAutoscalingCapacityResponse {
policies: Record<string, AutoscalingGetAutoscalingCapacityAutoscalingDeciders>
}
----
[pass]
++++
</pre>
++++

26
docs/reference-autoscaling-get_autoscaling_policy.asciidoc
View File

@ -41,20 +41,30 @@ Get an autoscaling policy. NOTE: This feature is designed for indirect use by El
----
[discrete]
===== `AutoscalingGetAutoscalingPolicyRequest`
==== AutoscalingGetAutoscalingPolicyRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface AutoscalingGetAutoscalingPolicyRequest extends <<RequestBase>> {
name: <<Name>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `AutoscalingGetAutoscalingPolicyResponse`
==== AutoscalingGetAutoscalingPolicyResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type AutoscalingGetAutoscalingPolicyResponse = AutoscalingAutoscalingPolicy
----
[pass]
++++
</pre>
++++

26
docs/reference-autoscaling-put_autoscaling_policy.asciidoc
View File

@ -41,21 +41,31 @@ Create or update an autoscaling policy. NOTE: This feature is designed for indir
----
[discrete]
===== `AutoscalingPutAutoscalingPolicyRequest`
==== AutoscalingPutAutoscalingPolicyRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface AutoscalingPutAutoscalingPolicyRequest extends <<RequestBase>> {
name: <<Name>>
policy?: AutoscalingAutoscalingPolicy
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `AutoscalingPutAutoscalingPolicyResponse`
==== AutoscalingPutAutoscalingPolicyResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type AutoscalingPutAutoscalingPolicyResponse = <<AcknowledgedResponseBase>>
----
[pass]
++++
</pre>
++++

30
docs/reference-bulk.asciidoc
View File

@ -41,10 +41,12 @@ Bulk index or delete documents. Performs multiple indexing or delete operations
----
[discrete]
===== `BulkRequest`
==== BulkRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface BulkRequest<TDocument = unknown, TPartialDocument = unknown> extends <<RequestBase>> {
index?: <<IndexName>>
pipeline?: string
@ -58,18 +60,26 @@ interface BulkRequest<TDocument = unknown, TPartialDocument = unknown> extends <
require_alias?: boolean
operations?: (BulkOperationContainer | BulkUpdateAction<TDocument, TPartialDocument> | TDocument)[]
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `BulkResponse`
==== BulkResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface BulkResponse {
errors: boolean
items: Partial<Record<BulkOperationType, BulkResponseItem>>[]
took: <<long>>
ingest_took?: <<long>>
took: number
ingest_took?: number
}
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-aliases.asciidoc
View File

@ -41,21 +41,31 @@ Get aliases. Retrieves the cluster’s index aliases, including filter and routi
----
[discrete]
===== `CatAliasesRequest`
==== CatAliasesRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatAliasesRequest extends CatCatRequestBase {
name?: <<Names>>
expand_wildcards?: <<ExpandWildcards>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatAliasesResponse`
==== CatAliasesResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatAliasesResponse = CatAliasesAliasesRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-allocation.asciidoc
View File

@ -41,21 +41,31 @@ Provides a snapshot of the number of shards allocated to each data node and thei
----
[discrete]
===== `CatAllocationRequest`
==== CatAllocationRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatAllocationRequest extends CatCatRequestBase {
node_id?: <<NodeIds>>
bytes?: <<Bytes>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatAllocationResponse`
==== CatAllocationResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatAllocationResponse = CatAllocationAllocationRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-component_templates.asciidoc
View File

@ -41,20 +41,30 @@ Get component templates. Returns information about component templates in a clus
----
[discrete]
===== `CatComponentTemplatesRequest`
==== CatComponentTemplatesRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatComponentTemplatesRequest extends CatCatRequestBase {
name?: string
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatComponentTemplatesResponse`
==== CatComponentTemplatesResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatComponentTemplatesResponse = CatComponentTemplatesComponentTemplate[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-count.asciidoc
View File

@ -41,20 +41,30 @@ Get a document count. Provides quick access to a document count for a data strea
----
[discrete]
===== `CatCountRequest`
==== CatCountRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatCountRequest extends CatCatRequestBase {
index?: <<Indices>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatCountResponse`
==== CatCountResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatCountResponse = CatCountCountRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-fielddata.asciidoc
View File

@ -41,21 +41,31 @@ Returns the amount of heap memory currently used by the field data cache on ever
----
[discrete]
===== `CatFielddataRequest`
==== CatFielddataRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatFielddataRequest extends CatCatRequestBase {
fields?: <<Fields>>
bytes?: <<Bytes>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatFielddataResponse`
==== CatFielddataResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatFielddataResponse = CatFielddataFielddataRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-health.asciidoc
View File

@ -41,21 +41,31 @@ Returns the health status of a cluster, similar to the cluster health API. IMPOR
----
[discrete]
===== `CatHealthRequest`
==== CatHealthRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatHealthRequest extends CatCatRequestBase {
time?: <<TimeUnit>>
ts?: boolean
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatHealthResponse`
==== CatHealthResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatHealthResponse = CatHealthHealthRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-help.asciidoc
View File

@ -41,19 +41,29 @@ Get CAT help. Returns help for the CAT APIs.
----
[discrete]
===== `CatHelpRequest`
==== CatHelpRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatHelpRequest extends CatCatRequestBase {
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatHelpResponse`
==== CatHelpResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatHelpResponse = CatHelpHelpRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-indices.asciidoc
View File

@ -41,10 +41,12 @@ Get index information. Returns high-level information about indices in a cluster
----
[discrete]
===== `CatIndicesRequest`
==== CatIndicesRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatIndicesRequest extends CatCatRequestBase {
index?: <<Indices>>
bytes?: <<Bytes>>
@ -54,13 +56,21 @@ interface CatIndicesRequest extends CatCatRequestBase {
pri?: boolean
time?: <<TimeUnit>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatIndicesResponse`
==== CatIndicesResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatIndicesResponse = CatIndicesIndicesRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-master.asciidoc
View File

@ -41,19 +41,29 @@ Returns information about the master node, including the ID, bound IP address, a
----
[discrete]
===== `CatMasterRequest`
==== CatMasterRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatMasterRequest extends CatCatRequestBase {
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatMasterResponse`
==== CatMasterResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatMasterResponse = CatMasterMasterRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-ml_data_frame_analytics.asciidoc
View File

@ -41,10 +41,12 @@ Get data frame analytics jobs. Returns configuration and usage information about
----
[discrete]
===== `CatMlDataFrameAnalyticsRequest`
==== CatMlDataFrameAnalyticsRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatMlDataFrameAnalyticsRequest extends CatCatRequestBase {
id?: <<Id>>
allow_no_match?: boolean
@ -53,13 +55,21 @@ interface CatMlDataFrameAnalyticsRequest extends CatCatRequestBase {
s?: CatCatDfaColumns
time?: <<Duration>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatMlDataFrameAnalyticsResponse`
==== CatMlDataFrameAnalyticsResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatMlDataFrameAnalyticsResponse = CatMlDataFrameAnalyticsDataFrameAnalyticsRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-ml_datafeeds.asciidoc
View File

@ -41,10 +41,12 @@ Get datafeeds. Returns configuration and usage information about datafeeds. This
----
[discrete]
===== `CatMlDatafeedsRequest`
==== CatMlDatafeedsRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatMlDatafeedsRequest extends CatCatRequestBase {
datafeed_id?: <<Id>>
allow_no_match?: boolean
@ -52,13 +54,21 @@ interface CatMlDatafeedsRequest extends CatCatRequestBase {
s?: CatCatDatafeedColumns
time?: <<TimeUnit>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatMlDatafeedsResponse`
==== CatMlDatafeedsResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatMlDatafeedsResponse = CatMlDatafeedsDatafeedsRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-ml_jobs.asciidoc
View File

@ -41,10 +41,12 @@ Get anomaly detection jobs. Returns configuration and usage information for anom
----
[discrete]
===== `CatMlJobsRequest`
==== CatMlJobsRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatMlJobsRequest extends CatCatRequestBase {
job_id?: <<Id>>
allow_no_match?: boolean
@ -53,13 +55,21 @@ interface CatMlJobsRequest extends CatCatRequestBase {
s?: CatCatAnonalyDetectorColumns
time?: <<TimeUnit>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatMlJobsResponse`
==== CatMlJobsResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatMlJobsResponse = CatMlJobsJobsRecord[]
----
[pass]
++++
</pre>
++++

30
docs/reference-cat-ml_trained_models.asciidoc
View File

@ -41,26 +41,36 @@ Get trained models. Returns configuration and usage information about inference
----
[discrete]
===== `CatMlTrainedModelsRequest`
==== CatMlTrainedModelsRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatMlTrainedModelsRequest extends CatCatRequestBase {
model_id?: <<Id>>
allow_no_match?: boolean
bytes?: <<Bytes>>
h?: CatCatTrainedModelsColumns
s?: CatCatTrainedModelsColumns
from?: <<integer>>
size?: <<integer>>
from?: number
size?: number
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatMlTrainedModelsResponse`
==== CatMlTrainedModelsResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatMlTrainedModelsResponse = CatMlTrainedModelsTrainedModelsRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-nodeattrs.asciidoc
View File

@ -41,19 +41,29 @@ Returns information about custom node attributes. IMPORTANT: cat APIs are only i
----
[discrete]
===== `CatNodeattrsRequest`
==== CatNodeattrsRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatNodeattrsRequest extends CatCatRequestBase {
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatNodeattrsResponse`
==== CatNodeattrsResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatNodeattrsResponse = CatNodeattrsNodeAttributesRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-nodes.asciidoc
View File

@ -41,22 +41,32 @@ Returns information about the nodes in a cluster. IMPORTANT: cat APIs are only i
----
[discrete]
===== `CatNodesRequest`
==== CatNodesRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatNodesRequest extends CatCatRequestBase {
bytes?: <<Bytes>>
full_id?: boolean | string
include_unloaded_segments?: boolean
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatNodesResponse`
==== CatNodesResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatNodesResponse = CatNodesNodesRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-pending_tasks.asciidoc
View File

@ -41,19 +41,29 @@ Returns cluster-level changes that have not yet been executed. IMPORTANT: cat AP
----
[discrete]
===== `CatPendingTasksRequest`
==== CatPendingTasksRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatPendingTasksRequest extends CatCatRequestBase {
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatPendingTasksResponse`
==== CatPendingTasksResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatPendingTasksResponse = CatPendingTasksPendingTasksRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-plugins.asciidoc
View File

@ -41,19 +41,29 @@ Returns a list of plugins running on each node of a cluster. IMPORTANT: cat APIs
----
[discrete]
===== `CatPluginsRequest`
==== CatPluginsRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatPluginsRequest extends CatCatRequestBase {
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatPluginsResponse`
==== CatPluginsResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatPluginsResponse = CatPluginsPluginsRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-recovery.asciidoc
View File

@ -41,23 +41,33 @@ Returns information about ongoing and completed shard recoveries. Shard recovery
----
[discrete]
===== `CatRecoveryRequest`
==== CatRecoveryRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatRecoveryRequest extends CatCatRequestBase {
index?: <<Indices>>
active_only?: boolean
bytes?: <<Bytes>>
detailed?: boolean
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatRecoveryResponse`
==== CatRecoveryResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatRecoveryResponse = CatRecoveryRecoveryRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-repositories.asciidoc
View File

@ -41,19 +41,29 @@ Returns the snapshot repositories for a cluster. IMPORTANT: cat APIs are only in
----
[discrete]
===== `CatRepositoriesRequest`
==== CatRepositoriesRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatRepositoriesRequest extends CatCatRequestBase {
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatRepositoriesResponse`
==== CatRepositoriesResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatRepositoriesResponse = CatRepositoriesRepositoriesRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-segments.asciidoc
View File

@ -41,21 +41,31 @@ Returns low-level information about the Lucene segments in index shards. For dat
----
[discrete]
===== `CatSegmentsRequest`
==== CatSegmentsRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatSegmentsRequest extends CatCatRequestBase {
index?: <<Indices>>
bytes?: <<Bytes>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatSegmentsResponse`
==== CatSegmentsResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatSegmentsResponse = CatSegmentsSegmentsRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-shards.asciidoc
View File

@ -41,21 +41,31 @@ Returns information about the shards in a cluster. For data streams, the API ret
----
[discrete]
===== `CatShardsRequest`
==== CatShardsRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatShardsRequest extends CatCatRequestBase {
index?: <<Indices>>
bytes?: <<Bytes>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatShardsResponse`
==== CatShardsResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatShardsResponse = CatShardsShardsRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-snapshots.asciidoc
View File

@ -41,21 +41,31 @@ Returns information about the snapshots stored in one or more repositories. A sn
----
[discrete]
===== `CatSnapshotsRequest`
==== CatSnapshotsRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatSnapshotsRequest extends CatCatRequestBase {
repository?: <<Names>>
ignore_unavailable?: boolean
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatSnapshotsResponse`
==== CatSnapshotsResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatSnapshotsResponse = CatSnapshotsSnapshotsRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-tasks.asciidoc
View File

@ -41,23 +41,33 @@ Returns information about tasks currently executing in the cluster. IMPORTANT: c
----
[discrete]
===== `CatTasksRequest`
==== CatTasksRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatTasksRequest extends CatCatRequestBase {
actions?: string[]
detailed?: boolean
node_id?: string[]
parent_task_id?: string
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatTasksResponse`
==== CatTasksResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatTasksResponse = CatTasksTasksRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-templates.asciidoc
View File

@ -41,20 +41,30 @@ Returns information about index templates in a cluster. You can use index templa
----
[discrete]
===== `CatTemplatesRequest`
==== CatTemplatesRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatTemplatesRequest extends CatCatRequestBase {
name?: <<Name>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatTemplatesResponse`
==== CatTemplatesResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatTemplatesResponse = CatTemplatesTemplatesRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-cat-thread_pool.asciidoc
View File

@ -41,21 +41,31 @@ Returns thread pool statistics for each node in a cluster. Returned information
----
[discrete]
===== `CatThreadPoolRequest`
==== CatThreadPoolRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatThreadPoolRequest extends CatCatRequestBase {
thread_pool_patterns?: <<Names>>
time?: <<TimeUnit>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatThreadPoolResponse`
==== CatThreadPoolResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatThreadPoolResponse = CatThreadPoolThreadPoolRecord[]
----
[pass]
++++
</pre>
++++

30
docs/reference-cat-transforms.asciidoc
View File

@ -41,26 +41,36 @@ Get transforms. Returns configuration and usage information about transforms. CA
----
[discrete]
===== `CatTransformsRequest`
==== CatTransformsRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CatTransformsRequest extends CatCatRequestBase {
transform_id?: <<Id>>
allow_no_match?: boolean
from?: <<integer>>
from?: number
h?: CatCatTransformColumns
s?: CatCatTransformColumns
time?: <<TimeUnit>>
size?: <<integer>>
size?: number
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CatTransformsResponse`
==== CatTransformsResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CatTransformsResponse = CatTransformsTransformsRecord[]
----
[pass]
++++
</pre>
++++

26
docs/reference-ccr-delete_auto_follow_pattern.asciidoc
View File

@ -41,20 +41,30 @@ Deletes auto-follow patterns.
----
[discrete]
===== `CcrDeleteAutoFollowPatternRequest`
==== CcrDeleteAutoFollowPatternRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CcrDeleteAutoFollowPatternRequest extends <<RequestBase>> {
name: <<Name>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CcrDeleteAutoFollowPatternResponse`
==== CcrDeleteAutoFollowPatternResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CcrDeleteAutoFollowPatternResponse = <<AcknowledgedResponseBase>>
----
[pass]
++++
</pre>
++++

36
docs/reference-ccr-follow.asciidoc
View File

@ -41,37 +41,47 @@ Creates a new follower index configured to follow the referenced leader index.
----
[discrete]
===== `CcrFollowRequest`
==== CcrFollowRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CcrFollowRequest extends <<RequestBase>> {
index: <<IndexName>>
wait_for_active_shards?: <<WaitForActiveShards>>
leader_index?: <<IndexName>>
max_outstanding_read_requests?: <<long>>
max_outstanding_write_requests?: <<long>>
max_read_request_operation_count?: <<long>>
max_outstanding_read_requests?: number
max_outstanding_write_requests?: number
max_read_request_operation_count?: number
max_read_request_size?: string
max_retry_delay?: <<Duration>>
max_write_buffer_count?: <<long>>
max_write_buffer_count?: number
max_write_buffer_size?: string
max_write_request_operation_count?: <<long>>
max_write_request_operation_count?: number
max_write_request_size?: string
read_poll_timeout?: <<Duration>>
remote_cluster?: string
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CcrFollowResponse`
==== CcrFollowResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface CcrFollowResponse {
follow_index_created: boolean
follow_index_shards_acked: boolean
index_following_started: boolean
}
----
[pass]
++++
</pre>
++++

26
docs/reference-ccr-follow_info.asciidoc
View File

@ -41,22 +41,32 @@ Retrieves information about all follower indices, including parameters and statu
----
[discrete]
===== `CcrFollowInfoRequest`
==== CcrFollowInfoRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CcrFollowInfoRequest extends <<RequestBase>> {
index: <<Indices>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CcrFollowInfoResponse`
==== CcrFollowInfoResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface CcrFollowInfoResponse {
follower_indices: CcrFollowInfoFollowerIndex[]
}
----
[pass]
++++
</pre>
++++

26
docs/reference-ccr-follow_stats.asciidoc
View File

@ -41,22 +41,32 @@ Retrieves follower stats. return shard-level stats about the following tasks ass
----
[discrete]
===== `CcrFollowStatsRequest`
==== CcrFollowStatsRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CcrFollowStatsRequest extends <<RequestBase>> {
index: <<Indices>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CcrFollowStatsResponse`
==== CcrFollowStatsResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface CcrFollowStatsResponse {
indices: CcrFollowIndexStats[]
}
----
[pass]
++++
</pre>
++++

26
docs/reference-ccr-forget_follower.asciidoc
View File

@ -41,10 +41,12 @@ Removes the follower retention leases from the leader.
----
[discrete]
===== `CcrForgetFollowerRequest`
==== CcrForgetFollowerRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CcrForgetFollowerRequest extends <<RequestBase>> {
index: <<IndexName>>
follower_cluster?: string
@ -52,15 +54,23 @@ interface CcrForgetFollowerRequest extends <<RequestBase>> {
follower_index_uuid?: <<Uuid>>
leader_remote_cluster?: string
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CcrForgetFollowerResponse`
==== CcrForgetFollowerResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface CcrForgetFollowerResponse {
_shards: <<ShardStatistics>>
}
----
[pass]
++++
</pre>
++++

26
docs/reference-ccr-get_auto_follow_pattern.asciidoc
View File

@ -41,22 +41,32 @@ Gets configured auto-follow patterns. Returns the specified auto-follow pattern
----
[discrete]
===== `CcrGetAutoFollowPatternRequest`
==== CcrGetAutoFollowPatternRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CcrGetAutoFollowPatternRequest extends <<RequestBase>> {
name?: <<Name>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CcrGetAutoFollowPatternResponse`
==== CcrGetAutoFollowPatternResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface CcrGetAutoFollowPatternResponse {
patterns: CcrGetAutoFollowPatternAutoFollowPattern[]
}
----
[pass]
++++
</pre>
++++

26
docs/reference-ccr-pause_auto_follow_pattern.asciidoc
View File

@ -41,20 +41,30 @@ Pauses an auto-follow pattern
----
[discrete]
===== `CcrPauseAutoFollowPatternRequest`
==== CcrPauseAutoFollowPatternRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CcrPauseAutoFollowPatternRequest extends <<RequestBase>> {
name: <<Name>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CcrPauseAutoFollowPatternResponse`
==== CcrPauseAutoFollowPatternResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CcrPauseAutoFollowPatternResponse = <<AcknowledgedResponseBase>>
----
[pass]
++++
</pre>
++++

26
docs/reference-ccr-pause_follow.asciidoc
View File

@ -41,20 +41,30 @@ Pauses a follower index. The follower index will not fetch any additional operat
----
[discrete]
===== `CcrPauseFollowRequest`
==== CcrPauseFollowRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CcrPauseFollowRequest extends <<RequestBase>> {
index: <<IndexName>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CcrPauseFollowResponse`
==== CcrPauseFollowResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CcrPauseFollowResponse = <<AcknowledgedResponseBase>>
----
[pass]
++++
</pre>
++++

36
docs/reference-ccr-put_auto_follow_pattern.asciidoc
View File

@ -41,35 +41,45 @@ Creates a new named collection of auto-follow patterns against a specified remot
----
[discrete]
===== `CcrPutAutoFollowPatternRequest`
==== CcrPutAutoFollowPatternRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CcrPutAutoFollowPatternRequest extends <<RequestBase>> {
name: <<Name>>
remote_cluster: string
follow_index_pattern?: <<IndexPattern>>
leader_index_patterns?: <<IndexPatterns>>
leader_index_exclusion_patterns?: <<IndexPatterns>>
max_outstanding_read_requests?: <<integer>>
max_outstanding_read_requests?: number
settings?: Record<string, any>
max_outstanding_write_requests?: <<integer>>
max_outstanding_write_requests?: number
read_poll_timeout?: <<Duration>>
max_read_request_operation_count?: <<integer>>
max_read_request_operation_count?: number
max_read_request_size?: <<ByteSize>>
max_retry_delay?: <<Duration>>
max_write_buffer_count?: <<integer>>
max_write_buffer_count?: number
max_write_buffer_size?: <<ByteSize>>
max_write_request_operation_count?: <<integer>>
max_write_request_operation_count?: number
max_write_request_size?: <<ByteSize>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CcrPutAutoFollowPatternResponse`
==== CcrPutAutoFollowPatternResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CcrPutAutoFollowPatternResponse = <<AcknowledgedResponseBase>>
----
[pass]
++++
</pre>
++++

26
docs/reference-ccr-resume_auto_follow_pattern.asciidoc
View File

@ -41,20 +41,30 @@ Resumes an auto-follow pattern that has been paused
----
[discrete]
===== `CcrResumeAutoFollowPatternRequest`
==== CcrResumeAutoFollowPatternRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CcrResumeAutoFollowPatternRequest extends <<RequestBase>> {
name: <<Name>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CcrResumeAutoFollowPatternResponse`
==== CcrResumeAutoFollowPatternResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CcrResumeAutoFollowPatternResponse = <<AcknowledgedResponseBase>>
----
[pass]
++++
</pre>
++++

36
docs/reference-ccr-resume_follow.asciidoc
View File

@ -41,30 +41,40 @@ Resumes a follower index that has been paused
----
[discrete]
===== `CcrResumeFollowRequest`
==== CcrResumeFollowRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CcrResumeFollowRequest extends <<RequestBase>> {
index: <<IndexName>>
max_outstanding_read_requests?: <<long>>
max_outstanding_write_requests?: <<long>>
max_read_request_operation_count?: <<long>>
max_outstanding_read_requests?: number
max_outstanding_write_requests?: number
max_read_request_operation_count?: number
max_read_request_size?: string
max_retry_delay?: <<Duration>>
max_write_buffer_count?: <<long>>
max_write_buffer_count?: number
max_write_buffer_size?: string
max_write_request_operation_count?: <<long>>
max_write_request_operation_count?: number
max_write_request_size?: string
read_poll_timeout?: <<Duration>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CcrResumeFollowResponse`
==== CcrResumeFollowResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CcrResumeFollowResponse = <<AcknowledgedResponseBase>>
----
[pass]
++++
</pre>
++++

26
docs/reference-ccr-stats.asciidoc
View File

@ -41,22 +41,32 @@ Gets all stats related to cross-cluster replication.
----
[discrete]
===== `CcrStatsRequest`
==== CcrStatsRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CcrStatsRequest extends <<RequestBase>> {
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CcrStatsResponse`
==== CcrStatsResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface CcrStatsResponse {
auto_follow_stats: CcrStatsAutoFollowStats
follow_stats: CcrStatsFollowStats
}
----
[pass]
++++
</pre>
++++

26
docs/reference-ccr-unfollow.asciidoc
View File

@ -41,20 +41,30 @@ Stops the following task associated with a follower index and removes index meta
----
[discrete]
===== `CcrUnfollowRequest`
==== CcrUnfollowRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CcrUnfollowRequest extends <<RequestBase>> {
index: <<IndexName>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CcrUnfollowResponse`
==== CcrUnfollowResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CcrUnfollowResponse = <<AcknowledgedResponseBase>>
----
[pass]
++++
</pre>
++++

28
docs/reference-clear_scroll.asciidoc
View File

@ -41,23 +41,33 @@ Clear a scrolling search. Clear the search context and results for a scrolling s
----
[discrete]
===== `ClearScrollRequest`
==== ClearScrollRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClearScrollRequest extends <<RequestBase>> {
scroll_id?: <<ScrollIds>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ClearScrollResponse`
==== ClearScrollResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClearScrollResponse {
succeeded: boolean
num_freed: <<integer>>
num_freed: number
}
----
[pass]
++++
</pre>
++++

28
docs/reference-close_point_in_time.asciidoc
View File

@ -41,23 +41,33 @@ Close a point in time. A point in time must be opened explicitly before being us
----
[discrete]
===== `ClosePointInTimeRequest`
==== ClosePointInTimeRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClosePointInTimeRequest extends <<RequestBase>> {
id: <<Id>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ClosePointInTimeResponse`
==== ClosePointInTimeResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClosePointInTimeResponse {
succeeded: boolean
num_freed: <<integer>>
num_freed: number
}
----
[pass]
++++
</pre>
++++

30
docs/reference-cluster-allocation_explain.asciidoc
View File

@ -41,25 +41,32 @@ Provides explanations for shard allocations in the cluster.
----
[discrete]
===== `ClusterAllocationExplainRequest`
==== ClusterAllocationExplainRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterAllocationExplainRequest extends <<RequestBase>> {
include_disk_info?: boolean
include_yes_decisions?: boolean
current_node?: string
index?: <<IndexName>>
primary?: boolean
shard?: <<integer>>
shard?: number
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ClusterAllocationExplainResponse`
==== ClusterAllocationExplainResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterAllocationExplainResponse {
allocate_explanation?: string
allocation_delay?: <<Duration>>
@ -83,9 +90,12 @@ interface ClusterAllocationExplainResponse {
rebalance_explanation?: string
remaining_delay?: <<Duration>>
remaining_delay_in_millis?: <<DurationValue>><<<UnitMillis>>>
shard: <<integer>>
shard: number
unassigned_info?: ClusterAllocationExplainUnassignedInformation
note?: string
}
----
[pass]
++++
</pre>
++++

26
docs/reference-cluster-delete_component_template.asciidoc
View File

@ -41,22 +41,32 @@ Delete component templates. Deletes component templates. Component templates are
----
[discrete]
===== `ClusterDeleteComponentTemplateRequest`
==== ClusterDeleteComponentTemplateRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterDeleteComponentTemplateRequest extends <<RequestBase>> {
name: <<Names>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ClusterDeleteComponentTemplateResponse`
==== ClusterDeleteComponentTemplateResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type ClusterDeleteComponentTemplateResponse = <<AcknowledgedResponseBase>>
----
[pass]
++++
</pre>
++++

26
docs/reference-cluster-delete_voting_config_exclusions.asciidoc
View File

@ -41,20 +41,30 @@ Clears cluster voting config exclusions.
----
[discrete]
===== `ClusterDeleteVotingConfigExclusionsRequest`
==== ClusterDeleteVotingConfigExclusionsRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterDeleteVotingConfigExclusionsRequest extends <<RequestBase>> {
wait_for_removal?: boolean
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ClusterDeleteVotingConfigExclusionsResponse`
==== ClusterDeleteVotingConfigExclusionsResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type ClusterDeleteVotingConfigExclusionsResponse = boolean
----
[pass]
++++
</pre>
++++

26
docs/reference-cluster-exists_component_template.asciidoc
View File

@ -41,22 +41,32 @@ Check component templates. Returns information about whether a particular compon
----
[discrete]
===== `ClusterExistsComponentTemplateRequest`
==== ClusterExistsComponentTemplateRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterExistsComponentTemplateRequest extends <<RequestBase>> {
name: <<Names>>
master_timeout?: <<Duration>>
local?: boolean
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ClusterExistsComponentTemplateResponse`
==== ClusterExistsComponentTemplateResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type ClusterExistsComponentTemplateResponse = boolean
----
[pass]
++++
</pre>
++++

26
docs/reference-cluster-get_component_template.asciidoc
View File

@ -41,10 +41,12 @@ Get component templates. Retrieves information about component templates.
----
[discrete]
===== `ClusterGetComponentTemplateRequest`
==== ClusterGetComponentTemplateRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterGetComponentTemplateRequest extends <<RequestBase>> {
name?: <<Name>>
flat_settings?: boolean
@ -52,15 +54,23 @@ interface ClusterGetComponentTemplateRequest extends <<RequestBase>> {
local?: boolean
master_timeout?: <<Duration>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ClusterGetComponentTemplateResponse`
==== ClusterGetComponentTemplateResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterGetComponentTemplateResponse {
component_templates: ClusterComponentTemplate[]
}
----
[pass]
++++
</pre>
++++

26
docs/reference-cluster-get_settings.asciidoc
View File

@ -41,27 +41,37 @@ Returns cluster-wide settings. By default, it returns only settings that have be
----
[discrete]
===== `ClusterGetSettingsRequest`
==== ClusterGetSettingsRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterGetSettingsRequest extends <<RequestBase>> {
flat_settings?: boolean
include_defaults?: boolean
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ClusterGetSettingsResponse`
==== ClusterGetSettingsResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterGetSettingsResponse {
persistent: Record<string, any>
transient: Record<string, any>
defaults?: Record<string, any>
}
----
[pass]
++++
</pre>
++++

28
docs/reference-cluster-health.asciidoc
View File

@ -41,10 +41,12 @@ The cluster health API returns a simple status on the health of the cluster. You
----
[discrete]
===== `ClusterHealthRequest`
==== ClusterHealthRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterHealthRequest extends <<RequestBase>> {
index?: <<Indices>>
expand_wildcards?: <<ExpandWildcards>>
@ -54,18 +56,26 @@ interface ClusterHealthRequest extends <<RequestBase>> {
timeout?: <<Duration>>
wait_for_active_shards?: <<WaitForActiveShards>>
wait_for_events?: <<WaitForEvents>>
wait_for_nodes?: string | <<integer>>
wait_for_nodes?: string | number
wait_for_no_initializing_shards?: boolean
wait_for_no_relocating_shards?: boolean
wait_for_status?: <<HealthStatus>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ClusterHealthResponse`
==== ClusterHealthResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type ClusterHealthResponse = ClusterHealthHealthResponseBody
----
[pass]
++++
</pre>
++++

26
docs/reference-cluster-info.asciidoc
View File

@ -41,20 +41,27 @@ Get cluster info. Returns basic information about the cluster.
----
[discrete]
===== `ClusterInfoRequest`
==== ClusterInfoRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterInfoRequest extends <<RequestBase>> {
target: <<ClusterInfoTargets>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ClusterInfoResponse`
==== ClusterInfoResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterInfoResponse {
cluster_name: <<Name>>
http?: NodesHttp
@ -62,5 +69,8 @@ interface ClusterInfoResponse {
thread_pool?: Record<string, NodesThreadCount>
script?: NodesScripting
}
----
[pass]
++++
</pre>
++++

26
docs/reference-cluster-pending_tasks.asciidoc
View File

@ -41,23 +41,33 @@ Returns cluster-level changes (such as create index, update mapping, allocate or
----
[discrete]
===== `ClusterPendingTasksRequest`
==== ClusterPendingTasksRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterPendingTasksRequest extends <<RequestBase>> {
local?: boolean
master_timeout?: <<Duration>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ClusterPendingTasksResponse`
==== ClusterPendingTasksResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterPendingTasksResponse {
tasks: ClusterPendingTasksPendingTask[]
}
----
[pass]
++++
</pre>
++++

26
docs/reference-cluster-post_voting_config_exclusions.asciidoc
View File

@ -41,22 +41,32 @@ Updates the cluster voting config exclusions by node ids or node names.
----
[discrete]
===== `ClusterPostVotingConfigExclusionsRequest`
==== ClusterPostVotingConfigExclusionsRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterPostVotingConfigExclusionsRequest extends <<RequestBase>> {
node_names?: <<Names>>
node_ids?: <<Ids>>
timeout?: <<Duration>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ClusterPostVotingConfigExclusionsResponse`
==== ClusterPostVotingConfigExclusionsResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type ClusterPostVotingConfigExclusionsResponse = boolean
----
[pass]
++++
</pre>
++++

26
docs/reference-cluster-put_component_template.asciidoc
View File

@ -41,10 +41,12 @@ Create or update a component template. Creates or updates a component template.
----
[discrete]
===== `ClusterPutComponentTemplateRequest`
==== ClusterPutComponentTemplateRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterPutComponentTemplateRequest extends <<RequestBase>> {
name: <<Name>>
create?: boolean
@ -54,13 +56,21 @@ interface ClusterPutComponentTemplateRequest extends <<RequestBase>> {
_meta?: <<Metadata>>
deprecated?: boolean
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ClusterPutComponentTemplateResponse`
==== ClusterPutComponentTemplateResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type ClusterPutComponentTemplateResponse = <<AcknowledgedResponseBase>>
----
[pass]
++++
</pre>
++++

26
docs/reference-cluster-put_settings.asciidoc
View File

@ -41,10 +41,12 @@ Updates the cluster settings.
----
[discrete]
===== `ClusterPutSettingsRequest`
==== ClusterPutSettingsRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterPutSettingsRequest extends <<RequestBase>> {
flat_settings?: boolean
master_timeout?: <<Duration>>
@ -52,17 +54,25 @@ interface ClusterPutSettingsRequest extends <<RequestBase>> {
persistent?: Record<string, any>
transient?: Record<string, any>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ClusterPutSettingsResponse`
==== ClusterPutSettingsResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterPutSettingsResponse {
acknowledged: boolean
persistent: Record<string, any>
transient: Record<string, any>
}
----
[pass]
++++
</pre>
++++

26
docs/reference-cluster-remote_info.asciidoc
View File

@ -41,19 +41,29 @@ The cluster remote info API allows you to retrieve all of the configured remote
----
[discrete]
===== `ClusterRemoteInfoRequest`
==== ClusterRemoteInfoRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterRemoteInfoRequest extends <<RequestBase>> {
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ClusterRemoteInfoResponse`
==== ClusterRemoteInfoResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type ClusterRemoteInfoResponse = Record<string, ClusterRemoteInfoClusterRemoteInfo>
----
[pass]
++++
</pre>
++++

26
docs/reference-cluster-reroute.asciidoc
View File

@ -41,10 +41,12 @@ Allows to manually change the allocation of individual shards in the cluster.
----
[discrete]
===== `ClusterRerouteRequest`
==== ClusterRerouteRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterRerouteRequest extends <<RequestBase>> {
dry_run?: boolean
explain?: boolean
@ -54,17 +56,25 @@ interface ClusterRerouteRequest extends <<RequestBase>> {
timeout?: <<Duration>>
commands?: ClusterRerouteCommand[]
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ClusterRerouteResponse`
==== ClusterRerouteResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterRerouteResponse {
acknowledged: boolean
explanations?: ClusterRerouteRerouteExplanation[]
state?: any
}
----
[pass]
++++
</pre>
++++

26
docs/reference-cluster-state.asciidoc
View File

@ -41,10 +41,12 @@ Returns a comprehensive information about the state of the cluster.
----
[discrete]
===== `ClusterStateRequest`
==== ClusterStateRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterStateRequest extends <<RequestBase>> {
metric?: <<Metrics>>
index?: <<Indices>>
@ -57,13 +59,21 @@ interface ClusterStateRequest extends <<RequestBase>> {
wait_for_metadata_version?: <<VersionNumber>>
wait_for_timeout?: <<Duration>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ClusterStateResponse`
==== ClusterStateResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type ClusterStateResponse = any
----
[pass]
++++
</pre>
++++

26
docs/reference-cluster-stats.asciidoc
View File

@ -41,22 +41,32 @@ Returns cluster statistics. It returns basic index metrics (shard numbers, store
----
[discrete]
===== `ClusterStatsRequest`
==== ClusterStatsRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ClusterStatsRequest extends <<RequestBase>> {
node_id?: <<NodeIds>>
include_remotes?: boolean
timeout?: <<Duration>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ClusterStatsResponse`
==== ClusterStatsResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type ClusterStatsResponse = ClusterStatsStatsResponseBase
----
[pass]
++++
</pre>
++++

26
docs/reference-connector-check_in.asciidoc
View File

@ -41,22 +41,32 @@ Check in a connector. Update the `last_seen` field in the connector and set it t
----
[discrete]
===== `ConnectorCheckInRequest`
==== ConnectorCheckInRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorCheckInRequest extends <<RequestBase>> {
connector_id: <<Id>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorCheckInResponse`
==== ConnectorCheckInResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorCheckInResponse {
result: <<Result>>
}
----
[pass]
++++
</pre>
++++

26
docs/reference-connector-delete.asciidoc
View File

@ -41,21 +41,31 @@ Delete a connector. Removes a connector and associated sync jobs. This is a dest
----
[discrete]
===== `ConnectorDeleteRequest`
==== ConnectorDeleteRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorDeleteRequest extends <<RequestBase>> {
connector_id: <<Id>>
delete_sync_jobs?: boolean
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorDeleteResponse`
==== ConnectorDeleteResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type ConnectorDeleteResponse = <<AcknowledgedResponseBase>>
----
[pass]
++++
</pre>
++++

26
docs/reference-connector-get.asciidoc
View File

@ -41,20 +41,30 @@ Get a connector. Get the details about a connector.
----
[discrete]
===== `ConnectorGetRequest`
==== ConnectorGetRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorGetRequest extends <<RequestBase>> {
connector_id: <<Id>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorGetResponse`
==== ConnectorGetResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type ConnectorGetResponse = ConnectorConnector
----
[pass]
++++
</pre>
++++

32
docs/reference-connector-list.asciidoc
View File

@ -41,28 +41,38 @@ Get all connectors. Get information about all connectors.
----
[discrete]
===== `ConnectorListRequest`
==== ConnectorListRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorListRequest extends <<RequestBase>> {
from?: <<integer>>
size?: <<integer>>
from?: number
size?: number
index_name?: <<Indices>>
connector_name?: <<Names>>
service_type?: <<Names>>
query?: string
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorListResponse`
==== ConnectorListResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorListResponse {
count: <<long>>
count: number
results: ConnectorConnector[]
}
----
[pass]
++++
</pre>
++++

26
docs/reference-connector-post.asciidoc
View File

@ -41,10 +41,12 @@ Create a connector. Connectors are Elasticsearch integrations that bring content
----
[discrete]
===== `ConnectorPostRequest`
==== ConnectorPostRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorPostRequest extends <<RequestBase>> {
description?: string
index_name?: <<IndexName>>
@ -53,16 +55,24 @@ interface ConnectorPostRequest extends <<RequestBase>> {
name?: string
service_type?: string
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorPostResponse`
==== ConnectorPostResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorPostResponse {
result: <<Result>>
id: <<Id>>
}
----
[pass]
++++
</pre>
++++

26
docs/reference-connector-put.asciidoc
View File

@ -41,10 +41,12 @@ Create or update a connector.
----
[discrete]
===== `ConnectorPutRequest`
==== ConnectorPutRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorPutRequest extends <<RequestBase>> {
connector_id?: <<Id>>
description?: string
@ -54,16 +56,24 @@ interface ConnectorPutRequest extends <<RequestBase>> {
name?: string
service_type?: string
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorPutResponse`
==== ConnectorPutResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorPutResponse {
result: <<Result>>
id: <<Id>>
}
----
[pass]
++++
</pre>
++++

26
docs/reference-connector-sync_job_cancel.asciidoc
View File

@ -41,22 +41,32 @@ Cancel a connector sync job. Cancel a connector sync job, which sets the status
----
[discrete]
===== `ConnectorSyncJobCancelRequest`
==== ConnectorSyncJobCancelRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorSyncJobCancelRequest extends <<RequestBase>> {
connector_sync_job_id: <<Id>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorSyncJobCancelResponse`
==== ConnectorSyncJobCancelResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorSyncJobCancelResponse {
result: <<Result>>
}
----
[pass]
++++
</pre>
++++

17
docs/reference-connector-sync_job_check_in.asciidoc
View File

@ -40,20 +40,3 @@ Checks in a connector sync job (refreshes 'last_seen').
(ConnectorSyncJobCheckInRequest, options?): Promise<ConnectorSyncJobCheckInResponse>
----
[discrete]
===== `ConnectorSyncJobCheckInRequest`
[source,ts]
----
{
}
----
[discrete]
===== `ConnectorSyncJobCheckInResponse`
[source,ts]
----
n/a
----

17
docs/reference-connector-sync_job_claim.asciidoc
View File

@ -38,20 +38,3 @@ Claims a connector sync job.
(ConnectorSyncJobClaimRequest, options?): Promise<ConnectorSyncJobClaimResponse>
----
[discrete]
===== `ConnectorSyncJobClaimRequest`
[source,ts]
----
{
}
----
[discrete]
===== `ConnectorSyncJobClaimResponse`
[source,ts]
----
n/a
----

26
docs/reference-connector-sync_job_delete.asciidoc
View File

@ -41,20 +41,30 @@ Delete a connector sync job. Remove a connector sync job and its associated data
----
[discrete]
===== `ConnectorSyncJobDeleteRequest`
==== ConnectorSyncJobDeleteRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorSyncJobDeleteRequest extends <<RequestBase>> {
connector_sync_job_id: <<Id>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorSyncJobDeleteResponse`
==== ConnectorSyncJobDeleteResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type ConnectorSyncJobDeleteResponse = <<AcknowledgedResponseBase>>
----
[pass]
++++
</pre>
++++

17
docs/reference-connector-sync_job_error.asciidoc
View File

@ -40,20 +40,3 @@ Sets an error for a connector sync job.
(ConnectorSyncJobErrorRequest, options?): Promise<ConnectorSyncJobErrorResponse>
----
[discrete]
===== `ConnectorSyncJobErrorRequest`
[source,ts]
----
{
}
----
[discrete]
===== `ConnectorSyncJobErrorResponse`
[source,ts]
----
n/a
----

26
docs/reference-connector-sync_job_get.asciidoc
View File

@ -41,20 +41,30 @@ Get a connector sync job.
----
[discrete]
===== `ConnectorSyncJobGetRequest`
==== ConnectorSyncJobGetRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorSyncJobGetRequest extends <<RequestBase>> {
connector_sync_job_id: <<Id>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorSyncJobGetResponse`
==== ConnectorSyncJobGetResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type ConnectorSyncJobGetResponse = ConnectorConnectorSyncJob
----
[pass]
++++
</pre>
++++

32
docs/reference-connector-sync_job_list.asciidoc
View File

@ -41,27 +41,37 @@ Get all connector sync jobs. Get information about all stored connector sync job
----
[discrete]
===== `ConnectorSyncJobListRequest`
==== ConnectorSyncJobListRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorSyncJobListRequest extends <<RequestBase>> {
from?: <<integer>>
size?: <<integer>>
from?: number
size?: number
status?: ConnectorSyncStatus
connector_id?: <<Id>>
job_type?: ConnectorSyncJobType | ConnectorSyncJobType[]
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorSyncJobListResponse`
==== ConnectorSyncJobListResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorSyncJobListResponse {
count: <<long>>
count: number
results: ConnectorConnectorSyncJob[]
}
----
[pass]
++++
</pre>
++++

26
docs/reference-connector-sync_job_post.asciidoc
View File

@ -41,24 +41,34 @@ Create a connector sync job. Create a connector sync job document in the interna
----
[discrete]
===== `ConnectorSyncJobPostRequest`
==== ConnectorSyncJobPostRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorSyncJobPostRequest extends <<RequestBase>> {
id: <<Id>>
job_type?: ConnectorSyncJobType
trigger_method?: ConnectorSyncJobTriggerMethod
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorSyncJobPostResponse`
==== ConnectorSyncJobPostResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorSyncJobPostResponse {
id: <<Id>>
}
----
[pass]
++++
</pre>
++++

17
docs/reference-connector-sync_job_update_stats.asciidoc
View File

@ -40,20 +40,3 @@ Updates the stats fields in the connector sync job document.
(ConnectorSyncJobUpdateStatsRequest, options?): Promise<ConnectorSyncJobUpdateStatsResponse>
----
[discrete]
===== `ConnectorSyncJobUpdateStatsRequest`
[source,ts]
----
{
}
----
[discrete]
===== `ConnectorSyncJobUpdateStatsResponse`
[source,ts]
----
n/a
----

26
docs/reference-connector-update_active_filtering.asciidoc
View File

@ -41,22 +41,32 @@ Activate the connector draft filter. Activates the valid draft filtering for a c
----
[discrete]
===== `ConnectorUpdateActiveFilteringRequest`
==== ConnectorUpdateActiveFilteringRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateActiveFilteringRequest extends <<RequestBase>> {
connector_id: <<Id>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorUpdateActiveFilteringResponse`
==== ConnectorUpdateActiveFilteringResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateActiveFilteringResponse {
result: <<Result>>
}
----
[pass]
++++
</pre>
++++

26
docs/reference-connector-update_api_key_id.asciidoc
View File

@ -41,24 +41,34 @@ Update the connector API key ID. Update the `api_key_id` and `api_key_secret_id`
----
[discrete]
===== `ConnectorUpdateApiKeyIdRequest`
==== ConnectorUpdateApiKeyIdRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateApiKeyIdRequest extends <<RequestBase>> {
connector_id: <<Id>>
api_key_id?: string
api_key_secret_id?: string
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorUpdateApiKeyIdResponse`
==== ConnectorUpdateApiKeyIdResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateApiKeyIdResponse {
result: <<Result>>
}
----
[pass]
++++
</pre>
++++

26
docs/reference-connector-update_configuration.asciidoc
View File

@ -41,24 +41,34 @@ Update the connector configuration. Update the configuration field in the connec
----
[discrete]
===== `ConnectorUpdateConfigurationRequest`
==== ConnectorUpdateConfigurationRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateConfigurationRequest extends <<RequestBase>> {
connector_id: <<Id>>
configuration?: ConnectorConnectorConfiguration
values?: Record<string, any>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorUpdateConfigurationResponse`
==== ConnectorUpdateConfigurationResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateConfigurationResponse {
result: <<Result>>
}
----
[pass]
++++
</pre>
++++

28
docs/reference-connector-update_error.asciidoc
View File

@ -41,23 +41,33 @@ Update the connector error field. Set the error field for the connector. If the
----
[discrete]
===== `ConnectorUpdateErrorRequest`
==== ConnectorUpdateErrorRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateErrorRequest extends <<RequestBase>> {
connector_id: <<Id>>
error: SpecUtilsWithNullValue<string>
error: <<SpecUtilsWithNullValue>><string>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorUpdateErrorResponse`
==== ConnectorUpdateErrorResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateErrorResponse {
result: <<Result>>
}
----
[pass]
++++
</pre>
++++

17
docs/reference-connector-update_features.asciidoc
View File

@ -40,20 +40,3 @@ Updates the connector features in the connector document.
(ConnectorUpdateFeaturesRequest, options?): Promise<ConnectorUpdateFeaturesResponse>
----
[discrete]
===== `ConnectorUpdateFeaturesRequest`
[source,ts]
----
{
}
----
[discrete]
===== `ConnectorUpdateFeaturesResponse`
[source,ts]
----
n/a
----

26
docs/reference-connector-update_filtering.asciidoc
View File

@ -41,25 +41,35 @@ Update the connector filtering. Update the draft filtering configuration of a co
----
[discrete]
===== `ConnectorUpdateFilteringRequest`
==== ConnectorUpdateFilteringRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateFilteringRequest extends <<RequestBase>> {
connector_id: <<Id>>
filtering?: ConnectorFilteringConfig[]
rules?: ConnectorFilteringRule[]
advanced_snippet?: ConnectorFilteringAdvancedSnippet
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorUpdateFilteringResponse`
==== ConnectorUpdateFilteringResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateFilteringResponse {
result: <<Result>>
}
----
[pass]
++++
</pre>
++++

26
docs/reference-connector-update_filtering_validation.asciidoc
View File

@ -39,23 +39,33 @@ Update the connector draft filtering validation. Update the draft filtering vali
----
[discrete]
===== `ConnectorUpdateFilteringValidationRequest`
==== ConnectorUpdateFilteringValidationRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateFilteringValidationRequest extends <<RequestBase>> {
connector_id: <<Id>>
validation: ConnectorFilteringRulesValidation
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorUpdateFilteringValidationResponse`
==== ConnectorUpdateFilteringValidationResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateFilteringValidationResponse {
result: <<Result>>
}
----
[pass]
++++
</pre>
++++

28
docs/reference-connector-update_index_name.asciidoc
View File

@ -41,23 +41,33 @@ Update the connector index name. Update the `index_name` field of a connector, s
----
[discrete]
===== `ConnectorUpdateIndexNameRequest`
==== ConnectorUpdateIndexNameRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateIndexNameRequest extends <<RequestBase>> {
connector_id: <<Id>>
index_name: SpecUtilsWithNullValue<<<IndexName>>>
index_name: <<SpecUtilsWithNullValue>><<<IndexName>>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorUpdateIndexNameResponse`
==== ConnectorUpdateIndexNameResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateIndexNameResponse {
result: <<Result>>
}
----
[pass]
++++
</pre>
++++

26
docs/reference-connector-update_name.asciidoc
View File

@ -41,24 +41,34 @@ Update the connector name and description.
----
[discrete]
===== `ConnectorUpdateNameRequest`
==== ConnectorUpdateNameRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateNameRequest extends <<RequestBase>> {
connector_id: <<Id>>
name?: string
description?: string
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorUpdateNameResponse`
==== ConnectorUpdateNameResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateNameResponse {
result: <<Result>>
}
----
[pass]
++++
</pre>
++++

26
docs/reference-connector-update_native.asciidoc
View File

@ -39,23 +39,33 @@ Update the connector is_native flag.
----
[discrete]
===== `ConnectorUpdateNativeRequest`
==== ConnectorUpdateNativeRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateNativeRequest extends <<RequestBase>> {
connector_id: <<Id>>
is_native: boolean
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorUpdateNativeResponse`
==== ConnectorUpdateNativeResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateNativeResponse {
result: <<Result>>
}
----
[pass]
++++
</pre>
++++

26
docs/reference-connector-update_pipeline.asciidoc
View File

@ -41,23 +41,33 @@ Update the connector pipeline. When you create a new connector, the configuratio
----
[discrete]
===== `ConnectorUpdatePipelineRequest`
==== ConnectorUpdatePipelineRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdatePipelineRequest extends <<RequestBase>> {
connector_id: <<Id>>
pipeline: ConnectorIngestPipelineParams
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorUpdatePipelineResponse`
==== ConnectorUpdatePipelineResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdatePipelineResponse {
result: <<Result>>
}
----
[pass]
++++
</pre>
++++

26
docs/reference-connector-update_scheduling.asciidoc
View File

@ -41,23 +41,33 @@ Update the connector scheduling.
----
[discrete]
===== `ConnectorUpdateSchedulingRequest`
==== ConnectorUpdateSchedulingRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateSchedulingRequest extends <<RequestBase>> {
connector_id: <<Id>>
scheduling: ConnectorSchedulingConfiguration
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorUpdateSchedulingResponse`
==== ConnectorUpdateSchedulingResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateSchedulingResponse {
result: <<Result>>
}
----
[pass]
++++
</pre>
++++

26
docs/reference-connector-update_service_type.asciidoc
View File

@ -41,23 +41,33 @@ Update the connector service type.
----
[discrete]
===== `ConnectorUpdateServiceTypeRequest`
==== ConnectorUpdateServiceTypeRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateServiceTypeRequest extends <<RequestBase>> {
connector_id: <<Id>>
service_type: string
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorUpdateServiceTypeResponse`
==== ConnectorUpdateServiceTypeResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateServiceTypeResponse {
result: <<Result>>
}
----
[pass]
++++
</pre>
++++

26
docs/reference-connector-update_status.asciidoc
View File

@ -41,23 +41,33 @@ Update the connector status.
----
[discrete]
===== `ConnectorUpdateStatusRequest`
==== ConnectorUpdateStatusRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateStatusRequest extends <<RequestBase>> {
connector_id: <<Id>>
status: ConnectorConnectorStatus
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `ConnectorUpdateStatusResponse`
==== ConnectorUpdateStatusResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface ConnectorUpdateStatusResponse {
result: <<Result>>
}
----
[pass]
++++
</pre>
++++

32
docs/reference-count.asciidoc
View File

@ -41,10 +41,12 @@ Returns number of documents matching a query.
----
[discrete]
===== `CountRequest`
==== CountRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CountRequest extends <<RequestBase>> {
index?: <<Indices>>
allow_no_indices?: boolean
@ -56,23 +58,31 @@ interface CountRequest extends <<RequestBase>> {
ignore_throttled?: boolean
ignore_unavailable?: boolean
lenient?: boolean
min_score?: <<double>>
min_score?: number
preference?: string
routing?: <<Routing>>
terminate_after?: <<long>>
terminate_after?: number
q?: string
query?: QueryDslQueryContainer
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CountResponse`
==== CountResponse
[source,ts]
----
[pass]
++++
<pre>
++++
interface CountResponse {
count: <<long>>
count: number
_shards: <<ShardStatistics>>
}
----
[pass]
++++
</pre>
++++

26
docs/reference-create.asciidoc
View File

@ -41,10 +41,12 @@ Index a document. Adds a JSON document to the specified data stream or index and
----
[discrete]
===== `CreateRequest`
==== CreateRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface CreateRequest<TDocument = unknown> extends <<RequestBase>> {
id: <<Id>>
index: <<IndexName>>
@ -57,13 +59,21 @@ interface CreateRequest<TDocument = unknown> extends <<RequestBase>> {
wait_for_active_shards?: <<WaitForActiveShards>>
document?: TDocument
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `CreateResponse`
==== CreateResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type CreateResponse = <<WriteResponseBase>>
----
[pass]
++++
</pre>
++++

26
docs/reference-dangling_indices-delete_dangling_index.asciidoc
View File

@ -41,23 +41,33 @@ Delete a dangling index. If Elasticsearch encounters index data that is absent f
----
[discrete]
===== `DanglingIndicesDeleteDanglingIndexRequest`
==== DanglingIndicesDeleteDanglingIndexRequest
[source,ts]
----
[pass]
++++
<pre>
++++
interface DanglingIndicesDeleteDanglingIndexRequest extends <<RequestBase>> {
index_uuid: <<Uuid>>
accept_data_loss: boolean
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
[pass]
++++
</pre>
++++
[discrete]
===== `DanglingIndicesDeleteDanglingIndexResponse`
==== DanglingIndicesDeleteDanglingIndexResponse
[source,ts]
----
[pass]
++++
<pre>
++++
type DanglingIndicesDeleteDanglingIndexResponse = <<AcknowledgedResponseBase>>
----
[pass]
++++
</pre>
++++

Some files were not shown because too many files have changed in this diff Show More