diff --git a/docs/basic-config.asciidoc b/docs/basic-config.asciidoc index 799866f93..fa0982618 100644 --- a/docs/basic-config.asciidoc +++ b/docs/basic-config.asciidoc @@ -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` diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 7a438c11d..7b8f12158 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -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[] diff --git a/docs/reference-async_search-delete.asciidoc b/docs/reference-async_search-delete.asciidoc index ef3bfa339..2cbf3ea3a 100644 --- a/docs/reference-async_search-delete.asciidoc +++ b/docs/reference-async_search-delete.asciidoc @@ -41,20 +41,30 @@ Delete an async search. If the asynchronous search is still running, it is cance ---- [discrete] -===== `AsyncSearchDeleteRequest` +==== AsyncSearchDeleteRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface AsyncSearchDeleteRequest extends <+++++ [discrete] -===== `AsyncSearchDeleteResponse` +==== AsyncSearchDeleteResponse -[source,ts] ----- +[pass] +++++ +> { id: < > } ----- +[pass] +++++ +
+++++ type AsyncSearchDeleteResponse = <+++++ diff --git a/docs/reference-async_search-get.asciidoc b/docs/reference-async_search-get.asciidoc index 4d9eee425..2c00e52c7 100644 --- a/docs/reference-async_search-get.asciidoc +++ b/docs/reference-async_search-get.asciidoc @@ -41,23 +41,33 @@ Get async search results. Retrieve the results of a previously submitted asynchr ---- [discrete] -===== `AsyncSearchGetRequest` +==== AsyncSearchGetRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface AsyncSearchGetRequest extends <+++++ [discrete] -===== `AsyncSearchGetResponse` +==== AsyncSearchGetResponse -[source,ts] ----- +[pass] +++++ +> { id: < > keep_alive?: < > typed_keys?: boolean wait_for_completion_timeout?: < > } ----- +[pass] +++++ +
+++++ type AsyncSearchGetResponse+++++ diff --git a/docs/reference-async_search-status.asciidoc b/docs/reference-async_search-status.asciidoc index 9bfe7f1a5..f84488dd3 100644 --- a/docs/reference-async_search-status.asciidoc +++ b/docs/reference-async_search-status.asciidoc @@ -41,20 +41,30 @@ Get the async search status. Get the status of a previously submitted async sear ---- [discrete] -===== `AsyncSearchStatusRequest` +==== AsyncSearchStatusRequest -[source,ts] ----- +[pass] +++++ +>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase ----- +[pass] +++++ +
+++++ interface AsyncSearchStatusRequest extends <+++++ [discrete] -===== `AsyncSearchStatusResponse` +==== AsyncSearchStatusResponse -[source,ts] ----- +[pass] +++++ +> { id: < > } ----- +[pass] +++++ +
+++++ type AsyncSearchStatusResponse = AsyncSearchStatusStatusResponseBase ----- +[pass] +++++ ++++++ diff --git a/docs/reference-async_search-submit.asciidoc b/docs/reference-async_search-submit.asciidoc index d07dbe348..75352edb3 100644 --- a/docs/reference-async_search-submit.asciidoc +++ b/docs/reference-async_search-submit.asciidoc @@ -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] +++++ +
+++++ interface AsyncSearchSubmitRequest extends <+++++ [discrete] -===== `AsyncSearchSubmitResponse` +==== AsyncSearchSubmitResponse -[source,ts] ----- +[pass] +++++ +> { index?: < > wait_for_completion_timeout?: < > @@ -54,7 +56,7 @@ interface AsyncSearchSubmitRequest extends < > { allow_partial_search_results?: boolean analyzer?: string analyze_wildcard?: boolean - batched_reduce_size?: < > + batched_reduce_size?: number ccs_minimize_roundtrips?: boolean default_operator?: QueryDslOperator df?: string @@ -62,17 +64,17 @@ interface AsyncSearchSubmitRequest extends < > { ignore_throttled?: boolean ignore_unavailable?: boolean lenient?: boolean - max_concurrent_shard_requests?: < > + max_concurrent_shard_requests?: number min_compatible_shard_node?: < > preference?: string - pre_filter_shard_size?: < > + pre_filter_shard_size?: number request_cache?: boolean routing?: < > scroll?: < > search_type?: < > suggest_field?: < > suggest_mode?: < > - suggest_size?: < > + suggest_size?: number suggest_text?: string typed_keys?: boolean rest_total_hits_as_int?: boolean @@ -85,26 +87,26 @@ interface AsyncSearchSubmitRequest extends < > { collapse?: SearchFieldCollapse explain?: boolean ext?: Record - from?: < > + from?: number highlight?: SearchHighlight track_total_hits?: SearchTrackHits - indices_boost?: Record<< >, < >>[] + indices_boost?: Record<< >, number>[] docvalue_fields?: (QueryDslFieldAndFormat | < >)[] knn?: < > | < >[] - min_score?: < > + min_score?: number post_filter?: QueryDslQueryContainer profile?: boolean query?: QueryDslQueryContainer rescore?: SearchRescore | SearchRescore[] script_fields?: Record >> search_after?: < > - size?: < > + size?: number slice?: < > sort?: < > _source?: SearchSourceConfig fields?: (QueryDslFieldAndFormat | < >)[] suggest?: SearchSuggester - terminate_after?: < > + terminate_after?: number timeout?: string track_scores?: boolean version?: boolean @@ -114,13 +116,21 @@ interface AsyncSearchSubmitRequest extends < > { runtime_mappings?: MappingRuntimeFields stats?: string[] } ----- +[pass] +++++ +
+++++ type AsyncSearchSubmitResponse+++++ diff --git a/docs/reference-autoscaling-delete_autoscaling_policy.asciidoc b/docs/reference-autoscaling-delete_autoscaling_policy.asciidoc index 58a95bcf3..1d2107408 100644 --- a/docs/reference-autoscaling-delete_autoscaling_policy.asciidoc +++ b/docs/reference-autoscaling-delete_autoscaling_policy.asciidoc @@ -41,20 +41,30 @@ Delete an autoscaling policy. NOTE: This feature is designed for indirect use by ---- [discrete] -===== `AutoscalingDeleteAutoscalingPolicyRequest` +==== AutoscalingDeleteAutoscalingPolicyRequest -[source,ts] ----- +[pass] +++++ +>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase ----- +[pass] +++++ +
+++++ interface AutoscalingDeleteAutoscalingPolicyRequest extends <+++++ [discrete] -===== `AutoscalingDeleteAutoscalingPolicyResponse` +==== AutoscalingDeleteAutoscalingPolicyResponse -[source,ts] ----- +[pass] +++++ +> { name: < > } ----- +[pass] +++++ +
+++++ type AutoscalingDeleteAutoscalingPolicyResponse = <+++++ diff --git a/docs/reference-autoscaling-get_autoscaling_capacity.asciidoc b/docs/reference-autoscaling-get_autoscaling_capacity.asciidoc index a91e491e6..2eb89a798 100644 --- a/docs/reference-autoscaling-get_autoscaling_capacity.asciidoc +++ b/docs/reference-autoscaling-get_autoscaling_capacity.asciidoc @@ -41,21 +41,31 @@ Get the autoscaling capacity. NOTE: This feature is designed for indirect use by ---- [discrete] -===== `AutoscalingGetAutoscalingCapacityRequest` +==== AutoscalingGetAutoscalingCapacityRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface AutoscalingGetAutoscalingCapacityRequest extends <+++++ [discrete] -===== `AutoscalingGetAutoscalingCapacityResponse` +==== AutoscalingGetAutoscalingCapacityResponse -[source,ts] ----- +[pass] +++++ +> { } ----- +[pass] +++++ +
+++++
interface AutoscalingGetAutoscalingCapacityResponse {
policies: Record
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-autoscaling-get_autoscaling_policy.asciidoc b/docs/reference-autoscaling-get_autoscaling_policy.asciidoc
index ba403f233..af52d8dcd 100644
--- a/docs/reference-autoscaling-get_autoscaling_policy.asciidoc
+++ b/docs/reference-autoscaling-get_autoscaling_policy.asciidoc
@@ -41,20 +41,30 @@ Get an autoscaling policy. NOTE: This feature is designed for indirect use by El
----
[discrete]
-===== `AutoscalingGetAutoscalingPolicyRequest`
+==== AutoscalingGetAutoscalingPolicyRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface AutoscalingGetAutoscalingPolicyRequest extends <+++++ [discrete] -===== `AutoscalingGetAutoscalingPolicyResponse` +==== AutoscalingGetAutoscalingPolicyResponse -[source,ts] ----- +[pass] +++++ +> { name: < > } ----- +[pass] +++++ +
+++++ type AutoscalingGetAutoscalingPolicyResponse = AutoscalingAutoscalingPolicy ----- +[pass] +++++ ++++++ diff --git a/docs/reference-autoscaling-put_autoscaling_policy.asciidoc b/docs/reference-autoscaling-put_autoscaling_policy.asciidoc index 93b66749f..f6fd06e6c 100644 --- a/docs/reference-autoscaling-put_autoscaling_policy.asciidoc +++ b/docs/reference-autoscaling-put_autoscaling_policy.asciidoc @@ -41,21 +41,31 @@ Create or update an autoscaling policy. NOTE: This feature is designed for indir ---- [discrete] -===== `AutoscalingPutAutoscalingPolicyRequest` +==== AutoscalingPutAutoscalingPolicyRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface AutoscalingPutAutoscalingPolicyRequest extends <+++++ [discrete] -===== `AutoscalingPutAutoscalingPolicyResponse` +==== AutoscalingPutAutoscalingPolicyResponse -[source,ts] ----- +[pass] +++++ +> { name: < > policy?: AutoscalingAutoscalingPolicy } ----- +[pass] +++++ +
+++++ type AutoscalingPutAutoscalingPolicyResponse = <+++++ diff --git a/docs/reference-bulk.asciidoc b/docs/reference-bulk.asciidoc index 265a0ff2e..434137f36 100644 --- a/docs/reference-bulk.asciidoc +++ b/docs/reference-bulk.asciidoc @@ -41,10 +41,12 @@ Bulk index or delete documents. Performs multiple indexing or delete operations ---- [discrete] -===== `BulkRequest` +==== BulkRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface BulkRequest+++++ [discrete] -===== `BulkResponse` +==== BulkResponse -[source,ts] ----- +[pass] +++++ +extends < > { index?: < > pipeline?: string @@ -58,18 +60,26 @@ interface BulkRequest extends < require_alias?: boolean operations?: (BulkOperationContainer | BulkUpdateAction | TDocument)[] } ----- +[pass] +++++ +
+++++
interface BulkResponse {
errors: boolean
items: Partial>[]
- took: <>
- ingest_took?: <>
+ took: number
+ ingest_took?: number
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-cat-aliases.asciidoc b/docs/reference-cat-aliases.asciidoc
index 9c5628b58..f2e15606e 100644
--- a/docs/reference-cat-aliases.asciidoc
+++ b/docs/reference-cat-aliases.asciidoc
@@ -41,21 +41,31 @@ Get aliases. Retrieves the cluster’s index aliases, including filter and routi
----
[discrete]
-===== `CatAliasesRequest`
+==== CatAliasesRequest
-[source,ts]
-----
+[pass]
+++++
+
+++++
interface CatAliasesRequest extends CatCatRequestBase {
name?: <>
expand_wildcards?: <>
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatAliasesResponse`
+==== CatAliasesResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatAliasesResponse = CatAliasesAliasesRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-allocation.asciidoc b/docs/reference-cat-allocation.asciidoc index 13e69ef13..e94ce0564 100644 --- a/docs/reference-cat-allocation.asciidoc +++ b/docs/reference-cat-allocation.asciidoc @@ -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] +++++ +
+++++
interface CatAllocationRequest extends CatCatRequestBase {
node_id?: <>
bytes?: <>
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatAllocationResponse`
+==== CatAllocationResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatAllocationResponse = CatAllocationAllocationRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-component_templates.asciidoc b/docs/reference-cat-component_templates.asciidoc index bc52e218e..2e66e3814 100644 --- a/docs/reference-cat-component_templates.asciidoc +++ b/docs/reference-cat-component_templates.asciidoc @@ -41,20 +41,30 @@ Get component templates. Returns information about component templates in a clus ---- [discrete] -===== `CatComponentTemplatesRequest` +==== CatComponentTemplatesRequest -[source,ts] ----- +[pass] +++++ +
+++++
interface CatComponentTemplatesRequest extends CatCatRequestBase {
name?: string
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatComponentTemplatesResponse`
+==== CatComponentTemplatesResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatComponentTemplatesResponse = CatComponentTemplatesComponentTemplate[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-count.asciidoc b/docs/reference-cat-count.asciidoc index 2948f69b5..70cd2316a 100644 --- a/docs/reference-cat-count.asciidoc +++ b/docs/reference-cat-count.asciidoc @@ -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] +++++ +
+++++
interface CatCountRequest extends CatCatRequestBase {
index?: <>
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatCountResponse`
+==== CatCountResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatCountResponse = CatCountCountRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-fielddata.asciidoc b/docs/reference-cat-fielddata.asciidoc index 6f4280b26..44df7eff2 100644 --- a/docs/reference-cat-fielddata.asciidoc +++ b/docs/reference-cat-fielddata.asciidoc @@ -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] +++++ +
+++++
interface CatFielddataRequest extends CatCatRequestBase {
fields?: <>
bytes?: <>
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatFielddataResponse`
+==== CatFielddataResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatFielddataResponse = CatFielddataFielddataRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-health.asciidoc b/docs/reference-cat-health.asciidoc index 408e0b087..ad4ad6410 100644 --- a/docs/reference-cat-health.asciidoc +++ b/docs/reference-cat-health.asciidoc @@ -41,21 +41,31 @@ Returns the health status of a cluster, similar to the cluster health API. IMPOR ---- [discrete] -===== `CatHealthRequest` +==== CatHealthRequest -[source,ts] ----- +[pass] +++++ +
+++++
interface CatHealthRequest extends CatCatRequestBase {
time?: <>
ts?: boolean
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatHealthResponse`
+==== CatHealthResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatHealthResponse = CatHealthHealthRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-help.asciidoc b/docs/reference-cat-help.asciidoc index d240a6b1e..f7f077c5a 100644 --- a/docs/reference-cat-help.asciidoc +++ b/docs/reference-cat-help.asciidoc @@ -41,19 +41,29 @@ Get CAT help. Returns help for the CAT APIs. ---- [discrete] -===== `CatHelpRequest` +==== CatHelpRequest -[source,ts] ----- +[pass] +++++ +
+++++
interface CatHelpRequest extends CatCatRequestBase {
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatHelpResponse`
+==== CatHelpResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatHelpResponse = CatHelpHelpRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-indices.asciidoc b/docs/reference-cat-indices.asciidoc index 0dd322635..4ef9a083c 100644 --- a/docs/reference-cat-indices.asciidoc +++ b/docs/reference-cat-indices.asciidoc @@ -41,10 +41,12 @@ Get index information. Returns high-level information about indices in a cluster ---- [discrete] -===== `CatIndicesRequest` +==== CatIndicesRequest -[source,ts] ----- +[pass] +++++ +
+++++
interface CatIndicesRequest extends CatCatRequestBase {
index?: <>
bytes?: <>
@@ -54,13 +56,21 @@ interface CatIndicesRequest extends CatCatRequestBase {
pri?: boolean
time?: <>
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatIndicesResponse`
+==== CatIndicesResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatIndicesResponse = CatIndicesIndicesRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-master.asciidoc b/docs/reference-cat-master.asciidoc index cddacfc85..de6aa1a12 100644 --- a/docs/reference-cat-master.asciidoc +++ b/docs/reference-cat-master.asciidoc @@ -41,19 +41,29 @@ Returns information about the master node, including the ID, bound IP address, a ---- [discrete] -===== `CatMasterRequest` +==== CatMasterRequest -[source,ts] ----- +[pass] +++++ +
+++++
interface CatMasterRequest extends CatCatRequestBase {
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatMasterResponse`
+==== CatMasterResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatMasterResponse = CatMasterMasterRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-ml_data_frame_analytics.asciidoc b/docs/reference-cat-ml_data_frame_analytics.asciidoc index 2359c0b41..d96f470d2 100644 --- a/docs/reference-cat-ml_data_frame_analytics.asciidoc +++ b/docs/reference-cat-ml_data_frame_analytics.asciidoc @@ -41,10 +41,12 @@ Get data frame analytics jobs. Returns configuration and usage information about ---- [discrete] -===== `CatMlDataFrameAnalyticsRequest` +==== CatMlDataFrameAnalyticsRequest -[source,ts] ----- +[pass] +++++ +
+++++
interface CatMlDataFrameAnalyticsRequest extends CatCatRequestBase {
id?: <>
allow_no_match?: boolean
@@ -53,13 +55,21 @@ interface CatMlDataFrameAnalyticsRequest extends CatCatRequestBase {
s?: CatCatDfaColumns
time?: <>
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatMlDataFrameAnalyticsResponse`
+==== CatMlDataFrameAnalyticsResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatMlDataFrameAnalyticsResponse = CatMlDataFrameAnalyticsDataFrameAnalyticsRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-ml_datafeeds.asciidoc b/docs/reference-cat-ml_datafeeds.asciidoc index fee750d64..3cbe6968d 100644 --- a/docs/reference-cat-ml_datafeeds.asciidoc +++ b/docs/reference-cat-ml_datafeeds.asciidoc @@ -41,10 +41,12 @@ Get datafeeds. Returns configuration and usage information about datafeeds. This ---- [discrete] -===== `CatMlDatafeedsRequest` +==== CatMlDatafeedsRequest -[source,ts] ----- +[pass] +++++ +
+++++
interface CatMlDatafeedsRequest extends CatCatRequestBase {
datafeed_id?: <>
allow_no_match?: boolean
@@ -52,13 +54,21 @@ interface CatMlDatafeedsRequest extends CatCatRequestBase {
s?: CatCatDatafeedColumns
time?: <>
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatMlDatafeedsResponse`
+==== CatMlDatafeedsResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatMlDatafeedsResponse = CatMlDatafeedsDatafeedsRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-ml_jobs.asciidoc b/docs/reference-cat-ml_jobs.asciidoc index 29f3d5136..572f455f3 100644 --- a/docs/reference-cat-ml_jobs.asciidoc +++ b/docs/reference-cat-ml_jobs.asciidoc @@ -41,10 +41,12 @@ Get anomaly detection jobs. Returns configuration and usage information for anom ---- [discrete] -===== `CatMlJobsRequest` +==== CatMlJobsRequest -[source,ts] ----- +[pass] +++++ +
+++++
interface CatMlJobsRequest extends CatCatRequestBase {
job_id?: <>
allow_no_match?: boolean
@@ -53,13 +55,21 @@ interface CatMlJobsRequest extends CatCatRequestBase {
s?: CatCatAnonalyDetectorColumns
time?: <>
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatMlJobsResponse`
+==== CatMlJobsResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatMlJobsResponse = CatMlJobsJobsRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-ml_trained_models.asciidoc b/docs/reference-cat-ml_trained_models.asciidoc index 85140bb52..68d61fe38 100644 --- a/docs/reference-cat-ml_trained_models.asciidoc +++ b/docs/reference-cat-ml_trained_models.asciidoc @@ -41,26 +41,36 @@ Get trained models. Returns configuration and usage information about inference ---- [discrete] -===== `CatMlTrainedModelsRequest` +==== CatMlTrainedModelsRequest -[source,ts] ----- +[pass] +++++ +
+++++
interface CatMlTrainedModelsRequest extends CatCatRequestBase {
model_id?: <>
allow_no_match?: boolean
bytes?: <>
h?: CatCatTrainedModelsColumns
s?: CatCatTrainedModelsColumns
- from?: <>
- size?: <>
+ from?: number
+ size?: number
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatMlTrainedModelsResponse`
+==== CatMlTrainedModelsResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatMlTrainedModelsResponse = CatMlTrainedModelsTrainedModelsRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-nodeattrs.asciidoc b/docs/reference-cat-nodeattrs.asciidoc index e7190d1d5..be6e8f6e8 100644 --- a/docs/reference-cat-nodeattrs.asciidoc +++ b/docs/reference-cat-nodeattrs.asciidoc @@ -41,19 +41,29 @@ Returns information about custom node attributes. IMPORTANT: cat APIs are only i ---- [discrete] -===== `CatNodeattrsRequest` +==== CatNodeattrsRequest -[source,ts] ----- +[pass] +++++ +
+++++
interface CatNodeattrsRequest extends CatCatRequestBase {
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatNodeattrsResponse`
+==== CatNodeattrsResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatNodeattrsResponse = CatNodeattrsNodeAttributesRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-nodes.asciidoc b/docs/reference-cat-nodes.asciidoc index ad69da952..f5635ac7d 100644 --- a/docs/reference-cat-nodes.asciidoc +++ b/docs/reference-cat-nodes.asciidoc @@ -41,22 +41,32 @@ Returns information about the nodes in a cluster. IMPORTANT: cat APIs are only i ---- [discrete] -===== `CatNodesRequest` +==== CatNodesRequest -[source,ts] ----- +[pass] +++++ +
+++++
interface CatNodesRequest extends CatCatRequestBase {
bytes?: <>
full_id?: boolean | string
include_unloaded_segments?: boolean
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatNodesResponse`
+==== CatNodesResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatNodesResponse = CatNodesNodesRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-pending_tasks.asciidoc b/docs/reference-cat-pending_tasks.asciidoc index 1ba36e7cb..bfcbcbe13 100644 --- a/docs/reference-cat-pending_tasks.asciidoc +++ b/docs/reference-cat-pending_tasks.asciidoc @@ -41,19 +41,29 @@ Returns cluster-level changes that have not yet been executed. IMPORTANT: cat AP ---- [discrete] -===== `CatPendingTasksRequest` +==== CatPendingTasksRequest -[source,ts] ----- +[pass] +++++ +
+++++
interface CatPendingTasksRequest extends CatCatRequestBase {
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatPendingTasksResponse`
+==== CatPendingTasksResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatPendingTasksResponse = CatPendingTasksPendingTasksRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-plugins.asciidoc b/docs/reference-cat-plugins.asciidoc index 21aade07b..699ae445d 100644 --- a/docs/reference-cat-plugins.asciidoc +++ b/docs/reference-cat-plugins.asciidoc @@ -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] +++++ +
+++++
interface CatPluginsRequest extends CatCatRequestBase {
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatPluginsResponse`
+==== CatPluginsResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatPluginsResponse = CatPluginsPluginsRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-recovery.asciidoc b/docs/reference-cat-recovery.asciidoc index 0ef0228fa..bd83ff831 100644 --- a/docs/reference-cat-recovery.asciidoc +++ b/docs/reference-cat-recovery.asciidoc @@ -41,23 +41,33 @@ Returns information about ongoing and completed shard recoveries. Shard recovery ---- [discrete] -===== `CatRecoveryRequest` +==== CatRecoveryRequest -[source,ts] ----- +[pass] +++++ +
+++++
interface CatRecoveryRequest extends CatCatRequestBase {
index?: <>
active_only?: boolean
bytes?: <>
detailed?: boolean
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatRecoveryResponse`
+==== CatRecoveryResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatRecoveryResponse = CatRecoveryRecoveryRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-repositories.asciidoc b/docs/reference-cat-repositories.asciidoc index ef5967fbe..ff2976a14 100644 --- a/docs/reference-cat-repositories.asciidoc +++ b/docs/reference-cat-repositories.asciidoc @@ -41,19 +41,29 @@ Returns the snapshot repositories for a cluster. IMPORTANT: cat APIs are only in ---- [discrete] -===== `CatRepositoriesRequest` +==== CatRepositoriesRequest -[source,ts] ----- +[pass] +++++ +
+++++
interface CatRepositoriesRequest extends CatCatRequestBase {
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatRepositoriesResponse`
+==== CatRepositoriesResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatRepositoriesResponse = CatRepositoriesRepositoriesRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-segments.asciidoc b/docs/reference-cat-segments.asciidoc index 4862ff312..2e5cb5a6b 100644 --- a/docs/reference-cat-segments.asciidoc +++ b/docs/reference-cat-segments.asciidoc @@ -41,21 +41,31 @@ Returns low-level information about the Lucene segments in index shards. For dat ---- [discrete] -===== `CatSegmentsRequest` +==== CatSegmentsRequest -[source,ts] ----- +[pass] +++++ +
+++++
interface CatSegmentsRequest extends CatCatRequestBase {
index?: <>
bytes?: <>
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatSegmentsResponse`
+==== CatSegmentsResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatSegmentsResponse = CatSegmentsSegmentsRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-shards.asciidoc b/docs/reference-cat-shards.asciidoc index 939ef6c93..136711c93 100644 --- a/docs/reference-cat-shards.asciidoc +++ b/docs/reference-cat-shards.asciidoc @@ -41,21 +41,31 @@ Returns information about the shards in a cluster. For data streams, the API ret ---- [discrete] -===== `CatShardsRequest` +==== CatShardsRequest -[source,ts] ----- +[pass] +++++ +
+++++
interface CatShardsRequest extends CatCatRequestBase {
index?: <>
bytes?: <>
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatShardsResponse`
+==== CatShardsResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatShardsResponse = CatShardsShardsRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-snapshots.asciidoc b/docs/reference-cat-snapshots.asciidoc index 4898ed988..7985fcb93 100644 --- a/docs/reference-cat-snapshots.asciidoc +++ b/docs/reference-cat-snapshots.asciidoc @@ -41,21 +41,31 @@ Returns information about the snapshots stored in one or more repositories. A sn ---- [discrete] -===== `CatSnapshotsRequest` +==== CatSnapshotsRequest -[source,ts] ----- +[pass] +++++ +
+++++
interface CatSnapshotsRequest extends CatCatRequestBase {
repository?: <>
ignore_unavailable?: boolean
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatSnapshotsResponse`
+==== CatSnapshotsResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatSnapshotsResponse = CatSnapshotsSnapshotsRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-tasks.asciidoc b/docs/reference-cat-tasks.asciidoc index f8b8aad21..e48e0d631 100644 --- a/docs/reference-cat-tasks.asciidoc +++ b/docs/reference-cat-tasks.asciidoc @@ -41,23 +41,33 @@ Returns information about tasks currently executing in the cluster. IMPORTANT: c ---- [discrete] -===== `CatTasksRequest` +==== CatTasksRequest -[source,ts] ----- +[pass] +++++ +
+++++
interface CatTasksRequest extends CatCatRequestBase {
actions?: string[]
detailed?: boolean
node_id?: string[]
parent_task_id?: string
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatTasksResponse`
+==== CatTasksResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatTasksResponse = CatTasksTasksRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-templates.asciidoc b/docs/reference-cat-templates.asciidoc index 6b8d7bd89..fe904ba52 100644 --- a/docs/reference-cat-templates.asciidoc +++ b/docs/reference-cat-templates.asciidoc @@ -41,20 +41,30 @@ Returns information about index templates in a cluster. You can use index templa ---- [discrete] -===== `CatTemplatesRequest` +==== CatTemplatesRequest -[source,ts] ----- +[pass] +++++ +
+++++
interface CatTemplatesRequest extends CatCatRequestBase {
name?: <>
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatTemplatesResponse`
+==== CatTemplatesResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatTemplatesResponse = CatTemplatesTemplatesRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-thread_pool.asciidoc b/docs/reference-cat-thread_pool.asciidoc index 0726614c0..05b52d18f 100644 --- a/docs/reference-cat-thread_pool.asciidoc +++ b/docs/reference-cat-thread_pool.asciidoc @@ -41,21 +41,31 @@ Returns thread pool statistics for each node in a cluster. Returned information ---- [discrete] -===== `CatThreadPoolRequest` +==== CatThreadPoolRequest -[source,ts] ----- +[pass] +++++ +
+++++
interface CatThreadPoolRequest extends CatCatRequestBase {
thread_pool_patterns?: <>
time?: <>
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatThreadPoolResponse`
+==== CatThreadPoolResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatThreadPoolResponse = CatThreadPoolThreadPoolRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cat-transforms.asciidoc b/docs/reference-cat-transforms.asciidoc index 37b0fa11e..430340f2f 100644 --- a/docs/reference-cat-transforms.asciidoc +++ b/docs/reference-cat-transforms.asciidoc @@ -41,26 +41,36 @@ Get transforms. Returns configuration and usage information about transforms. CA ---- [discrete] -===== `CatTransformsRequest` +==== CatTransformsRequest -[source,ts] ----- +[pass] +++++ +
+++++
interface CatTransformsRequest extends CatCatRequestBase {
transform_id?: <>
allow_no_match?: boolean
- from?: <>
+ from?: number
h?: CatCatTransformColumns
s?: CatCatTransformColumns
time?: <>
- size?: <>
+ size?: number
}
-----
+[pass]
+++++
+
+++++
[discrete]
-===== `CatTransformsResponse`
+==== CatTransformsResponse
-[source,ts]
-----
+[pass]
+++++
++++++ type CatTransformsResponse = CatTransformsTransformsRecord[] ----- +[pass] +++++ ++++++ diff --git a/docs/reference-ccr-delete_auto_follow_pattern.asciidoc b/docs/reference-ccr-delete_auto_follow_pattern.asciidoc index 9cc165b78..d731d4370 100644 --- a/docs/reference-ccr-delete_auto_follow_pattern.asciidoc +++ b/docs/reference-ccr-delete_auto_follow_pattern.asciidoc @@ -41,20 +41,30 @@ Deletes auto-follow patterns. ---- [discrete] -===== `CcrDeleteAutoFollowPatternRequest` +==== CcrDeleteAutoFollowPatternRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface CcrDeleteAutoFollowPatternRequest extends <+++++ [discrete] -===== `CcrDeleteAutoFollowPatternResponse` +==== CcrDeleteAutoFollowPatternResponse -[source,ts] ----- +[pass] +++++ +> { name: < > } ----- +[pass] +++++ +
+++++ type CcrDeleteAutoFollowPatternResponse = <+++++ diff --git a/docs/reference-ccr-follow.asciidoc b/docs/reference-ccr-follow.asciidoc index bb6c2d42b..b7b770df7 100644 --- a/docs/reference-ccr-follow.asciidoc +++ b/docs/reference-ccr-follow.asciidoc @@ -41,37 +41,47 @@ Creates a new follower index configured to follow the referenced leader index. ---- [discrete] -===== `CcrFollowRequest` +==== CcrFollowRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface CcrFollowRequest extends <+++++ [discrete] -===== `CcrFollowResponse` +==== CcrFollowResponse -[source,ts] ----- +[pass] +++++ +> { index: < > wait_for_active_shards?: < > leader_index?: < > - max_outstanding_read_requests?: < > - max_outstanding_write_requests?: < > - max_read_request_operation_count?: < > + max_outstanding_read_requests?: number + max_outstanding_write_requests?: number + max_read_request_operation_count?: number max_read_request_size?: string max_retry_delay?: < > - max_write_buffer_count?: < > + max_write_buffer_count?: number max_write_buffer_size?: string - max_write_request_operation_count?: < > + max_write_request_operation_count?: number max_write_request_size?: string read_poll_timeout?: < > remote_cluster?: string } ----- +[pass] +++++ +
+++++
interface CcrFollowResponse {
follow_index_created: boolean
follow_index_shards_acked: boolean
index_following_started: boolean
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-ccr-follow_info.asciidoc b/docs/reference-ccr-follow_info.asciidoc
index 451438c1a..deb0abe54 100644
--- a/docs/reference-ccr-follow_info.asciidoc
+++ b/docs/reference-ccr-follow_info.asciidoc
@@ -41,22 +41,32 @@ Retrieves information about all follower indices, including parameters and statu
----
[discrete]
-===== `CcrFollowInfoRequest`
+==== CcrFollowInfoRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface CcrFollowInfoRequest extends <+++++ [discrete] -===== `CcrFollowInfoResponse` +==== CcrFollowInfoResponse -[source,ts] ----- +[pass] +++++ +> { index: < > } ----- +[pass] +++++ +
+++++
interface CcrFollowInfoResponse {
follower_indices: CcrFollowInfoFollowerIndex[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-ccr-follow_stats.asciidoc b/docs/reference-ccr-follow_stats.asciidoc
index 853eeee16..42bd0ce29 100644
--- a/docs/reference-ccr-follow_stats.asciidoc
+++ b/docs/reference-ccr-follow_stats.asciidoc
@@ -41,22 +41,32 @@ Retrieves follower stats. return shard-level stats about the following tasks ass
----
[discrete]
-===== `CcrFollowStatsRequest`
+==== CcrFollowStatsRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface CcrFollowStatsRequest extends <+++++ [discrete] -===== `CcrFollowStatsResponse` +==== CcrFollowStatsResponse -[source,ts] ----- +[pass] +++++ +> { index: < > } ----- +[pass] +++++ +
+++++
interface CcrFollowStatsResponse {
indices: CcrFollowIndexStats[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-ccr-forget_follower.asciidoc b/docs/reference-ccr-forget_follower.asciidoc
index b752afd3e..ac89c0d72 100644
--- a/docs/reference-ccr-forget_follower.asciidoc
+++ b/docs/reference-ccr-forget_follower.asciidoc
@@ -41,10 +41,12 @@ Removes the follower retention leases from the leader.
----
[discrete]
-===== `CcrForgetFollowerRequest`
+==== CcrForgetFollowerRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface CcrForgetFollowerRequest extends <+++++ [discrete] -===== `CcrForgetFollowerResponse` +==== CcrForgetFollowerResponse -[source,ts] ----- +[pass] +++++ +> { index: < > follower_cluster?: string @@ -52,15 +54,23 @@ interface CcrForgetFollowerRequest extends < > { follower_index_uuid?: < > leader_remote_cluster?: string } ----- +[pass] +++++ +
+++++
interface CcrForgetFollowerResponse {
_shards: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-ccr-get_auto_follow_pattern.asciidoc b/docs/reference-ccr-get_auto_follow_pattern.asciidoc
index 62dae8862..6a4df8812 100644
--- a/docs/reference-ccr-get_auto_follow_pattern.asciidoc
+++ b/docs/reference-ccr-get_auto_follow_pattern.asciidoc
@@ -41,22 +41,32 @@ Gets configured auto-follow patterns. Returns the specified auto-follow pattern
----
[discrete]
-===== `CcrGetAutoFollowPatternRequest`
+==== CcrGetAutoFollowPatternRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface CcrGetAutoFollowPatternRequest extends <+++++ [discrete] -===== `CcrGetAutoFollowPatternResponse` +==== CcrGetAutoFollowPatternResponse -[source,ts] ----- +[pass] +++++ +> { name?: < > } ----- +[pass] +++++ +
+++++
interface CcrGetAutoFollowPatternResponse {
patterns: CcrGetAutoFollowPatternAutoFollowPattern[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-ccr-pause_auto_follow_pattern.asciidoc b/docs/reference-ccr-pause_auto_follow_pattern.asciidoc
index 9d13e03e2..e11277ee4 100644
--- a/docs/reference-ccr-pause_auto_follow_pattern.asciidoc
+++ b/docs/reference-ccr-pause_auto_follow_pattern.asciidoc
@@ -41,20 +41,30 @@ Pauses an auto-follow pattern
----
[discrete]
-===== `CcrPauseAutoFollowPatternRequest`
+==== CcrPauseAutoFollowPatternRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface CcrPauseAutoFollowPatternRequest extends <+++++ [discrete] -===== `CcrPauseAutoFollowPatternResponse` +==== CcrPauseAutoFollowPatternResponse -[source,ts] ----- +[pass] +++++ +> { name: < > } ----- +[pass] +++++ +
+++++ type CcrPauseAutoFollowPatternResponse = <+++++ diff --git a/docs/reference-ccr-pause_follow.asciidoc b/docs/reference-ccr-pause_follow.asciidoc index 2856ecc10..64f8155a0 100644 --- a/docs/reference-ccr-pause_follow.asciidoc +++ b/docs/reference-ccr-pause_follow.asciidoc @@ -41,20 +41,30 @@ Pauses a follower index. The follower index will not fetch any additional operat ---- [discrete] -===== `CcrPauseFollowRequest` +==== CcrPauseFollowRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface CcrPauseFollowRequest extends <+++++ [discrete] -===== `CcrPauseFollowResponse` +==== CcrPauseFollowResponse -[source,ts] ----- +[pass] +++++ +> { index: < > } ----- +[pass] +++++ +
+++++ type CcrPauseFollowResponse = <+++++ diff --git a/docs/reference-ccr-put_auto_follow_pattern.asciidoc b/docs/reference-ccr-put_auto_follow_pattern.asciidoc index 6c6878547..24927041a 100644 --- a/docs/reference-ccr-put_auto_follow_pattern.asciidoc +++ b/docs/reference-ccr-put_auto_follow_pattern.asciidoc @@ -41,35 +41,45 @@ Creates a new named collection of auto-follow patterns against a specified remot ---- [discrete] -===== `CcrPutAutoFollowPatternRequest` +==== CcrPutAutoFollowPatternRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface CcrPutAutoFollowPatternRequest extends <+++++ [discrete] -===== `CcrPutAutoFollowPatternResponse` +==== CcrPutAutoFollowPatternResponse -[source,ts] ----- +[pass] +++++ +> { name: < > remote_cluster: string follow_index_pattern?: < > leader_index_patterns?: < > leader_index_exclusion_patterns?: < > - max_outstanding_read_requests?: < > + max_outstanding_read_requests?: number settings?: Record - max_outstanding_write_requests?: < > + max_outstanding_write_requests?: number read_poll_timeout?: < > - max_read_request_operation_count?: < > + max_read_request_operation_count?: number max_read_request_size?: < > max_retry_delay?: < > - max_write_buffer_count?: < > + max_write_buffer_count?: number max_write_buffer_size?: < > - max_write_request_operation_count?: < > + max_write_request_operation_count?: number max_write_request_size?: < > } ----- +[pass] +++++ +
+++++ type CcrPutAutoFollowPatternResponse = <+++++ diff --git a/docs/reference-ccr-resume_auto_follow_pattern.asciidoc b/docs/reference-ccr-resume_auto_follow_pattern.asciidoc index 291ea1aa8..824758d70 100644 --- a/docs/reference-ccr-resume_auto_follow_pattern.asciidoc +++ b/docs/reference-ccr-resume_auto_follow_pattern.asciidoc @@ -41,20 +41,30 @@ Resumes an auto-follow pattern that has been paused ---- [discrete] -===== `CcrResumeAutoFollowPatternRequest` +==== CcrResumeAutoFollowPatternRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface CcrResumeAutoFollowPatternRequest extends <+++++ [discrete] -===== `CcrResumeAutoFollowPatternResponse` +==== CcrResumeAutoFollowPatternResponse -[source,ts] ----- +[pass] +++++ +> { name: < > } ----- +[pass] +++++ +
+++++ type CcrResumeAutoFollowPatternResponse = <+++++ diff --git a/docs/reference-ccr-resume_follow.asciidoc b/docs/reference-ccr-resume_follow.asciidoc index 700defa44..5c40d5df6 100644 --- a/docs/reference-ccr-resume_follow.asciidoc +++ b/docs/reference-ccr-resume_follow.asciidoc @@ -41,30 +41,40 @@ Resumes a follower index that has been paused ---- [discrete] -===== `CcrResumeFollowRequest` +==== CcrResumeFollowRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface CcrResumeFollowRequest extends <+++++ [discrete] -===== `CcrResumeFollowResponse` +==== CcrResumeFollowResponse -[source,ts] ----- +[pass] +++++ +> { index: < > - max_outstanding_read_requests?: < > - max_outstanding_write_requests?: < > - max_read_request_operation_count?: < > + max_outstanding_read_requests?: number + max_outstanding_write_requests?: number + max_read_request_operation_count?: number max_read_request_size?: string max_retry_delay?: < > - max_write_buffer_count?: < > + max_write_buffer_count?: number max_write_buffer_size?: string - max_write_request_operation_count?: < > + max_write_request_operation_count?: number max_write_request_size?: string read_poll_timeout?: < > } ----- +[pass] +++++ +
+++++ type CcrResumeFollowResponse = <+++++ diff --git a/docs/reference-ccr-stats.asciidoc b/docs/reference-ccr-stats.asciidoc index b1a4ba275..cc8b9f128 100644 --- a/docs/reference-ccr-stats.asciidoc +++ b/docs/reference-ccr-stats.asciidoc @@ -41,22 +41,32 @@ Gets all stats related to cross-cluster replication. ---- [discrete] -===== `CcrStatsRequest` +==== CcrStatsRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface CcrStatsRequest extends <+++++ [discrete] -===== `CcrStatsResponse` +==== CcrStatsResponse -[source,ts] ----- +[pass] +++++ +> { } ----- +[pass] +++++ +
+++++
interface CcrStatsResponse {
auto_follow_stats: CcrStatsAutoFollowStats
follow_stats: CcrStatsFollowStats
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-ccr-unfollow.asciidoc b/docs/reference-ccr-unfollow.asciidoc
index d0f071518..bc792e2c5 100644
--- a/docs/reference-ccr-unfollow.asciidoc
+++ b/docs/reference-ccr-unfollow.asciidoc
@@ -41,20 +41,30 @@ Stops the following task associated with a follower index and removes index meta
----
[discrete]
-===== `CcrUnfollowRequest`
+==== CcrUnfollowRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface CcrUnfollowRequest extends <+++++ [discrete] -===== `CcrUnfollowResponse` +==== CcrUnfollowResponse -[source,ts] ----- +[pass] +++++ +> { index: < > } ----- +[pass] +++++ +
+++++ type CcrUnfollowResponse = <+++++ diff --git a/docs/reference-clear_scroll.asciidoc b/docs/reference-clear_scroll.asciidoc index 2bc343786..24ef6297a 100644 --- a/docs/reference-clear_scroll.asciidoc +++ b/docs/reference-clear_scroll.asciidoc @@ -41,23 +41,33 @@ Clear a scrolling search. Clear the search context and results for a scrolling s ---- [discrete] -===== `ClearScrollRequest` +==== ClearScrollRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface ClearScrollRequest extends <+++++ [discrete] -===== `ClearScrollResponse` +==== ClearScrollResponse -[source,ts] ----- +[pass] +++++ +> { scroll_id?: < > } ----- +[pass] +++++ +
+++++
interface ClearScrollResponse {
succeeded: boolean
- num_freed: <>
+ num_freed: number
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-close_point_in_time.asciidoc b/docs/reference-close_point_in_time.asciidoc
index 2e4c9f2f7..a6b5d3b34 100644
--- a/docs/reference-close_point_in_time.asciidoc
+++ b/docs/reference-close_point_in_time.asciidoc
@@ -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]
+++++
++++++ interface ClosePointInTimeRequest extends <+++++ [discrete] -===== `ClosePointInTimeResponse` +==== ClosePointInTimeResponse -[source,ts] ----- +[pass] +++++ +> { id: < > } ----- +[pass] +++++ +
+++++
interface ClosePointInTimeResponse {
succeeded: boolean
- num_freed: <>
+ num_freed: number
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-cluster-allocation_explain.asciidoc b/docs/reference-cluster-allocation_explain.asciidoc
index e85bfcd1e..f65bd16e4 100644
--- a/docs/reference-cluster-allocation_explain.asciidoc
+++ b/docs/reference-cluster-allocation_explain.asciidoc
@@ -41,25 +41,32 @@ Provides explanations for shard allocations in the cluster.
----
[discrete]
-===== `ClusterAllocationExplainRequest`
+==== ClusterAllocationExplainRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface ClusterAllocationExplainRequest extends <+++++ [discrete] -===== `ClusterAllocationExplainResponse` +==== ClusterAllocationExplainResponse -[source,ts] ----- +[pass] +++++ +> { include_disk_info?: boolean include_yes_decisions?: boolean current_node?: string index?: < > primary?: boolean - shard?: < > + shard?: number } ----- +[pass] +++++ +
+++++
interface ClusterAllocationExplainResponse {
allocate_explanation?: string
allocation_delay?: <>
@@ -83,9 +90,12 @@ interface ClusterAllocationExplainResponse {
rebalance_explanation?: string
remaining_delay?: <>
remaining_delay_in_millis?: <><<>>
- shard: <>
+ shard: number
unassigned_info?: ClusterAllocationExplainUnassignedInformation
note?: string
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-cluster-delete_component_template.asciidoc b/docs/reference-cluster-delete_component_template.asciidoc
index 3d5b460da..f5dc519de 100644
--- a/docs/reference-cluster-delete_component_template.asciidoc
+++ b/docs/reference-cluster-delete_component_template.asciidoc
@@ -41,22 +41,32 @@ Delete component templates. Deletes component templates. Component templates are
----
[discrete]
-===== `ClusterDeleteComponentTemplateRequest`
+==== ClusterDeleteComponentTemplateRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface ClusterDeleteComponentTemplateRequest extends <+++++ [discrete] -===== `ClusterDeleteComponentTemplateResponse` +==== ClusterDeleteComponentTemplateResponse -[source,ts] ----- +[pass] +++++ +> { name: < > master_timeout?: < > timeout?: < > } ----- +[pass] +++++ +
+++++ type ClusterDeleteComponentTemplateResponse = <+++++ diff --git a/docs/reference-cluster-delete_voting_config_exclusions.asciidoc b/docs/reference-cluster-delete_voting_config_exclusions.asciidoc index 1a95d2f54..4642bdd0c 100644 --- a/docs/reference-cluster-delete_voting_config_exclusions.asciidoc +++ b/docs/reference-cluster-delete_voting_config_exclusions.asciidoc @@ -41,20 +41,30 @@ Clears cluster voting config exclusions. ---- [discrete] -===== `ClusterDeleteVotingConfigExclusionsRequest` +==== ClusterDeleteVotingConfigExclusionsRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface ClusterDeleteVotingConfigExclusionsRequest extends <+++++ [discrete] -===== `ClusterDeleteVotingConfigExclusionsResponse` +==== ClusterDeleteVotingConfigExclusionsResponse -[source,ts] ----- +[pass] +++++ +> { wait_for_removal?: boolean } ----- +[pass] +++++ +
+++++ type ClusterDeleteVotingConfigExclusionsResponse = boolean ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cluster-exists_component_template.asciidoc b/docs/reference-cluster-exists_component_template.asciidoc index ffb8e5ba4..b1d1e8635 100644 --- a/docs/reference-cluster-exists_component_template.asciidoc +++ b/docs/reference-cluster-exists_component_template.asciidoc @@ -41,22 +41,32 @@ Check component templates. Returns information about whether a particular compon ---- [discrete] -===== `ClusterExistsComponentTemplateRequest` +==== ClusterExistsComponentTemplateRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface ClusterExistsComponentTemplateRequest extends <+++++ [discrete] -===== `ClusterExistsComponentTemplateResponse` +==== ClusterExistsComponentTemplateResponse -[source,ts] ----- +[pass] +++++ +> { name: < > master_timeout?: < > local?: boolean } ----- +[pass] +++++ +
+++++ type ClusterExistsComponentTemplateResponse = boolean ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cluster-get_component_template.asciidoc b/docs/reference-cluster-get_component_template.asciidoc index b547aa17c..d7267ff04 100644 --- a/docs/reference-cluster-get_component_template.asciidoc +++ b/docs/reference-cluster-get_component_template.asciidoc @@ -41,10 +41,12 @@ Get component templates. Retrieves information about component templates. ---- [discrete] -===== `ClusterGetComponentTemplateRequest` +==== ClusterGetComponentTemplateRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface ClusterGetComponentTemplateRequest extends <+++++ [discrete] -===== `ClusterGetComponentTemplateResponse` +==== ClusterGetComponentTemplateResponse -[source,ts] ----- +[pass] +++++ +> { name?: < > flat_settings?: boolean @@ -52,15 +54,23 @@ interface ClusterGetComponentTemplateRequest extends < > { local?: boolean master_timeout?: < > } ----- +[pass] +++++ +
+++++
interface ClusterGetComponentTemplateResponse {
component_templates: ClusterComponentTemplate[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-cluster-get_settings.asciidoc b/docs/reference-cluster-get_settings.asciidoc
index adcf8e948..ec6dd701b 100644
--- a/docs/reference-cluster-get_settings.asciidoc
+++ b/docs/reference-cluster-get_settings.asciidoc
@@ -41,27 +41,37 @@ Returns cluster-wide settings. By default, it returns only settings that have be
----
[discrete]
-===== `ClusterGetSettingsRequest`
+==== ClusterGetSettingsRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface ClusterGetSettingsRequest extends <+++++ [discrete] -===== `ClusterGetSettingsResponse` +==== ClusterGetSettingsResponse -[source,ts] ----- +[pass] +++++ +> { flat_settings?: boolean include_defaults?: boolean master_timeout?: < > timeout?: < > } ----- +[pass] +++++ +
+++++
interface ClusterGetSettingsResponse {
persistent: Record
transient: Record
defaults?: Record
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-cluster-health.asciidoc b/docs/reference-cluster-health.asciidoc
index 7c80c37a1..29be6d5fc 100644
--- a/docs/reference-cluster-health.asciidoc
+++ b/docs/reference-cluster-health.asciidoc
@@ -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]
+++++
++++++ interface ClusterHealthRequest extends <+++++ [discrete] -===== `ClusterHealthResponse` +==== ClusterHealthResponse -[source,ts] ----- +[pass] +++++ +> { index?: < > expand_wildcards?: < > @@ -54,18 +56,26 @@ interface ClusterHealthRequest extends < > { timeout?: < > wait_for_active_shards?: < > wait_for_events?: < > - wait_for_nodes?: string | < > + wait_for_nodes?: string | number wait_for_no_initializing_shards?: boolean wait_for_no_relocating_shards?: boolean wait_for_status?: < > } ----- +[pass] +++++ +
+++++ type ClusterHealthResponse = ClusterHealthHealthResponseBody ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cluster-info.asciidoc b/docs/reference-cluster-info.asciidoc index 14d9c1889..b5ff01496 100644 --- a/docs/reference-cluster-info.asciidoc +++ b/docs/reference-cluster-info.asciidoc @@ -41,20 +41,27 @@ Get cluster info. Returns basic information about the cluster. ---- [discrete] -===== `ClusterInfoRequest` +==== ClusterInfoRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface ClusterInfoRequest extends <+++++ [discrete] -===== `ClusterInfoResponse` +==== ClusterInfoResponse -[source,ts] ----- +[pass] +++++ +> { target: < > } ----- +[pass] +++++ +
+++++
interface ClusterInfoResponse {
cluster_name: <>
http?: NodesHttp
@@ -62,5 +69,8 @@ interface ClusterInfoResponse {
thread_pool?: Record
script?: NodesScripting
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-cluster-pending_tasks.asciidoc b/docs/reference-cluster-pending_tasks.asciidoc
index d528df913..6baf37f69 100644
--- a/docs/reference-cluster-pending_tasks.asciidoc
+++ b/docs/reference-cluster-pending_tasks.asciidoc
@@ -41,23 +41,33 @@ Returns cluster-level changes (such as create index, update mapping, allocate or
----
[discrete]
-===== `ClusterPendingTasksRequest`
+==== ClusterPendingTasksRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface ClusterPendingTasksRequest extends <+++++ [discrete] -===== `ClusterPendingTasksResponse` +==== ClusterPendingTasksResponse -[source,ts] ----- +[pass] +++++ +> { local?: boolean master_timeout?: < > } ----- +[pass] +++++ +
+++++
interface ClusterPendingTasksResponse {
tasks: ClusterPendingTasksPendingTask[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-cluster-post_voting_config_exclusions.asciidoc b/docs/reference-cluster-post_voting_config_exclusions.asciidoc
index 76c0757e1..67816ac1e 100644
--- a/docs/reference-cluster-post_voting_config_exclusions.asciidoc
+++ b/docs/reference-cluster-post_voting_config_exclusions.asciidoc
@@ -41,22 +41,32 @@ Updates the cluster voting config exclusions by node ids or node names.
----
[discrete]
-===== `ClusterPostVotingConfigExclusionsRequest`
+==== ClusterPostVotingConfigExclusionsRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface ClusterPostVotingConfigExclusionsRequest extends <+++++ [discrete] -===== `ClusterPostVotingConfigExclusionsResponse` +==== ClusterPostVotingConfigExclusionsResponse -[source,ts] ----- +[pass] +++++ +> { node_names?: < > node_ids?: < > timeout?: < > } ----- +[pass] +++++ +
+++++ type ClusterPostVotingConfigExclusionsResponse = boolean ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cluster-put_component_template.asciidoc b/docs/reference-cluster-put_component_template.asciidoc index db145d28f..e591b7a83 100644 --- a/docs/reference-cluster-put_component_template.asciidoc +++ b/docs/reference-cluster-put_component_template.asciidoc @@ -41,10 +41,12 @@ Create or update a component template. Creates or updates a component template. ---- [discrete] -===== `ClusterPutComponentTemplateRequest` +==== ClusterPutComponentTemplateRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface ClusterPutComponentTemplateRequest extends <+++++ [discrete] -===== `ClusterPutComponentTemplateResponse` +==== ClusterPutComponentTemplateResponse -[source,ts] ----- +[pass] +++++ +> { name: < > create?: boolean @@ -54,13 +56,21 @@ interface ClusterPutComponentTemplateRequest extends < > { _meta?: < > deprecated?: boolean } ----- +[pass] +++++ +
+++++ type ClusterPutComponentTemplateResponse = <+++++ diff --git a/docs/reference-cluster-put_settings.asciidoc b/docs/reference-cluster-put_settings.asciidoc index 7e6a9bc31..f180c979f 100644 --- a/docs/reference-cluster-put_settings.asciidoc +++ b/docs/reference-cluster-put_settings.asciidoc @@ -41,10 +41,12 @@ Updates the cluster settings. ---- [discrete] -===== `ClusterPutSettingsRequest` +==== ClusterPutSettingsRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface ClusterPutSettingsRequest extends <+++++ [discrete] -===== `ClusterPutSettingsResponse` +==== ClusterPutSettingsResponse -[source,ts] ----- +[pass] +++++ +> { flat_settings?: boolean master_timeout?: < > @@ -52,17 +54,25 @@ interface ClusterPutSettingsRequest extends < > { persistent?: Record transient?: Record } ----- +[pass] +++++ +
+++++
interface ClusterPutSettingsResponse {
acknowledged: boolean
persistent: Record
transient: Record
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-cluster-remote_info.asciidoc b/docs/reference-cluster-remote_info.asciidoc
index 10078a0a4..003f5914b 100644
--- a/docs/reference-cluster-remote_info.asciidoc
+++ b/docs/reference-cluster-remote_info.asciidoc
@@ -41,19 +41,29 @@ The cluster remote info API allows you to retrieve all of the configured remote
----
[discrete]
-===== `ClusterRemoteInfoRequest`
+==== ClusterRemoteInfoRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface ClusterRemoteInfoRequest extends <+++++ [discrete] -===== `ClusterRemoteInfoResponse` +==== ClusterRemoteInfoResponse -[source,ts] ----- +[pass] +++++ +> { } ----- +[pass] +++++ +
+++++ type ClusterRemoteInfoResponse = Record+++++ diff --git a/docs/reference-cluster-reroute.asciidoc b/docs/reference-cluster-reroute.asciidoc index 2d28e8f8e..d88f3abea 100644 --- a/docs/reference-cluster-reroute.asciidoc +++ b/docs/reference-cluster-reroute.asciidoc @@ -41,10 +41,12 @@ Allows to manually change the allocation of individual shards in the cluster. ---- [discrete] -===== `ClusterRerouteRequest` +==== ClusterRerouteRequest -[source,ts] ----- +[pass] +++++ +----- +[pass] +++++ +
+++++ interface ClusterRerouteRequest extends <+++++ [discrete] -===== `ClusterRerouteResponse` +==== ClusterRerouteResponse -[source,ts] ----- +[pass] +++++ +> { dry_run?: boolean explain?: boolean @@ -54,17 +56,25 @@ interface ClusterRerouteRequest extends < > { timeout?: < > commands?: ClusterRerouteCommand[] } ----- +[pass] +++++ +
+++++
interface ClusterRerouteResponse {
acknowledged: boolean
explanations?: ClusterRerouteRerouteExplanation[]
state?: any
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-cluster-state.asciidoc b/docs/reference-cluster-state.asciidoc
index 1498d90a1..2cd8d43e4 100644
--- a/docs/reference-cluster-state.asciidoc
+++ b/docs/reference-cluster-state.asciidoc
@@ -41,10 +41,12 @@ Returns a comprehensive information about the state of the cluster.
----
[discrete]
-===== `ClusterStateRequest`
+==== ClusterStateRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface ClusterStateRequest extends <+++++ [discrete] -===== `ClusterStateResponse` +==== ClusterStateResponse -[source,ts] ----- +[pass] +++++ +> { metric?: < > index?: < > @@ -57,13 +59,21 @@ interface ClusterStateRequest extends < > { wait_for_metadata_version?: < > wait_for_timeout?: < > } ----- +[pass] +++++ +
+++++ type ClusterStateResponse = any ----- +[pass] +++++ ++++++ diff --git a/docs/reference-cluster-stats.asciidoc b/docs/reference-cluster-stats.asciidoc index c11e17ed2..7d0641d8a 100644 --- a/docs/reference-cluster-stats.asciidoc +++ b/docs/reference-cluster-stats.asciidoc @@ -41,22 +41,32 @@ Returns cluster statistics. It returns basic index metrics (shard numbers, store ---- [discrete] -===== `ClusterStatsRequest` +==== ClusterStatsRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface ClusterStatsRequest extends <+++++ [discrete] -===== `ClusterStatsResponse` +==== ClusterStatsResponse -[source,ts] ----- +[pass] +++++ +> { node_id?: < > include_remotes?: boolean timeout?: < > } ----- +[pass] +++++ +
+++++ type ClusterStatsResponse = ClusterStatsStatsResponseBase ----- +[pass] +++++ ++++++ diff --git a/docs/reference-connector-check_in.asciidoc b/docs/reference-connector-check_in.asciidoc index 55dd98b92..30a8f2c84 100644 --- a/docs/reference-connector-check_in.asciidoc +++ b/docs/reference-connector-check_in.asciidoc @@ -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] +++++ +
+++++ interface ConnectorCheckInRequest extends <+++++ [discrete] -===== `ConnectorCheckInResponse` +==== ConnectorCheckInResponse -[source,ts] ----- +[pass] +++++ +> { connector_id: < > } ----- +[pass] +++++ +
+++++
interface ConnectorCheckInResponse {
result: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-connector-delete.asciidoc b/docs/reference-connector-delete.asciidoc
index 9ddb9ba8d..001e972fe 100644
--- a/docs/reference-connector-delete.asciidoc
+++ b/docs/reference-connector-delete.asciidoc
@@ -41,21 +41,31 @@ Delete a connector. Removes a connector and associated sync jobs. This is a dest
----
[discrete]
-===== `ConnectorDeleteRequest`
+==== ConnectorDeleteRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface ConnectorDeleteRequest extends <+++++ [discrete] -===== `ConnectorDeleteResponse` +==== ConnectorDeleteResponse -[source,ts] ----- +[pass] +++++ +> { connector_id: < > delete_sync_jobs?: boolean } ----- +[pass] +++++ +
+++++ type ConnectorDeleteResponse = <+++++ diff --git a/docs/reference-connector-get.asciidoc b/docs/reference-connector-get.asciidoc index f0894535f..60d77f782 100644 --- a/docs/reference-connector-get.asciidoc +++ b/docs/reference-connector-get.asciidoc @@ -41,20 +41,30 @@ Get a connector. Get the details about a connector. ---- [discrete] -===== `ConnectorGetRequest` +==== ConnectorGetRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface ConnectorGetRequest extends <+++++ [discrete] -===== `ConnectorGetResponse` +==== ConnectorGetResponse -[source,ts] ----- +[pass] +++++ +> { connector_id: < > } ----- +[pass] +++++ +
+++++ type ConnectorGetResponse = ConnectorConnector ----- +[pass] +++++ ++++++ diff --git a/docs/reference-connector-list.asciidoc b/docs/reference-connector-list.asciidoc index ec61e4ff6..4e71cda25 100644 --- a/docs/reference-connector-list.asciidoc +++ b/docs/reference-connector-list.asciidoc @@ -41,28 +41,38 @@ Get all connectors. Get information about all connectors. ---- [discrete] -===== `ConnectorListRequest` +==== ConnectorListRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface ConnectorListRequest extends <+++++ [discrete] -===== `ConnectorListResponse` +==== ConnectorListResponse -[source,ts] ----- +[pass] +++++ +> { - from?: < > - size?: < > + from?: number + size?: number index_name?: < > connector_name?: < > service_type?: < > query?: string } ----- +[pass] +++++ +
+++++
interface ConnectorListResponse {
- count: <>
+ count: number
results: ConnectorConnector[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-connector-post.asciidoc b/docs/reference-connector-post.asciidoc
index 0aca7b9b1..818131b1c 100644
--- a/docs/reference-connector-post.asciidoc
+++ b/docs/reference-connector-post.asciidoc
@@ -41,10 +41,12 @@ Create a connector. Connectors are Elasticsearch integrations that bring content
----
[discrete]
-===== `ConnectorPostRequest`
+==== ConnectorPostRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface ConnectorPostRequest extends <+++++ [discrete] -===== `ConnectorPostResponse` +==== ConnectorPostResponse -[source,ts] ----- +[pass] +++++ +> { description?: string index_name?: < > @@ -53,16 +55,24 @@ interface ConnectorPostRequest extends < > { name?: string service_type?: string } ----- +[pass] +++++ +
+++++
interface ConnectorPostResponse {
result: <>
id: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-connector-put.asciidoc b/docs/reference-connector-put.asciidoc
index 939d109d8..4df06d749 100644
--- a/docs/reference-connector-put.asciidoc
+++ b/docs/reference-connector-put.asciidoc
@@ -41,10 +41,12 @@ Create or update a connector.
----
[discrete]
-===== `ConnectorPutRequest`
+==== ConnectorPutRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface ConnectorPutRequest extends <+++++ [discrete] -===== `ConnectorPutResponse` +==== ConnectorPutResponse -[source,ts] ----- +[pass] +++++ +> { connector_id?: < > description?: string @@ -54,16 +56,24 @@ interface ConnectorPutRequest extends < > { name?: string service_type?: string } ----- +[pass] +++++ +
+++++
interface ConnectorPutResponse {
result: <>
id: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-connector-sync_job_cancel.asciidoc b/docs/reference-connector-sync_job_cancel.asciidoc
index e977c0f1e..fb181004f 100644
--- a/docs/reference-connector-sync_job_cancel.asciidoc
+++ b/docs/reference-connector-sync_job_cancel.asciidoc
@@ -41,22 +41,32 @@ Cancel a connector sync job. Cancel a connector sync job, which sets the status
----
[discrete]
-===== `ConnectorSyncJobCancelRequest`
+==== ConnectorSyncJobCancelRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface ConnectorSyncJobCancelRequest extends <+++++ [discrete] -===== `ConnectorSyncJobCancelResponse` +==== ConnectorSyncJobCancelResponse -[source,ts] ----- +[pass] +++++ +> { connector_sync_job_id: < > } ----- +[pass] +++++ +
+++++
interface ConnectorSyncJobCancelResponse {
result: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-connector-sync_job_check_in.asciidoc b/docs/reference-connector-sync_job_check_in.asciidoc
index e10c2eaf7..12d90ae3d 100644
--- a/docs/reference-connector-sync_job_check_in.asciidoc
+++ b/docs/reference-connector-sync_job_check_in.asciidoc
@@ -40,20 +40,3 @@ Checks in a connector sync job (refreshes 'last_seen').
(ConnectorSyncJobCheckInRequest, options?): Promise+++++ interface ConnectorSyncJobDeleteRequest extends <+++++ [discrete] -===== `ConnectorSyncJobDeleteResponse` +==== ConnectorSyncJobDeleteResponse -[source,ts] ----- +[pass] +++++ +> { connector_sync_job_id: < > } ----- +[pass] +++++ +
+++++ type ConnectorSyncJobDeleteResponse = <+++++ diff --git a/docs/reference-connector-sync_job_error.asciidoc b/docs/reference-connector-sync_job_error.asciidoc index aba697d1c..ec4dfab70 100644 --- a/docs/reference-connector-sync_job_error.asciidoc +++ b/docs/reference-connector-sync_job_error.asciidoc @@ -40,20 +40,3 @@ Sets an error for a connector sync job. (ConnectorSyncJobErrorRequest, options?): Promise> ----- +[pass] +++++ +
+++++ interface ConnectorSyncJobGetRequest extends <+++++ [discrete] -===== `ConnectorSyncJobGetResponse` +==== ConnectorSyncJobGetResponse -[source,ts] ----- +[pass] +++++ +> { connector_sync_job_id: < > } ----- +[pass] +++++ +
+++++ type ConnectorSyncJobGetResponse = ConnectorConnectorSyncJob ----- +[pass] +++++ ++++++ diff --git a/docs/reference-connector-sync_job_list.asciidoc b/docs/reference-connector-sync_job_list.asciidoc index 5ad848fcf..ea20284d1 100644 --- a/docs/reference-connector-sync_job_list.asciidoc +++ b/docs/reference-connector-sync_job_list.asciidoc @@ -41,27 +41,37 @@ Get all connector sync jobs. Get information about all stored connector sync job ---- [discrete] -===== `ConnectorSyncJobListRequest` +==== ConnectorSyncJobListRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface ConnectorSyncJobListRequest extends <+++++ [discrete] -===== `ConnectorSyncJobListResponse` +==== ConnectorSyncJobListResponse -[source,ts] ----- +[pass] +++++ +> { - from?: < > - size?: < > + from?: number + size?: number status?: ConnectorSyncStatus connector_id?: < > job_type?: ConnectorSyncJobType | ConnectorSyncJobType[] } ----- +[pass] +++++ +
+++++
interface ConnectorSyncJobListResponse {
- count: <>
+ count: number
results: ConnectorConnectorSyncJob[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-connector-sync_job_post.asciidoc b/docs/reference-connector-sync_job_post.asciidoc
index a02c86f66..d8daa9ff5 100644
--- a/docs/reference-connector-sync_job_post.asciidoc
+++ b/docs/reference-connector-sync_job_post.asciidoc
@@ -41,24 +41,34 @@ Create a connector sync job. Create a connector sync job document in the interna
----
[discrete]
-===== `ConnectorSyncJobPostRequest`
+==== ConnectorSyncJobPostRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface ConnectorSyncJobPostRequest extends <+++++ [discrete] -===== `ConnectorSyncJobPostResponse` +==== ConnectorSyncJobPostResponse -[source,ts] ----- +[pass] +++++ +> { id: < > job_type?: ConnectorSyncJobType trigger_method?: ConnectorSyncJobTriggerMethod } ----- +[pass] +++++ +
+++++
interface ConnectorSyncJobPostResponse {
id: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-connector-sync_job_update_stats.asciidoc b/docs/reference-connector-sync_job_update_stats.asciidoc
index 8ef50dd09..240b4d28b 100644
--- a/docs/reference-connector-sync_job_update_stats.asciidoc
+++ b/docs/reference-connector-sync_job_update_stats.asciidoc
@@ -40,20 +40,3 @@ Updates the stats fields in the connector sync job document.
(ConnectorSyncJobUpdateStatsRequest, options?): Promise+++++ interface ConnectorUpdateActiveFilteringRequest extends <+++++ [discrete] -===== `ConnectorUpdateActiveFilteringResponse` +==== ConnectorUpdateActiveFilteringResponse -[source,ts] ----- +[pass] +++++ +> { connector_id: < > } ----- +[pass] +++++ +
+++++
interface ConnectorUpdateActiveFilteringResponse {
result: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-connector-update_api_key_id.asciidoc b/docs/reference-connector-update_api_key_id.asciidoc
index e78f1af6a..88c979af5 100644
--- a/docs/reference-connector-update_api_key_id.asciidoc
+++ b/docs/reference-connector-update_api_key_id.asciidoc
@@ -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]
+++++
++++++ interface ConnectorUpdateApiKeyIdRequest extends <+++++ [discrete] -===== `ConnectorUpdateApiKeyIdResponse` +==== ConnectorUpdateApiKeyIdResponse -[source,ts] ----- +[pass] +++++ +> { connector_id: < > api_key_id?: string api_key_secret_id?: string } ----- +[pass] +++++ +
+++++
interface ConnectorUpdateApiKeyIdResponse {
result: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-connector-update_configuration.asciidoc b/docs/reference-connector-update_configuration.asciidoc
index 82c080c2c..9be03856b 100644
--- a/docs/reference-connector-update_configuration.asciidoc
+++ b/docs/reference-connector-update_configuration.asciidoc
@@ -41,24 +41,34 @@ Update the connector configuration. Update the configuration field in the connec
----
[discrete]
-===== `ConnectorUpdateConfigurationRequest`
+==== ConnectorUpdateConfigurationRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface ConnectorUpdateConfigurationRequest extends <+++++ [discrete] -===== `ConnectorUpdateConfigurationResponse` +==== ConnectorUpdateConfigurationResponse -[source,ts] ----- +[pass] +++++ +> { connector_id: < > configuration?: ConnectorConnectorConfiguration values?: Record } ----- +[pass] +++++ +
+++++
interface ConnectorUpdateConfigurationResponse {
result: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-connector-update_error.asciidoc b/docs/reference-connector-update_error.asciidoc
index 9f3dae2e4..a9925efb8 100644
--- a/docs/reference-connector-update_error.asciidoc
+++ b/docs/reference-connector-update_error.asciidoc
@@ -41,23 +41,33 @@ Update the connector error field. Set the error field for the connector. If the
----
[discrete]
-===== `ConnectorUpdateErrorRequest`
+==== ConnectorUpdateErrorRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface ConnectorUpdateErrorRequest extends <+++++ [discrete] -===== `ConnectorUpdateErrorResponse` +==== ConnectorUpdateErrorResponse -[source,ts] ----- +[pass] +++++ +> { connector_id: < > - error: SpecUtilsWithNullValue + error: < > } ----- +[pass] +++++ +
+++++
interface ConnectorUpdateErrorResponse {
result: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-connector-update_features.asciidoc b/docs/reference-connector-update_features.asciidoc
index ceb4f10b4..5b2ebd7d3 100644
--- a/docs/reference-connector-update_features.asciidoc
+++ b/docs/reference-connector-update_features.asciidoc
@@ -40,20 +40,3 @@ Updates the connector features in the connector document.
(ConnectorUpdateFeaturesRequest, options?): Promise+++++ interface ConnectorUpdateFilteringRequest extends <+++++ [discrete] -===== `ConnectorUpdateFilteringResponse` +==== ConnectorUpdateFilteringResponse -[source,ts] ----- +[pass] +++++ +> { connector_id: < > filtering?: ConnectorFilteringConfig[] rules?: ConnectorFilteringRule[] advanced_snippet?: ConnectorFilteringAdvancedSnippet } ----- +[pass] +++++ +
+++++
interface ConnectorUpdateFilteringResponse {
result: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-connector-update_filtering_validation.asciidoc b/docs/reference-connector-update_filtering_validation.asciidoc
index 8a83ef4f6..5293f90dc 100644
--- a/docs/reference-connector-update_filtering_validation.asciidoc
+++ b/docs/reference-connector-update_filtering_validation.asciidoc
@@ -39,23 +39,33 @@ Update the connector draft filtering validation. Update the draft filtering vali
----
[discrete]
-===== `ConnectorUpdateFilteringValidationRequest`
+==== ConnectorUpdateFilteringValidationRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface ConnectorUpdateFilteringValidationRequest extends <+++++ [discrete] -===== `ConnectorUpdateFilteringValidationResponse` +==== ConnectorUpdateFilteringValidationResponse -[source,ts] ----- +[pass] +++++ +> { connector_id: < > validation: ConnectorFilteringRulesValidation } ----- +[pass] +++++ +
+++++
interface ConnectorUpdateFilteringValidationResponse {
result: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-connector-update_index_name.asciidoc b/docs/reference-connector-update_index_name.asciidoc
index 56109727c..bc1f742d3 100644
--- a/docs/reference-connector-update_index_name.asciidoc
+++ b/docs/reference-connector-update_index_name.asciidoc
@@ -41,23 +41,33 @@ Update the connector index name. Update the `index_name` field of a connector, s
----
[discrete]
-===== `ConnectorUpdateIndexNameRequest`
+==== ConnectorUpdateIndexNameRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface ConnectorUpdateIndexNameRequest extends <+++++ [discrete] -===== `ConnectorUpdateIndexNameResponse` +==== ConnectorUpdateIndexNameResponse -[source,ts] ----- +[pass] +++++ +> { connector_id: < > - index_name: SpecUtilsWithNullValue<< >> + index_name: < ><< >> } ----- +[pass] +++++ +
+++++
interface ConnectorUpdateIndexNameResponse {
result: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-connector-update_name.asciidoc b/docs/reference-connector-update_name.asciidoc
index c60bd18a7..5f8162eed 100644
--- a/docs/reference-connector-update_name.asciidoc
+++ b/docs/reference-connector-update_name.asciidoc
@@ -41,24 +41,34 @@ Update the connector name and description.
----
[discrete]
-===== `ConnectorUpdateNameRequest`
+==== ConnectorUpdateNameRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface ConnectorUpdateNameRequest extends <+++++ [discrete] -===== `ConnectorUpdateNameResponse` +==== ConnectorUpdateNameResponse -[source,ts] ----- +[pass] +++++ +> { connector_id: < > name?: string description?: string } ----- +[pass] +++++ +
+++++
interface ConnectorUpdateNameResponse {
result: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-connector-update_native.asciidoc b/docs/reference-connector-update_native.asciidoc
index df3d72f68..ca12d017e 100644
--- a/docs/reference-connector-update_native.asciidoc
+++ b/docs/reference-connector-update_native.asciidoc
@@ -39,23 +39,33 @@ Update the connector is_native flag.
----
[discrete]
-===== `ConnectorUpdateNativeRequest`
+==== ConnectorUpdateNativeRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface ConnectorUpdateNativeRequest extends <+++++ [discrete] -===== `ConnectorUpdateNativeResponse` +==== ConnectorUpdateNativeResponse -[source,ts] ----- +[pass] +++++ +> { connector_id: < > is_native: boolean } ----- +[pass] +++++ +
+++++
interface ConnectorUpdateNativeResponse {
result: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-connector-update_pipeline.asciidoc b/docs/reference-connector-update_pipeline.asciidoc
index eda967b41..f002769b4 100644
--- a/docs/reference-connector-update_pipeline.asciidoc
+++ b/docs/reference-connector-update_pipeline.asciidoc
@@ -41,23 +41,33 @@ Update the connector pipeline. When you create a new connector, the configuratio
----
[discrete]
-===== `ConnectorUpdatePipelineRequest`
+==== ConnectorUpdatePipelineRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface ConnectorUpdatePipelineRequest extends <+++++ [discrete] -===== `ConnectorUpdatePipelineResponse` +==== ConnectorUpdatePipelineResponse -[source,ts] ----- +[pass] +++++ +> { connector_id: < > pipeline: ConnectorIngestPipelineParams } ----- +[pass] +++++ +
+++++
interface ConnectorUpdatePipelineResponse {
result: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-connector-update_scheduling.asciidoc b/docs/reference-connector-update_scheduling.asciidoc
index 76cceaa41..ebbd99e48 100644
--- a/docs/reference-connector-update_scheduling.asciidoc
+++ b/docs/reference-connector-update_scheduling.asciidoc
@@ -41,23 +41,33 @@ Update the connector scheduling.
----
[discrete]
-===== `ConnectorUpdateSchedulingRequest`
+==== ConnectorUpdateSchedulingRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface ConnectorUpdateSchedulingRequest extends <+++++ [discrete] -===== `ConnectorUpdateSchedulingResponse` +==== ConnectorUpdateSchedulingResponse -[source,ts] ----- +[pass] +++++ +> { connector_id: < > scheduling: ConnectorSchedulingConfiguration } ----- +[pass] +++++ +
+++++
interface ConnectorUpdateSchedulingResponse {
result: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-connector-update_service_type.asciidoc b/docs/reference-connector-update_service_type.asciidoc
index 9e93523cf..1199530a3 100644
--- a/docs/reference-connector-update_service_type.asciidoc
+++ b/docs/reference-connector-update_service_type.asciidoc
@@ -41,23 +41,33 @@ Update the connector service type.
----
[discrete]
-===== `ConnectorUpdateServiceTypeRequest`
+==== ConnectorUpdateServiceTypeRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface ConnectorUpdateServiceTypeRequest extends <+++++ [discrete] -===== `ConnectorUpdateServiceTypeResponse` +==== ConnectorUpdateServiceTypeResponse -[source,ts] ----- +[pass] +++++ +> { connector_id: < > service_type: string } ----- +[pass] +++++ +
+++++
interface ConnectorUpdateServiceTypeResponse {
result: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-connector-update_status.asciidoc b/docs/reference-connector-update_status.asciidoc
index ae0b32122..081615760 100644
--- a/docs/reference-connector-update_status.asciidoc
+++ b/docs/reference-connector-update_status.asciidoc
@@ -41,23 +41,33 @@ Update the connector status.
----
[discrete]
-===== `ConnectorUpdateStatusRequest`
+==== ConnectorUpdateStatusRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface ConnectorUpdateStatusRequest extends <+++++ [discrete] -===== `ConnectorUpdateStatusResponse` +==== ConnectorUpdateStatusResponse -[source,ts] ----- +[pass] +++++ +> { connector_id: < > status: ConnectorConnectorStatus } ----- +[pass] +++++ +
+++++
interface ConnectorUpdateStatusResponse {
result: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-count.asciidoc b/docs/reference-count.asciidoc
index 0c1fb860a..f705ad493 100644
--- a/docs/reference-count.asciidoc
+++ b/docs/reference-count.asciidoc
@@ -41,10 +41,12 @@ Returns number of documents matching a query.
----
[discrete]
-===== `CountRequest`
+==== CountRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface CountRequest extends <+++++ [discrete] -===== `CountResponse` +==== CountResponse -[source,ts] ----- +[pass] +++++ +> { index?: < > allow_no_indices?: boolean @@ -56,23 +58,31 @@ interface CountRequest extends < > { ignore_throttled?: boolean ignore_unavailable?: boolean lenient?: boolean - min_score?: < > + min_score?: number preference?: string routing?: < > - terminate_after?: < > + terminate_after?: number q?: string query?: QueryDslQueryContainer } ----- +[pass] +++++ +
+++++
interface CountResponse {
- count: <>
+ count: number
_shards: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-create.asciidoc b/docs/reference-create.asciidoc
index 44184a497..62391a732 100644
--- a/docs/reference-create.asciidoc
+++ b/docs/reference-create.asciidoc
@@ -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]
+++++
++++++ interface CreateRequest+++++ [discrete] -===== `CreateResponse` +==== CreateResponse -[source,ts] ----- +[pass] +++++ +extends < > { id: < > index: < > @@ -57,13 +59,21 @@ interface CreateRequest extends < > { wait_for_active_shards?: < > document?: TDocument } ----- +[pass] +++++ +
+++++ type CreateResponse = <+++++ diff --git a/docs/reference-dangling_indices-delete_dangling_index.asciidoc b/docs/reference-dangling_indices-delete_dangling_index.asciidoc index 6e93d9105..a8b5d8c01 100644 --- a/docs/reference-dangling_indices-delete_dangling_index.asciidoc +++ b/docs/reference-dangling_indices-delete_dangling_index.asciidoc @@ -41,23 +41,33 @@ Delete a dangling index. If Elasticsearch encounters index data that is absent f ---- [discrete] -===== `DanglingIndicesDeleteDanglingIndexRequest` +==== DanglingIndicesDeleteDanglingIndexRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface DanglingIndicesDeleteDanglingIndexRequest extends <+++++ [discrete] -===== `DanglingIndicesDeleteDanglingIndexResponse` +==== DanglingIndicesDeleteDanglingIndexResponse -[source,ts] ----- +[pass] +++++ +> { index_uuid: < > accept_data_loss: boolean master_timeout?: < > timeout?: < > } ----- +[pass] +++++ +
+++++ type DanglingIndicesDeleteDanglingIndexResponse = <+++++ diff --git a/docs/reference-dangling_indices-import_dangling_index.asciidoc b/docs/reference-dangling_indices-import_dangling_index.asciidoc index 4a1d0cf6c..7105559af 100644 --- a/docs/reference-dangling_indices-import_dangling_index.asciidoc +++ b/docs/reference-dangling_indices-import_dangling_index.asciidoc @@ -41,23 +41,33 @@ Import a dangling index. If Elasticsearch encounters index data that is absent f ---- [discrete] -===== `DanglingIndicesImportDanglingIndexRequest` +==== DanglingIndicesImportDanglingIndexRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface DanglingIndicesImportDanglingIndexRequest extends <+++++ [discrete] -===== `DanglingIndicesImportDanglingIndexResponse` +==== DanglingIndicesImportDanglingIndexResponse -[source,ts] ----- +[pass] +++++ +> { index_uuid: < > accept_data_loss: boolean master_timeout?: < > timeout?: < > } ----- +[pass] +++++ +
+++++ type DanglingIndicesImportDanglingIndexResponse = <+++++ diff --git a/docs/reference-dangling_indices-list_dangling_indices.asciidoc b/docs/reference-dangling_indices-list_dangling_indices.asciidoc index b9438f60b..cd1a58a0e 100644 --- a/docs/reference-dangling_indices-list_dangling_indices.asciidoc +++ b/docs/reference-dangling_indices-list_dangling_indices.asciidoc @@ -41,21 +41,31 @@ Get the dangling indices. If Elasticsearch encounters index data that is absent ---- [discrete] -===== `DanglingIndicesListDanglingIndicesRequest` +==== DanglingIndicesListDanglingIndicesRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface DanglingIndicesListDanglingIndicesRequest extends <+++++ [discrete] -===== `DanglingIndicesListDanglingIndicesResponse` +==== DanglingIndicesListDanglingIndicesResponse -[source,ts] ----- +[pass] +++++ +> { } ----- +[pass] +++++ +
+++++
interface DanglingIndicesListDanglingIndicesResponse {
dangling_indices: DanglingIndicesListDanglingIndicesDanglingIndex[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-delete.asciidoc b/docs/reference-delete.asciidoc
index 04210c15f..11f09d53a 100644
--- a/docs/reference-delete.asciidoc
+++ b/docs/reference-delete.asciidoc
@@ -41,14 +41,16 @@ Delete a document. Removes a JSON document from the specified index.
----
[discrete]
-===== `DeleteRequest`
+==== DeleteRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface DeleteRequest extends <+++++ [discrete] -===== `DeleteResponse` +==== DeleteResponse -[source,ts] ----- +[pass] +++++ +> { id: < > index: < > - if_primary_term?: < > + if_primary_term?: number if_seq_no?: < > refresh?: < > routing?: < > @@ -57,13 +59,21 @@ interface DeleteRequest extends < > { version_type?: < > wait_for_active_shards?: < > } ----- +[pass] +++++ +
+++++ type DeleteResponse = <+++++ diff --git a/docs/reference-delete_by_query.asciidoc b/docs/reference-delete_by_query.asciidoc index f73d3e4c6..36a8c816d 100644 --- a/docs/reference-delete_by_query.asciidoc +++ b/docs/reference-delete_by_query.asciidoc @@ -41,10 +41,12 @@ Delete documents. Deletes documents that match the specified query. ---- [discrete] -===== `DeleteByQueryRequest` +==== DeleteByQueryRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface DeleteByQueryRequest extends <+++++ [discrete] -===== `DeleteByQueryResponse` +==== DeleteByQueryResponse -[source,ts] ----- +[pass] +++++ +> { index: < > allow_no_indices?: boolean @@ -54,46 +56,51 @@ interface DeleteByQueryRequest extends < > { default_operator?: QueryDslOperator df?: string expand_wildcards?: < > - from?: < > + from?: number ignore_unavailable?: boolean lenient?: boolean preference?: string refresh?: boolean request_cache?: boolean - requests_per_second?: < > + requests_per_second?: number routing?: < > q?: string scroll?: < > - scroll_size?: < > + scroll_size?: number search_timeout?: < > search_type?: < > slices?: < > sort?: string[] stats?: string[] - terminate_after?: < > + terminate_after?: number timeout?: < > version?: boolean wait_for_active_shards?: < > wait_for_completion?: boolean - max_docs?: < > + max_docs?: number query?: QueryDslQueryContainer slice?: < > } ----- +[pass] +++++ +
+++++
interface DeleteByQueryResponse {
- batches?: <>
- deleted?: <>
+ batches?: number
+ deleted?: number
failures?: <>[]
- noops?: <>
- requests_per_second?: <>
+ noops?: number
+ requests_per_second?: number
retries?: <>
- slice_id?: <>
+ slice_id?: number
task?: <>
throttled?: <>
throttled_millis?: <><<>>
@@ -101,8 +108,11 @@ interface DeleteByQueryResponse {
throttled_until_millis?: <><<>>
timed_out?: boolean
took?: <><<>>
- total?: <>
- version_conflicts?: <>
+ total?: number
+ version_conflicts?: number
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-delete_by_query_rethrottle.asciidoc b/docs/reference-delete_by_query_rethrottle.asciidoc
index 199af459c..760171bce 100644
--- a/docs/reference-delete_by_query_rethrottle.asciidoc
+++ b/docs/reference-delete_by_query_rethrottle.asciidoc
@@ -41,21 +41,31 @@ Throttle a delete by query operation. Change the number of requests per second f
----
[discrete]
-===== `DeleteByQueryRethrottleRequest`
+==== DeleteByQueryRethrottleRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface DeleteByQueryRethrottleRequest extends <+++++ [discrete] -===== `DeleteByQueryRethrottleResponse` +==== DeleteByQueryRethrottleResponse -[source,ts] ----- +[pass] +++++ +> { task_id: < > - requests_per_second?: < > + requests_per_second?: number } ----- +[pass] +++++ +
+++++ type DeleteByQueryRethrottleResponse = TasksTaskListResponseBase ----- +[pass] +++++ ++++++ diff --git a/docs/reference-delete_script.asciidoc b/docs/reference-delete_script.asciidoc index a1ee7107c..402b0a667 100644 --- a/docs/reference-delete_script.asciidoc +++ b/docs/reference-delete_script.asciidoc @@ -41,22 +41,32 @@ Delete a script or search template. Deletes a stored script or search template. ---- [discrete] -===== `DeleteScriptRequest` +==== DeleteScriptRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface DeleteScriptRequest extends <+++++ [discrete] -===== `DeleteScriptResponse` +==== DeleteScriptResponse -[source,ts] ----- +[pass] +++++ +> { id: < > master_timeout?: < > timeout?: < > } ----- +[pass] +++++ +
+++++ type DeleteScriptResponse = <+++++ diff --git a/docs/reference-enrich-delete_policy.asciidoc b/docs/reference-enrich-delete_policy.asciidoc index 61741e442..a98722020 100644 --- a/docs/reference-enrich-delete_policy.asciidoc +++ b/docs/reference-enrich-delete_policy.asciidoc @@ -41,20 +41,30 @@ Delete an enrich policy. Deletes an existing enrich policy and its enrich index. ---- [discrete] -===== `EnrichDeletePolicyRequest` +==== EnrichDeletePolicyRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface EnrichDeletePolicyRequest extends <+++++ [discrete] -===== `EnrichDeletePolicyResponse` +==== EnrichDeletePolicyResponse -[source,ts] ----- +[pass] +++++ +> { name: < > } ----- +[pass] +++++ +
+++++ type EnrichDeletePolicyResponse = <+++++ diff --git a/docs/reference-enrich-execute_policy.asciidoc b/docs/reference-enrich-execute_policy.asciidoc index 1d0756d0f..e57c982d4 100644 --- a/docs/reference-enrich-execute_policy.asciidoc +++ b/docs/reference-enrich-execute_policy.asciidoc @@ -41,24 +41,34 @@ Creates the enrich index for an existing enrich policy. ---- [discrete] -===== `EnrichExecutePolicyRequest` +==== EnrichExecutePolicyRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface EnrichExecutePolicyRequest extends <+++++ [discrete] -===== `EnrichExecutePolicyResponse` +==== EnrichExecutePolicyResponse -[source,ts] ----- +[pass] +++++ +> { name: < > wait_for_completion?: boolean } ----- +[pass] +++++ +
+++++
interface EnrichExecutePolicyResponse {
status?: EnrichExecutePolicyExecuteEnrichPolicyStatus
task_id?: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-enrich-get_policy.asciidoc b/docs/reference-enrich-get_policy.asciidoc
index 9faa027ca..fdee0179f 100644
--- a/docs/reference-enrich-get_policy.asciidoc
+++ b/docs/reference-enrich-get_policy.asciidoc
@@ -41,22 +41,32 @@ Get an enrich policy. Returns information about an enrich policy.
----
[discrete]
-===== `EnrichGetPolicyRequest`
+==== EnrichGetPolicyRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface EnrichGetPolicyRequest extends <+++++ [discrete] -===== `EnrichGetPolicyResponse` +==== EnrichGetPolicyResponse -[source,ts] ----- +[pass] +++++ +> { name?: < > } ----- +[pass] +++++ +
+++++
interface EnrichGetPolicyResponse {
policies: EnrichSummary[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-enrich-put_policy.asciidoc b/docs/reference-enrich-put_policy.asciidoc
index 57aba40f9..85d142f23 100644
--- a/docs/reference-enrich-put_policy.asciidoc
+++ b/docs/reference-enrich-put_policy.asciidoc
@@ -41,23 +41,33 @@ Create an enrich policy. Creates an enrich policy.
----
[discrete]
-===== `EnrichPutPolicyRequest`
+==== EnrichPutPolicyRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface EnrichPutPolicyRequest extends <+++++ [discrete] -===== `EnrichPutPolicyResponse` +==== EnrichPutPolicyResponse -[source,ts] ----- +[pass] +++++ +> { name: < > geo_match?: EnrichPolicy match?: EnrichPolicy range?: EnrichPolicy } ----- +[pass] +++++ +
+++++ type EnrichPutPolicyResponse = <+++++ diff --git a/docs/reference-enrich-stats.asciidoc b/docs/reference-enrich-stats.asciidoc index d5c5cbc8c..803c9dfee 100644 --- a/docs/reference-enrich-stats.asciidoc +++ b/docs/reference-enrich-stats.asciidoc @@ -41,23 +41,33 @@ Get enrich stats. Returns enrich coordinator statistics and information about en ---- [discrete] -===== `EnrichStatsRequest` +==== EnrichStatsRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface EnrichStatsRequest extends <+++++ [discrete] -===== `EnrichStatsResponse` +==== EnrichStatsResponse -[source,ts] ----- +[pass] +++++ +> { } ----- +[pass] +++++ +
+++++
interface EnrichStatsResponse {
coordinator_stats: EnrichStatsCoordinatorStats[]
executing_policies: EnrichStatsExecutingPolicy[]
cache_stats?: EnrichStatsCacheStats[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-eql-delete.asciidoc b/docs/reference-eql-delete.asciidoc
index 1bda4bbed..3c1d22be3 100644
--- a/docs/reference-eql-delete.asciidoc
+++ b/docs/reference-eql-delete.asciidoc
@@ -41,20 +41,30 @@ Deletes an async EQL search or a stored synchronous EQL search. The API also del
----
[discrete]
-===== `EqlDeleteRequest`
+==== EqlDeleteRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface EqlDeleteRequest extends <+++++ [discrete] -===== `EqlDeleteResponse` +==== EqlDeleteResponse -[source,ts] ----- +[pass] +++++ +> { id: < > } ----- +[pass] +++++ +
+++++ type EqlDeleteResponse = <+++++ diff --git a/docs/reference-eql-get.asciidoc b/docs/reference-eql-get.asciidoc index 81566c4d9..584a1399e 100644 --- a/docs/reference-eql-get.asciidoc +++ b/docs/reference-eql-get.asciidoc @@ -41,22 +41,32 @@ Returns the current status and available results for an async EQL search or a st ---- [discrete] -===== `EqlGetRequest` +==== EqlGetRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface EqlGetRequest extends <+++++ [discrete] -===== `EqlGetResponse` +==== EqlGetResponse -[source,ts] ----- +[pass] +++++ +> { id: < > keep_alive?: < > wait_for_completion_timeout?: < > } ----- +[pass] +++++ +
+++++ type EqlGetResponse+++++ diff --git a/docs/reference-eql-get_status.asciidoc b/docs/reference-eql-get_status.asciidoc index 95c35e105..e51ebd506 100644 --- a/docs/reference-eql-get_status.asciidoc +++ b/docs/reference-eql-get_status.asciidoc @@ -41,27 +41,37 @@ Returns the current status for an async EQL search or a stored synchronous EQL s ---- [discrete] -===== `EqlGetStatusRequest` +==== EqlGetStatusRequest -[source,ts] ----- +[pass] +++++ += EqlEqlSearchResponseBase ----- +[pass] +++++ +
+++++ interface EqlGetStatusRequest extends <+++++ [discrete] -===== `EqlGetStatusResponse` +==== EqlGetStatusResponse -[source,ts] ----- +[pass] +++++ +> { id: < > } ----- +[pass] +++++ +
+++++
interface EqlGetStatusResponse {
id: <>
is_partial: boolean
is_running: boolean
start_time_in_millis?: <><<>>
expiration_time_in_millis?: <><<>>
- completion_status?: <>
+ completion_status?: number
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-eql-search.asciidoc b/docs/reference-eql-search.asciidoc
index 2491ebcd2..ebe52c53d 100644
--- a/docs/reference-eql-search.asciidoc
+++ b/docs/reference-eql-search.asciidoc
@@ -41,10 +41,12 @@ Returns results matching a query expressed in Event Query Language (EQL)
----
[discrete]
-===== `EqlSearchRequest`
+==== EqlSearchRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface EqlSearchRequest extends <+++++ [discrete] -===== `EqlSearchResponse` +==== EqlSearchResponse -[source,ts] ----- +[pass] +++++ +> { index: < > allow_no_indices?: boolean @@ -55,23 +57,31 @@ interface EqlSearchRequest extends < > { event_category_field?: < > tiebreaker_field?: < > timestamp_field?: < > - fetch_size?: < > + fetch_size?: number filter?: QueryDslQueryContainer | QueryDslQueryContainer[] keep_alive?: < > keep_on_completion?: boolean wait_for_completion_timeout?: < > - size?: < > + size?: number fields?: QueryDslFieldAndFormat | < > | (QueryDslFieldAndFormat | < >)[] result_position?: EqlSearchResultPosition runtime_mappings?: MappingRuntimeFields } ----- +[pass] +++++ +
+++++ type EqlSearchResponse+++++ diff --git a/docs/reference-esql-async_query.asciidoc b/docs/reference-esql-async_query.asciidoc index 0cc9bcb65..46b545f08 100644 --- a/docs/reference-esql-async_query.asciidoc +++ b/docs/reference-esql-async_query.asciidoc @@ -40,20 +40,3 @@ Executes an ESQL request asynchronously (EsqlAsyncQueryRequest, options?): Promise= EqlEqlSearchResponseBase ----- +[pass] +++++ +
+++++ interface EsqlQueryRequest extends <+++++ [discrete] -===== `EsqlQueryResponse` +==== EsqlQueryResponse -[source,ts] ----- +[pass] +++++ +> { format?: EsqlQueryEsqlFormat delimiter?: string @@ -57,13 +59,21 @@ interface EsqlQueryRequest extends < > { query: string tables?: Record > } ----- +[pass] +++++ +
+++++ type EsqlQueryResponse = <+++++ diff --git a/docs/reference-exists.asciidoc b/docs/reference-exists.asciidoc index 36722d62f..3a417be5e 100644 --- a/docs/reference-exists.asciidoc +++ b/docs/reference-exists.asciidoc @@ -41,10 +41,12 @@ Check a document. Checks if a specified document exists. ---- [discrete] -===== `ExistsRequest` +==== ExistsRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface ExistsRequest extends <+++++ [discrete] -===== `ExistsResponse` +==== ExistsResponse -[source,ts] ----- +[pass] +++++ +> { id: < > index: < > @@ -59,13 +61,21 @@ interface ExistsRequest extends < > { version?: < > version_type?: < > } ----- +[pass] +++++ +
+++++ type ExistsResponse = boolean ----- +[pass] +++++ ++++++ diff --git a/docs/reference-exists_source.asciidoc b/docs/reference-exists_source.asciidoc index 3baa64d45..7285ff38f 100644 --- a/docs/reference-exists_source.asciidoc +++ b/docs/reference-exists_source.asciidoc @@ -41,10 +41,12 @@ Check for a document source. Checks if a document's `_source` is stored. ---- [discrete] -===== `ExistsSourceRequest` +==== ExistsSourceRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface ExistsSourceRequest extends <+++++ [discrete] -===== `ExistsSourceResponse` +==== ExistsSourceResponse -[source,ts] ----- +[pass] +++++ +> { id: < > index: < > @@ -58,13 +60,21 @@ interface ExistsSourceRequest extends < > { version?: < > version_type?: < > } ----- +[pass] +++++ +
+++++ type ExistsSourceResponse = boolean ----- +[pass] +++++ ++++++ diff --git a/docs/reference-explain.asciidoc b/docs/reference-explain.asciidoc index 07c01ba5c..193e9040c 100644 --- a/docs/reference-explain.asciidoc +++ b/docs/reference-explain.asciidoc @@ -41,10 +41,12 @@ Explain a document match result. Returns information about why a specific docume ---- [discrete] -===== `ExplainRequest` +==== ExplainRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface ExplainRequest extends <+++++ [discrete] -===== `ExplainResponse` +==== ExplainResponse -[source,ts] ----- +[pass] +++++ +> { id: < > index: < > @@ -62,13 +64,18 @@ interface ExplainRequest extends < > { q?: string query?: QueryDslQueryContainer } ----- +[pass] +++++ +
+++++ interface ExplainResponse+++++ diff --git a/docs/reference-features-get_features.asciidoc b/docs/reference-features-get_features.asciidoc index 30f1d3b60..1a691eb94 100644 --- a/docs/reference-features-get_features.asciidoc +++ b/docs/reference-features-get_features.asciidoc @@ -41,21 +41,31 @@ Gets a list of features which can be included in snapshots using the feature_sta ---- [discrete] -===== `FeaturesGetFeaturesRequest` +==== FeaturesGetFeaturesRequest -[source,ts] ----- +[pass] +++++ +{ _index: < > _id: < > @@ -76,5 +83,8 @@ interface ExplainResponse { explanation?: ExplainExplanationDetail get?: < > } ----- +[pass] +++++ +
+++++ interface FeaturesGetFeaturesRequest extends <+++++ [discrete] -===== `FeaturesGetFeaturesResponse` +==== FeaturesGetFeaturesResponse -[source,ts] ----- +[pass] +++++ +> { } ----- +[pass] +++++ +
+++++
interface FeaturesGetFeaturesResponse {
features: FeaturesFeature[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-features-reset_features.asciidoc b/docs/reference-features-reset_features.asciidoc
index 584b9d913..cd7cf499a 100644
--- a/docs/reference-features-reset_features.asciidoc
+++ b/docs/reference-features-reset_features.asciidoc
@@ -41,21 +41,31 @@ Resets the internal state of features, usually by deleting system indices
----
[discrete]
-===== `FeaturesResetFeaturesRequest`
+==== FeaturesResetFeaturesRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface FeaturesResetFeaturesRequest extends <+++++ [discrete] -===== `FeaturesResetFeaturesResponse` +==== FeaturesResetFeaturesResponse -[source,ts] ----- +[pass] +++++ +> { } ----- +[pass] +++++ +
+++++
interface FeaturesResetFeaturesResponse {
features: FeaturesFeature[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-field_caps.asciidoc b/docs/reference-field_caps.asciidoc
index 3a39fb613..6e354c51c 100644
--- a/docs/reference-field_caps.asciidoc
+++ b/docs/reference-field_caps.asciidoc
@@ -41,10 +41,12 @@ Get the field capabilities. Get information about the capabilities of fields amo
----
[discrete]
-===== `FieldCapsRequest`
+==== FieldCapsRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface FieldCapsRequest extends <+++++ [discrete] -===== `FieldCapsResponse` +==== FieldCapsResponse -[source,ts] ----- +[pass] +++++ +> { index?: < > allow_no_indices?: boolean @@ -58,16 +60,24 @@ interface FieldCapsRequest extends < > { index_filter?: QueryDslQueryContainer runtime_mappings?: MappingRuntimeFields } ----- +[pass] +++++ +
+++++
interface FieldCapsResponse {
indices: <>
fields: Record<<>, Record>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-fleet-global_checkpoints.asciidoc b/docs/reference-fleet-global_checkpoints.asciidoc
index 2f32e348e..3b8e1e6ca 100644
--- a/docs/reference-fleet-global_checkpoints.asciidoc
+++ b/docs/reference-fleet-global_checkpoints.asciidoc
@@ -41,10 +41,12 @@ Returns the current global checkpoints for an index. This API is design for inte
----
[discrete]
-===== `FleetGlobalCheckpointsRequest`
+==== FleetGlobalCheckpointsRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface FleetGlobalCheckpointsRequest extends <+++++ [discrete] -===== `FleetGlobalCheckpointsResponse` +==== FleetGlobalCheckpointsResponse -[source,ts] ----- +[pass] +++++ +> { index: < > | < > wait_for_advance?: boolean @@ -52,16 +54,24 @@ interface FleetGlobalCheckpointsRequest extends < > { checkpoints?: FleetCheckpoint[] timeout?: < > } ----- +[pass] +++++ +
+++++
interface FleetGlobalCheckpointsResponse {
global_checkpoints: FleetCheckpoint[]
timed_out: boolean
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-fleet-msearch.asciidoc b/docs/reference-fleet-msearch.asciidoc
index 467986729..681c360e2 100644
--- a/docs/reference-fleet-msearch.asciidoc
+++ b/docs/reference-fleet-msearch.asciidoc
@@ -39,10 +39,12 @@ Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/
----
[discrete]
-===== `FleetMsearchRequest`
+==== FleetMsearchRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface FleetMsearchRequest extends <+++++ [discrete] -===== `FleetMsearchResponse` +==== FleetMsearchResponse -[source,ts] ----- +[pass] +++++ +> { index?: < > | < > allow_no_indices?: boolean @@ -50,9 +52,9 @@ interface FleetMsearchRequest extends < > { expand_wildcards?: < > ignore_throttled?: boolean ignore_unavailable?: boolean - max_concurrent_searches?: < > - max_concurrent_shard_requests?: < > - pre_filter_shard_size?: < > + max_concurrent_searches?: number + max_concurrent_shard_requests?: number + pre_filter_shard_size?: number search_type?: < > rest_total_hits_as_int?: boolean typed_keys?: boolean @@ -60,15 +62,23 @@ interface FleetMsearchRequest extends < > { allow_partial_search_results?: boolean searches?: MsearchRequestItem[] } ----- +[pass] +++++ +
+++++ interface FleetMsearchResponse+++++ diff --git a/docs/reference-fleet-search.asciidoc b/docs/reference-fleet-search.asciidoc index 57f038d7e..590941668 100644 --- a/docs/reference-fleet-search.asciidoc +++ b/docs/reference-fleet-search.asciidoc @@ -39,16 +39,18 @@ The purpose of the fleet search api is to provide a search api where the search ---- [discrete] -===== `FleetSearchRequest` +==== FleetSearchRequest -[source,ts] ----- +[pass] +++++ +{ docs: MsearchResponseItem [] } ----- +[pass] +++++ +
+++++ interface FleetSearchRequest extends <+++++ [discrete] -===== `FleetSearchResponse` +==== FleetSearchResponse -[source,ts] ----- +[pass] +++++ +> { index: < > | < > allow_no_indices?: boolean analyzer?: string analyze_wildcard?: boolean - batched_reduce_size?: < > + batched_reduce_size?: number ccs_minimize_roundtrips?: boolean default_operator?: QueryDslOperator df?: string @@ -56,17 +58,17 @@ interface FleetSearchRequest extends < > { ignore_throttled?: boolean ignore_unavailable?: boolean lenient?: boolean - max_concurrent_shard_requests?: < > + max_concurrent_shard_requests?: number min_compatible_shard_node?: < > preference?: string - pre_filter_shard_size?: < > + pre_filter_shard_size?: number request_cache?: boolean routing?: < > scroll?: < > search_type?: < > suggest_field?: < > suggest_mode?: < > - suggest_size?: < > + suggest_size?: number suggest_text?: string typed_keys?: boolean rest_total_hits_as_int?: boolean @@ -81,25 +83,25 @@ interface FleetSearchRequest extends < > { collapse?: SearchFieldCollapse explain?: boolean ext?: Record - from?: < > + from?: number highlight?: SearchHighlight track_total_hits?: SearchTrackHits - indices_boost?: Record<< >, < >>[] + indices_boost?: Record<< >, number>[] docvalue_fields?: (QueryDslFieldAndFormat | < >)[] - min_score?: < > + min_score?: number post_filter?: QueryDslQueryContainer profile?: boolean query?: QueryDslQueryContainer rescore?: SearchRescore | SearchRescore[] script_fields?: Record >> search_after?: < > - size?: < > + size?: number slice?: < > sort?: < > _source?: SearchSourceConfig fields?: (QueryDslFieldAndFormat | < >)[] suggest?: SearchSuggester - terminate_after?: < > + terminate_after?: number timeout?: string track_scores?: boolean version?: boolean @@ -109,28 +111,36 @@ interface FleetSearchRequest extends < > { runtime_mappings?: MappingRuntimeFields stats?: string[] } ----- +[pass] +++++ +
+++++ interface FleetSearchResponse+++++ diff --git a/docs/reference-get.asciidoc b/docs/reference-get.asciidoc index 813abe1e0..46bff523c 100644 --- a/docs/reference-get.asciidoc +++ b/docs/reference-get.asciidoc @@ -41,10 +41,12 @@ Get a document by its ID. Retrieves the document with the specified ID from an i ---- [discrete] -===== `GetRequest` +==== GetRequest -[source,ts] ----- +[pass] +++++ +{ - took: < > + took: number timed_out: boolean _shards: < > hits: SearchHitsMetadata aggregations?: Record<< >, AggregationsAggregate> _clusters?: < > fields?: Record - max_score?: < > - num_reduce_phases?: < > + max_score?: number + num_reduce_phases?: number profile?: SearchProfile pit_id?: < > _scroll_id?: < > suggest?: Record<< >, SearchSuggest []> terminated_early?: boolean } ----- +[pass] +++++ +
+++++ interface GetRequest extends <+++++ [discrete] -===== `GetResponse` +==== GetResponse -[source,ts] ----- +[pass] +++++ +> { id: < > index: < > @@ -60,13 +62,21 @@ interface GetRequest extends < > { version?: < > version_type?: < > } ----- +[pass] +++++ +
+++++ type GetResponse+++++ diff --git a/docs/reference-get_script.asciidoc b/docs/reference-get_script.asciidoc index b056d6fc4..8315d2486 100644 --- a/docs/reference-get_script.asciidoc +++ b/docs/reference-get_script.asciidoc @@ -41,25 +41,35 @@ Get a script or search template. Retrieves a stored script or search template. ---- [discrete] -===== `GetScriptRequest` +==== GetScriptRequest -[source,ts] ----- +[pass] +++++ += GetGetResult ----- +[pass] +++++ +
+++++ interface GetScriptRequest extends <+++++ [discrete] -===== `GetScriptResponse` +==== GetScriptResponse -[source,ts] ----- +[pass] +++++ +> { id: < > master_timeout?: < > } ----- +[pass] +++++ +
+++++
interface GetScriptResponse {
_id: <>
found: boolean
script?: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-get_script_context.asciidoc b/docs/reference-get_script_context.asciidoc
index b1a0f567f..2893cda04 100644
--- a/docs/reference-get_script_context.asciidoc
+++ b/docs/reference-get_script_context.asciidoc
@@ -41,21 +41,31 @@ Get script contexts. Get a list of supported script contexts and their methods.
----
[discrete]
-===== `GetScriptContextRequest`
+==== GetScriptContextRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface GetScriptContextRequest extends <+++++ [discrete] -===== `GetScriptContextResponse` +==== GetScriptContextResponse -[source,ts] ----- +[pass] +++++ +> { } ----- +[pass] +++++ +
+++++
interface GetScriptContextResponse {
contexts: GetScriptContextContext[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-get_script_languages.asciidoc b/docs/reference-get_script_languages.asciidoc
index c80a7b88f..e3743e586 100644
--- a/docs/reference-get_script_languages.asciidoc
+++ b/docs/reference-get_script_languages.asciidoc
@@ -41,22 +41,32 @@ Get script languages. Get a list of available script types, languages, and conte
----
[discrete]
-===== `GetScriptLanguagesRequest`
+==== GetScriptLanguagesRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface GetScriptLanguagesRequest extends <+++++ [discrete] -===== `GetScriptLanguagesResponse` +==== GetScriptLanguagesResponse -[source,ts] ----- +[pass] +++++ +> { } ----- +[pass] +++++ +
+++++
interface GetScriptLanguagesResponse {
language_contexts: GetScriptLanguagesLanguageContext[]
types_allowed: string[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-get_source.asciidoc b/docs/reference-get_source.asciidoc
index 43a3d3e1e..37e2278b2 100644
--- a/docs/reference-get_source.asciidoc
+++ b/docs/reference-get_source.asciidoc
@@ -41,10 +41,12 @@ Get a document's source. Returns the source of a document.
----
[discrete]
-===== `GetSourceRequest`
+==== GetSourceRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface GetSourceRequest extends <+++++ [discrete] -===== `GetSourceResponse` +==== GetSourceResponse -[source,ts] ----- +[pass] +++++ +> { id: < > index: < > @@ -59,13 +61,21 @@ interface GetSourceRequest extends < > { version?: < > version_type?: < > } ----- +[pass] +++++ +
+++++ type GetSourceResponse+++++ diff --git a/docs/reference-graph-explore.asciidoc b/docs/reference-graph-explore.asciidoc index 2c3f70a24..f9d68c519 100644 --- a/docs/reference-graph-explore.asciidoc +++ b/docs/reference-graph-explore.asciidoc @@ -41,10 +41,12 @@ Extracts and summarizes information about the documents and terms in an Elastics ---- [discrete] -===== `GraphExploreRequest` +==== GraphExploreRequest -[source,ts] ----- +[pass] +++++ += TDocument ----- +[pass] +++++ +
+++++ interface GraphExploreRequest extends <+++++ [discrete] -===== `GraphExploreResponse` +==== GraphExploreResponse -[source,ts] ----- +[pass] +++++ +> { index: < > routing?: < > @@ -54,19 +56,27 @@ interface GraphExploreRequest extends < > { query?: QueryDslQueryContainer vertices?: GraphVertexDefinition[] } ----- +[pass] +++++ +
+++++
interface GraphExploreResponse {
connections: GraphConnection[]
failures: <>[]
timed_out: boolean
- took: <>
+ took: number
vertices: GraphVertex[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-health_report.asciidoc b/docs/reference-health_report.asciidoc
index e921e030d..29873dd48 100644
--- a/docs/reference-health_report.asciidoc
+++ b/docs/reference-health_report.asciidoc
@@ -41,27 +41,37 @@ Returns the health of the cluster.
----
[discrete]
-===== `HealthReportRequest`
+==== HealthReportRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface HealthReportRequest extends <+++++ [discrete] -===== `HealthReportResponse` +==== HealthReportResponse -[source,ts] ----- +[pass] +++++ +> { feature?: string | string[] timeout?: < > verbose?: boolean - size?: < > + size?: number } ----- +[pass] +++++ +
+++++
interface HealthReportResponse {
cluster_name: string
indicators: HealthReportIndicators
status?: HealthReportIndicatorHealthStatus
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-ilm-delete_lifecycle.asciidoc b/docs/reference-ilm-delete_lifecycle.asciidoc
index 6b34af6df..adc2f66e9 100644
--- a/docs/reference-ilm-delete_lifecycle.asciidoc
+++ b/docs/reference-ilm-delete_lifecycle.asciidoc
@@ -41,22 +41,32 @@ Deletes the specified lifecycle policy definition. You cannot delete policies th
----
[discrete]
-===== `IlmDeleteLifecycleRequest`
+==== IlmDeleteLifecycleRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IlmDeleteLifecycleRequest extends <+++++ [discrete] -===== `IlmDeleteLifecycleResponse` +==== IlmDeleteLifecycleResponse -[source,ts] ----- +[pass] +++++ +> { name: < > master_timeout?: < > timeout?: < > } ----- +[pass] +++++ +
+++++ type IlmDeleteLifecycleResponse = <+++++ diff --git a/docs/reference-ilm-explain_lifecycle.asciidoc b/docs/reference-ilm-explain_lifecycle.asciidoc index 63820af98..5c1cb3dec 100644 --- a/docs/reference-ilm-explain_lifecycle.asciidoc +++ b/docs/reference-ilm-explain_lifecycle.asciidoc @@ -41,10 +41,12 @@ Retrieves information about the index’s current lifecycle state, such as the c ---- [discrete] -===== `IlmExplainLifecycleRequest` +==== IlmExplainLifecycleRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IlmExplainLifecycleRequest extends <+++++ [discrete] -===== `IlmExplainLifecycleResponse` +==== IlmExplainLifecycleResponse -[source,ts] ----- +[pass] +++++ +> { index: < > only_errors?: boolean @@ -52,15 +54,23 @@ interface IlmExplainLifecycleRequest extends < > { master_timeout?: < > timeout?: < > } ----- +[pass] +++++ +
+++++
interface IlmExplainLifecycleResponse {
indices: Record<<>, IlmExplainLifecycleLifecycleExplain>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-ilm-get_lifecycle.asciidoc b/docs/reference-ilm-get_lifecycle.asciidoc
index 9e5df441e..eb03b8254 100644
--- a/docs/reference-ilm-get_lifecycle.asciidoc
+++ b/docs/reference-ilm-get_lifecycle.asciidoc
@@ -41,22 +41,32 @@ Retrieves a lifecycle policy.
----
[discrete]
-===== `IlmGetLifecycleRequest`
+==== IlmGetLifecycleRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IlmGetLifecycleRequest extends <+++++ [discrete] -===== `IlmGetLifecycleResponse` +==== IlmGetLifecycleResponse -[source,ts] ----- +[pass] +++++ +> { name?: < > master_timeout?: < > timeout?: < > } ----- +[pass] +++++ +
+++++ type IlmGetLifecycleResponse = Record+++++ diff --git a/docs/reference-ilm-get_status.asciidoc b/docs/reference-ilm-get_status.asciidoc index d60817f81..e5abfa74a 100644 --- a/docs/reference-ilm-get_status.asciidoc +++ b/docs/reference-ilm-get_status.asciidoc @@ -41,21 +41,31 @@ Retrieves the current index lifecycle management (ILM) status. ---- [discrete] -===== `IlmGetStatusRequest` +==== IlmGetStatusRequest -[source,ts] ----- +[pass] +++++ +----- +[pass] +++++ +
+++++ interface IlmGetStatusRequest extends <+++++ [discrete] -===== `IlmGetStatusResponse` +==== IlmGetStatusResponse -[source,ts] ----- +[pass] +++++ +> { } ----- +[pass] +++++ +
+++++
interface IlmGetStatusResponse {
operation_mode: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-ilm-migrate_to_data_tiers.asciidoc b/docs/reference-ilm-migrate_to_data_tiers.asciidoc
index 4e9a52ace..86247c8f8 100644
--- a/docs/reference-ilm-migrate_to_data_tiers.asciidoc
+++ b/docs/reference-ilm-migrate_to_data_tiers.asciidoc
@@ -41,22 +41,29 @@ Switches the indices, ILM policies, and legacy, composable and component templat
----
[discrete]
-===== `IlmMigrateToDataTiersRequest`
+==== IlmMigrateToDataTiersRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IlmMigrateToDataTiersRequest extends <+++++ [discrete] -===== `IlmMigrateToDataTiersResponse` +==== IlmMigrateToDataTiersResponse -[source,ts] ----- +[pass] +++++ +> { dry_run?: boolean legacy_template_to_delete?: string node_attribute?: string } ----- +[pass] +++++ +
+++++
interface IlmMigrateToDataTiersResponse {
dry_run: boolean
removed_legacy_template: string
@@ -66,5 +73,8 @@ interface IlmMigrateToDataTiersResponse {
migrated_composable_templates: string[]
migrated_component_templates: string[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-ilm-move_to_step.asciidoc b/docs/reference-ilm-move_to_step.asciidoc
index 497862306..354554711 100644
--- a/docs/reference-ilm-move_to_step.asciidoc
+++ b/docs/reference-ilm-move_to_step.asciidoc
@@ -41,22 +41,32 @@ Manually moves an index into the specified step and executes that step.
----
[discrete]
-===== `IlmMoveToStepRequest`
+==== IlmMoveToStepRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IlmMoveToStepRequest extends <+++++ [discrete] -===== `IlmMoveToStepResponse` +==== IlmMoveToStepResponse -[source,ts] ----- +[pass] +++++ +> { index: < > current_step: IlmMoveToStepStepKey next_step: IlmMoveToStepStepKey } ----- +[pass] +++++ +
+++++ type IlmMoveToStepResponse = <+++++ diff --git a/docs/reference-ilm-put_lifecycle.asciidoc b/docs/reference-ilm-put_lifecycle.asciidoc index 1fe6b584b..393afdb8f 100644 --- a/docs/reference-ilm-put_lifecycle.asciidoc +++ b/docs/reference-ilm-put_lifecycle.asciidoc @@ -41,23 +41,33 @@ Creates a lifecycle policy. If the specified policy exists, the policy is replac ---- [discrete] -===== `IlmPutLifecycleRequest` +==== IlmPutLifecycleRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IlmPutLifecycleRequest extends <+++++ [discrete] -===== `IlmPutLifecycleResponse` +==== IlmPutLifecycleResponse -[source,ts] ----- +[pass] +++++ +> { name: < > master_timeout?: < > timeout?: < > policy?: IlmPolicy } ----- +[pass] +++++ +
+++++ type IlmPutLifecycleResponse = <+++++ diff --git a/docs/reference-ilm-remove_policy.asciidoc b/docs/reference-ilm-remove_policy.asciidoc index 961ac5ead..982809242 100644 --- a/docs/reference-ilm-remove_policy.asciidoc +++ b/docs/reference-ilm-remove_policy.asciidoc @@ -41,23 +41,33 @@ Removes the assigned lifecycle policy and stops managing the specified index ---- [discrete] -===== `IlmRemovePolicyRequest` +==== IlmRemovePolicyRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IlmRemovePolicyRequest extends <+++++ [discrete] -===== `IlmRemovePolicyResponse` +==== IlmRemovePolicyResponse -[source,ts] ----- +[pass] +++++ +> { index: < > } ----- +[pass] +++++ +
+++++
interface IlmRemovePolicyResponse {
failed_indexes: <>[]
has_failures: boolean
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-ilm-retry.asciidoc b/docs/reference-ilm-retry.asciidoc
index 1da83eff7..f3264ebf8 100644
--- a/docs/reference-ilm-retry.asciidoc
+++ b/docs/reference-ilm-retry.asciidoc
@@ -41,20 +41,30 @@ Retries executing the policy for an index that is in the ERROR step.
----
[discrete]
-===== `IlmRetryRequest`
+==== IlmRetryRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IlmRetryRequest extends <+++++ [discrete] -===== `IlmRetryResponse` +==== IlmRetryResponse -[source,ts] ----- +[pass] +++++ +> { index: < > } ----- +[pass] +++++ +
+++++ type IlmRetryResponse = <+++++ diff --git a/docs/reference-ilm-start.asciidoc b/docs/reference-ilm-start.asciidoc index 6ad667696..5ee249276 100644 --- a/docs/reference-ilm-start.asciidoc +++ b/docs/reference-ilm-start.asciidoc @@ -41,21 +41,31 @@ Start the index lifecycle management (ILM) plugin. ---- [discrete] -===== `IlmStartRequest` +==== IlmStartRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IlmStartRequest extends <+++++ [discrete] -===== `IlmStartResponse` +==== IlmStartResponse -[source,ts] ----- +[pass] +++++ +> { master_timeout?: < > timeout?: < > } ----- +[pass] +++++ +
+++++ type IlmStartResponse = <+++++ diff --git a/docs/reference-ilm-stop.asciidoc b/docs/reference-ilm-stop.asciidoc index 64f08b814..68b1fd149 100644 --- a/docs/reference-ilm-stop.asciidoc +++ b/docs/reference-ilm-stop.asciidoc @@ -41,21 +41,31 @@ Halts all lifecycle management operations and stops the index lifecycle manageme ---- [discrete] -===== `IlmStopRequest` +==== IlmStopRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IlmStopRequest extends <+++++ [discrete] -===== `IlmStopResponse` +==== IlmStopResponse -[source,ts] ----- +[pass] +++++ +> { master_timeout?: < > timeout?: < > } ----- +[pass] +++++ +
+++++ type IlmStopResponse = <+++++ diff --git a/docs/reference-index.asciidoc b/docs/reference-index.asciidoc index ec1810121..cfce952f5 100644 --- a/docs/reference-index.asciidoc +++ b/docs/reference-index.asciidoc @@ -41,14 +41,16 @@ Index a document. Adds a JSON document to the specified data stream or index and ---- [discrete] -===== `IndexRequest` +==== IndexRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IndexRequest+++++ [discrete] -===== `IndexResponse` +==== IndexResponse -[source,ts] ----- +[pass] +++++ +extends < > { id?: < > index: < > - if_primary_term?: < > + if_primary_term?: number if_seq_no?: < > op_type?: < > pipeline?: string @@ -61,13 +63,21 @@ interface IndexRequest extends < > { require_alias?: boolean document?: TDocument } ----- +[pass] +++++ +
+++++ type IndexResponse = <+++++ diff --git a/docs/reference-indices-add_block.asciidoc b/docs/reference-indices-add_block.asciidoc index 866d4bb7a..046865087 100644 --- a/docs/reference-indices-add_block.asciidoc +++ b/docs/reference-indices-add_block.asciidoc @@ -41,10 +41,12 @@ Add an index block. Limits the operations allowed on an index by blocking specif ---- [discrete] -===== `IndicesAddBlockRequest` +==== IndicesAddBlockRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IndicesAddBlockRequest extends <+++++ [discrete] -===== `IndicesAddBlockResponse` +==== IndicesAddBlockResponse -[source,ts] ----- +[pass] +++++ +> { index: < > block: IndicesAddBlockIndicesBlockOptions @@ -54,17 +56,25 @@ interface IndicesAddBlockRequest extends < > { master_timeout?: < > timeout?: < > } ----- +[pass] +++++ +
+++++
interface IndicesAddBlockResponse {
acknowledged: boolean
shards_acknowledged: boolean
indices: IndicesAddBlockIndicesBlockStatus[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-indices-analyze.asciidoc b/docs/reference-indices-analyze.asciidoc
index d8e0078be..5323b1d31 100644
--- a/docs/reference-indices-analyze.asciidoc
+++ b/docs/reference-indices-analyze.asciidoc
@@ -41,10 +41,12 @@ Get tokens from text analysis. The analyze API performs [analysis](https://www.e
----
[discrete]
-===== `IndicesAnalyzeRequest`
+==== IndicesAnalyzeRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IndicesAnalyzeRequest extends <+++++ [discrete] -===== `IndicesAnalyzeResponse` +==== IndicesAnalyzeResponse -[source,ts] ----- +[pass] +++++ +> { index?: < > analyzer?: string @@ -57,16 +59,24 @@ interface IndicesAnalyzeRequest extends < > { text?: IndicesAnalyzeTextToAnalyze tokenizer?: AnalysisTokenizer } ----- +[pass] +++++ +
+++++
interface IndicesAnalyzeResponse {
detail?: IndicesAnalyzeAnalyzeDetail
tokens?: IndicesAnalyzeAnalyzeToken[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-indices-clear_cache.asciidoc b/docs/reference-indices-clear_cache.asciidoc
index 9c602951d..d842a9ff2 100644
--- a/docs/reference-indices-clear_cache.asciidoc
+++ b/docs/reference-indices-clear_cache.asciidoc
@@ -41,10 +41,12 @@ Clears the caches of one or more indices. For data streams, the API clears the c
----
[discrete]
-===== `IndicesClearCacheRequest`
+==== IndicesClearCacheRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IndicesClearCacheRequest extends <+++++ [discrete] -===== `IndicesClearCacheResponse` +==== IndicesClearCacheResponse -[source,ts] ----- +[pass] +++++ +> { index?: < > allow_no_indices?: boolean @@ -55,13 +57,21 @@ interface IndicesClearCacheRequest extends < > { query?: boolean request?: boolean } ----- +[pass] +++++ +
+++++ type IndicesClearCacheResponse = <+++++ diff --git a/docs/reference-indices-clone.asciidoc b/docs/reference-indices-clone.asciidoc index ed2accd29..f07ad36a5 100644 --- a/docs/reference-indices-clone.asciidoc +++ b/docs/reference-indices-clone.asciidoc @@ -41,10 +41,12 @@ Clones an existing index. ---- [discrete] -===== `IndicesCloneRequest` +==== IndicesCloneRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IndicesCloneRequest extends <+++++ [discrete] -===== `IndicesCloneResponse` +==== IndicesCloneResponse -[source,ts] ----- +[pass] +++++ +> { index: < > target: < > @@ -54,17 +56,25 @@ interface IndicesCloneRequest extends < > { aliases?: Record<< >, IndicesAlias> settings?: Record } ----- +[pass] +++++ +
+++++
interface IndicesCloneResponse {
acknowledged: boolean
index: <>
shards_acknowledged: boolean
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-indices-close.asciidoc b/docs/reference-indices-close.asciidoc
index 3ae85506e..d4761e42b 100644
--- a/docs/reference-indices-close.asciidoc
+++ b/docs/reference-indices-close.asciidoc
@@ -41,10 +41,12 @@ Closes an index.
----
[discrete]
-===== `IndicesCloseRequest`
+==== IndicesCloseRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IndicesCloseRequest extends <+++++ [discrete] -===== `IndicesCloseResponse` +==== IndicesCloseResponse -[source,ts] ----- +[pass] +++++ +> { index: < > allow_no_indices?: boolean @@ -54,17 +56,25 @@ interface IndicesCloseRequest extends < > { timeout?: < > wait_for_active_shards?: < > } ----- +[pass] +++++ +
+++++
interface IndicesCloseResponse {
acknowledged: boolean
indices: Record<<>, IndicesCloseCloseIndexResult>
shards_acknowledged: boolean
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-indices-create.asciidoc b/docs/reference-indices-create.asciidoc
index 8fdf6410e..8b848eb4f 100644
--- a/docs/reference-indices-create.asciidoc
+++ b/docs/reference-indices-create.asciidoc
@@ -41,10 +41,12 @@ Create an index. Creates a new index.
----
[discrete]
-===== `IndicesCreateRequest`
+==== IndicesCreateRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IndicesCreateRequest extends <+++++ [discrete] -===== `IndicesCreateResponse` +==== IndicesCreateResponse -[source,ts] ----- +[pass] +++++ +> { index: < > master_timeout?: < > @@ -54,17 +56,25 @@ interface IndicesCreateRequest extends < > { mappings?: MappingTypeMapping settings?: IndicesIndexSettings } ----- +[pass] +++++ +
+++++
interface IndicesCreateResponse {
index: <>
shards_acknowledged: boolean
acknowledged: boolean
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-indices-create_data_stream.asciidoc b/docs/reference-indices-create_data_stream.asciidoc
index ead27c8d6..5aad36b7b 100644
--- a/docs/reference-indices-create_data_stream.asciidoc
+++ b/docs/reference-indices-create_data_stream.asciidoc
@@ -41,22 +41,32 @@ Create a data stream. Creates a data stream. You must have a matching index temp
----
[discrete]
-===== `IndicesCreateDataStreamRequest`
+==== IndicesCreateDataStreamRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IndicesCreateDataStreamRequest extends <+++++ [discrete] -===== `IndicesCreateDataStreamResponse` +==== IndicesCreateDataStreamResponse -[source,ts] ----- +[pass] +++++ +> { name: < > master_timeout?: < > timeout?: < > } ----- +[pass] +++++ +
+++++ type IndicesCreateDataStreamResponse = <+++++ diff --git a/docs/reference-indices-data_streams_stats.asciidoc b/docs/reference-indices-data_streams_stats.asciidoc index ceb73336d..f9596d435 100644 --- a/docs/reference-indices-data_streams_stats.asciidoc +++ b/docs/reference-indices-data_streams_stats.asciidoc @@ -41,28 +41,38 @@ Get data stream stats. Retrieves statistics for one or more data streams. ---- [discrete] -===== `IndicesDataStreamsStatsRequest` +==== IndicesDataStreamsStatsRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IndicesDataStreamsStatsRequest extends <+++++ [discrete] -===== `IndicesDataStreamsStatsResponse` +==== IndicesDataStreamsStatsResponse -[source,ts] ----- +[pass] +++++ +> { name?: < > expand_wildcards?: < > } ----- +[pass] +++++ +
+++++
interface IndicesDataStreamsStatsResponse {
_shards: <>
- backing_indices: <>
- data_stream_count: <>
+ backing_indices: number
+ data_stream_count: number
data_streams: IndicesDataStreamsStatsDataStreamsStatsItem[]
total_store_sizes?: <>
- total_store_size_bytes: <>
+ total_store_size_bytes: number
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-indices-delete.asciidoc b/docs/reference-indices-delete.asciidoc
index b44e8efbd..f38337ab7 100644
--- a/docs/reference-indices-delete.asciidoc
+++ b/docs/reference-indices-delete.asciidoc
@@ -41,10 +41,12 @@ Delete indices. Deletes one or more indices.
----
[discrete]
-===== `IndicesDeleteRequest`
+==== IndicesDeleteRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IndicesDeleteRequest extends <+++++ [discrete] -===== `IndicesDeleteResponse` +==== IndicesDeleteResponse -[source,ts] ----- +[pass] +++++ +> { index: < > allow_no_indices?: boolean @@ -53,13 +55,21 @@ interface IndicesDeleteRequest extends < > { master_timeout?: < > timeout?: < > } ----- +[pass] +++++ +
+++++ type IndicesDeleteResponse = <+++++ diff --git a/docs/reference-indices-delete_alias.asciidoc b/docs/reference-indices-delete_alias.asciidoc index dbeca577c..4081ef46d 100644 --- a/docs/reference-indices-delete_alias.asciidoc +++ b/docs/reference-indices-delete_alias.asciidoc @@ -41,23 +41,33 @@ Delete an alias. Removes a data stream or index from an alias. ---- [discrete] -===== `IndicesDeleteAliasRequest` +==== IndicesDeleteAliasRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IndicesDeleteAliasRequest extends <+++++ [discrete] -===== `IndicesDeleteAliasResponse` +==== IndicesDeleteAliasResponse -[source,ts] ----- +[pass] +++++ +> { index: < > name: < > master_timeout?: < > timeout?: < > } ----- +[pass] +++++ +
+++++ type IndicesDeleteAliasResponse = <+++++ diff --git a/docs/reference-indices-delete_data_lifecycle.asciidoc b/docs/reference-indices-delete_data_lifecycle.asciidoc index e0141718d..a9f5e4dc4 100644 --- a/docs/reference-indices-delete_data_lifecycle.asciidoc +++ b/docs/reference-indices-delete_data_lifecycle.asciidoc @@ -41,23 +41,33 @@ Delete data stream lifecycles. Removes the data stream lifecycle from a data str ---- [discrete] -===== `IndicesDeleteDataLifecycleRequest` +==== IndicesDeleteDataLifecycleRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IndicesDeleteDataLifecycleRequest extends <+++++ [discrete] -===== `IndicesDeleteDataLifecycleResponse` +==== IndicesDeleteDataLifecycleResponse -[source,ts] ----- +[pass] +++++ +> { name: < > expand_wildcards?: < > master_timeout?: < > timeout?: < > } ----- +[pass] +++++ +
+++++ type IndicesDeleteDataLifecycleResponse = <+++++ diff --git a/docs/reference-indices-delete_data_stream.asciidoc b/docs/reference-indices-delete_data_stream.asciidoc index 6e48d68d4..f473b20b8 100644 --- a/docs/reference-indices-delete_data_stream.asciidoc +++ b/docs/reference-indices-delete_data_stream.asciidoc @@ -41,22 +41,32 @@ Delete data streams. Deletes one or more data streams and their backing indices. ---- [discrete] -===== `IndicesDeleteDataStreamRequest` +==== IndicesDeleteDataStreamRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IndicesDeleteDataStreamRequest extends <+++++ [discrete] -===== `IndicesDeleteDataStreamResponse` +==== IndicesDeleteDataStreamResponse -[source,ts] ----- +[pass] +++++ +> { name: < > master_timeout?: < > expand_wildcards?: < > } ----- +[pass] +++++ +
+++++ type IndicesDeleteDataStreamResponse = <+++++ diff --git a/docs/reference-indices-delete_index_template.asciidoc b/docs/reference-indices-delete_index_template.asciidoc index 238676df4..166cab179 100644 --- a/docs/reference-indices-delete_index_template.asciidoc +++ b/docs/reference-indices-delete_index_template.asciidoc @@ -41,22 +41,32 @@ Delete an index template. The provided> ----- +[pass] +++++ +
+++++ interface IndicesDeleteIndexTemplateRequest extends <+++++ [discrete] -===== `IndicesDeleteIndexTemplateResponse` +==== IndicesDeleteIndexTemplateResponse -[source,ts] ----- +[pass] +++++ +> { name: < > master_timeout?: < > timeout?: < > } ----- +[pass] +++++ +
+++++ type IndicesDeleteIndexTemplateResponse = <+++++ diff --git a/docs/reference-indices-delete_template.asciidoc b/docs/reference-indices-delete_template.asciidoc index c75d68e68..1a928e771 100644 --- a/docs/reference-indices-delete_template.asciidoc +++ b/docs/reference-indices-delete_template.asciidoc @@ -41,22 +41,32 @@ Deletes a legacy index template. ---- [discrete] -===== `IndicesDeleteTemplateRequest` +==== IndicesDeleteTemplateRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IndicesDeleteTemplateRequest extends <+++++ [discrete] -===== `IndicesDeleteTemplateResponse` +==== IndicesDeleteTemplateResponse -[source,ts] ----- +[pass] +++++ +> { name: < > master_timeout?: < > timeout?: < > } ----- +[pass] +++++ +
+++++ type IndicesDeleteTemplateResponse = <+++++ diff --git a/docs/reference-indices-disk_usage.asciidoc b/docs/reference-indices-disk_usage.asciidoc index 5016b03cb..7d3711744 100644 --- a/docs/reference-indices-disk_usage.asciidoc +++ b/docs/reference-indices-disk_usage.asciidoc @@ -41,10 +41,12 @@ Analyzes the disk usage of each field of an index or data stream. ---- [discrete] -===== `IndicesDiskUsageRequest` +==== IndicesDiskUsageRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IndicesDiskUsageRequest extends <+++++ [discrete] -===== `IndicesDiskUsageResponse` +==== IndicesDiskUsageResponse -[source,ts] ----- +[pass] +++++ +> { index: < > allow_no_indices?: boolean @@ -53,13 +55,21 @@ interface IndicesDiskUsageRequest extends < > { ignore_unavailable?: boolean run_expensive_tasks?: boolean } ----- +[pass] +++++ +
+++++ type IndicesDiskUsageResponse = any ----- +[pass] +++++ ++++++ diff --git a/docs/reference-indices-downsample.asciidoc b/docs/reference-indices-downsample.asciidoc index 4c4e94872..ec3910994 100644 --- a/docs/reference-indices-downsample.asciidoc +++ b/docs/reference-indices-downsample.asciidoc @@ -41,22 +41,32 @@ Aggregates a time series (TSDS) index and stores pre-computed statistical summar ---- [discrete] -===== `IndicesDownsampleRequest` +==== IndicesDownsampleRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface IndicesDownsampleRequest extends <+++++ [discrete] -===== `IndicesDownsampleResponse` +==== IndicesDownsampleResponse -[source,ts] ----- +[pass] +++++ +> { index: < > target_index: < > config?: IndicesDownsampleConfig } ----- +[pass] +++++ +
+++++ type IndicesDownsampleResponse = any ----- +[pass] +++++ ++++++ diff --git a/docs/reference-indices-exists.asciidoc b/docs/reference-indices-exists.asciidoc index 24be1ef39..b6ddc6a0c 100644 --- a/docs/reference-indices-exists.asciidoc +++ b/docs/reference-indices-exists.asciidoc @@ -41,10 +41,12 @@ Check indices. Checks if one or more indices, index aliases, or data streams exi ---- [discrete] -===== `IndicesExistsRequest` +==== IndicesExistsRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface IndicesExistsRequest extends <+++++ [discrete] -===== `IndicesExistsResponse` +==== IndicesExistsResponse -[source,ts] ----- +[pass] +++++ +> { index: < > allow_no_indices?: boolean @@ -54,13 +56,21 @@ interface IndicesExistsRequest extends < > { include_defaults?: boolean local?: boolean } ----- +[pass] +++++ +
+++++ type IndicesExistsResponse = boolean ----- +[pass] +++++ ++++++ diff --git a/docs/reference-indices-exists_alias.asciidoc b/docs/reference-indices-exists_alias.asciidoc index 0b9011c65..4daa8a1ef 100644 --- a/docs/reference-indices-exists_alias.asciidoc +++ b/docs/reference-indices-exists_alias.asciidoc @@ -41,10 +41,12 @@ Check aliases. Checks if one or more data stream or index aliases exist. ---- [discrete] -===== `IndicesExistsAliasRequest` +==== IndicesExistsAliasRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface IndicesExistsAliasRequest extends <+++++ [discrete] -===== `IndicesExistsAliasResponse` +==== IndicesExistsAliasResponse -[source,ts] ----- +[pass] +++++ +> { name: < > index?: < > @@ -53,13 +55,21 @@ interface IndicesExistsAliasRequest extends < > { ignore_unavailable?: boolean local?: boolean } ----- +[pass] +++++ +
+++++ type IndicesExistsAliasResponse = boolean ----- +[pass] +++++ ++++++ diff --git a/docs/reference-indices-exists_index_template.asciidoc b/docs/reference-indices-exists_index_template.asciidoc index bd78e5a5b..808a1570c 100644 --- a/docs/reference-indices-exists_index_template.asciidoc +++ b/docs/reference-indices-exists_index_template.asciidoc @@ -41,21 +41,31 @@ Returns information about whether a particular index template exists. ---- [discrete] -===== `IndicesExistsIndexTemplateRequest` +==== IndicesExistsIndexTemplateRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface IndicesExistsIndexTemplateRequest extends <+++++ [discrete] -===== `IndicesExistsIndexTemplateResponse` +==== IndicesExistsIndexTemplateResponse -[source,ts] ----- +[pass] +++++ +> { name: < > master_timeout?: < > } ----- +[pass] +++++ +
+++++ type IndicesExistsIndexTemplateResponse = boolean ----- +[pass] +++++ ++++++ diff --git a/docs/reference-indices-exists_template.asciidoc b/docs/reference-indices-exists_template.asciidoc index 297a462e7..59204370e 100644 --- a/docs/reference-indices-exists_template.asciidoc +++ b/docs/reference-indices-exists_template.asciidoc @@ -41,23 +41,33 @@ Check existence of index templates. Returns information about whether a particul ---- [discrete] -===== `IndicesExistsTemplateRequest` +==== IndicesExistsTemplateRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface IndicesExistsTemplateRequest extends <+++++ [discrete] -===== `IndicesExistsTemplateResponse` +==== IndicesExistsTemplateResponse -[source,ts] ----- +[pass] +++++ +> { name: < > flat_settings?: boolean local?: boolean master_timeout?: < > } ----- +[pass] +++++ +
+++++ type IndicesExistsTemplateResponse = boolean ----- +[pass] +++++ ++++++ diff --git a/docs/reference-indices-explain_data_lifecycle.asciidoc b/docs/reference-indices-explain_data_lifecycle.asciidoc index 19edd9e5d..3a2498180 100644 --- a/docs/reference-indices-explain_data_lifecycle.asciidoc +++ b/docs/reference-indices-explain_data_lifecycle.asciidoc @@ -41,24 +41,34 @@ Get the status for a data stream lifecycle. Retrieves information about an index ---- [discrete] -===== `IndicesExplainDataLifecycleRequest` +==== IndicesExplainDataLifecycleRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface IndicesExplainDataLifecycleRequest extends <+++++ [discrete] -===== `IndicesExplainDataLifecycleResponse` +==== IndicesExplainDataLifecycleResponse -[source,ts] ----- +[pass] +++++ +> { index: < > include_defaults?: boolean master_timeout?: < > } ----- +[pass] +++++ +
+++++
interface IndicesExplainDataLifecycleResponse {
indices: Record<<>, IndicesExplainDataLifecycleDataStreamLifecycleExplain>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-indices-field_usage_stats.asciidoc b/docs/reference-indices-field_usage_stats.asciidoc
index 75d62ae1a..32d75512c 100644
--- a/docs/reference-indices-field_usage_stats.asciidoc
+++ b/docs/reference-indices-field_usage_stats.asciidoc
@@ -41,10 +41,12 @@ Returns field usage information for each shard and field of an index.
----
[discrete]
-===== `IndicesFieldUsageStatsRequest`
+==== IndicesFieldUsageStatsRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IndicesFieldUsageStatsRequest extends <+++++ [discrete] -===== `IndicesFieldUsageStatsResponse` +==== IndicesFieldUsageStatsResponse -[source,ts] ----- +[pass] +++++ +> { index: < > allow_no_indices?: boolean @@ -55,13 +57,21 @@ interface IndicesFieldUsageStatsRequest extends < > { timeout?: < > wait_for_active_shards?: < > } ----- +[pass] +++++ +
+++++ type IndicesFieldUsageStatsResponse = IndicesFieldUsageStatsFieldsUsageBody ----- +[pass] +++++ ++++++ diff --git a/docs/reference-indices-flush.asciidoc b/docs/reference-indices-flush.asciidoc index ac43d259d..50676d149 100644 --- a/docs/reference-indices-flush.asciidoc +++ b/docs/reference-indices-flush.asciidoc @@ -41,10 +41,12 @@ Flushes one or more data streams or indices. ---- [discrete] -===== `IndicesFlushRequest` +==== IndicesFlushRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface IndicesFlushRequest extends <+++++ [discrete] -===== `IndicesFlushResponse` +==== IndicesFlushResponse -[source,ts] ----- +[pass] +++++ +> { index?: < > allow_no_indices?: boolean @@ -53,13 +55,21 @@ interface IndicesFlushRequest extends < > { ignore_unavailable?: boolean wait_if_ongoing?: boolean } ----- +[pass] +++++ +
+++++ type IndicesFlushResponse = <+++++ diff --git a/docs/reference-indices-forcemerge.asciidoc b/docs/reference-indices-forcemerge.asciidoc index 2b542103f..34fbd2106 100644 --- a/docs/reference-indices-forcemerge.asciidoc +++ b/docs/reference-indices-forcemerge.asciidoc @@ -41,27 +41,37 @@ Performs the force merge operation on one or more indices. ---- [discrete] -===== `IndicesForcemergeRequest` +==== IndicesForcemergeRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IndicesForcemergeRequest extends <+++++ [discrete] -===== `IndicesForcemergeResponse` +==== IndicesForcemergeResponse -[source,ts] ----- +[pass] +++++ +> { index?: < > allow_no_indices?: boolean expand_wildcards?: < > flush?: boolean ignore_unavailable?: boolean - max_num_segments?: < > + max_num_segments?: number only_expunge_deletes?: boolean wait_for_completion?: boolean } ----- +[pass] +++++ +
+++++ type IndicesForcemergeResponse = IndicesForcemergeForceMergeResponseBody ----- +[pass] +++++ ++++++ diff --git a/docs/reference-indices-get.asciidoc b/docs/reference-indices-get.asciidoc index 3834a71b8..ab0ce1b7e 100644 --- a/docs/reference-indices-get.asciidoc +++ b/docs/reference-indices-get.asciidoc @@ -41,10 +41,12 @@ Get index information. Returns information about one or more indices. For data s ---- [discrete] -===== `IndicesGetRequest` +==== IndicesGetRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface IndicesGetRequest extends <+++++ [discrete] -===== `IndicesGetResponse` +==== IndicesGetResponse -[source,ts] ----- +[pass] +++++ +> { index: < > allow_no_indices?: boolean @@ -56,13 +58,21 @@ interface IndicesGetRequest extends < > { master_timeout?: < > features?: IndicesGetFeatures } ----- +[pass] +++++ +
+++++ type IndicesGetResponse = Record<<+++++ diff --git a/docs/reference-indices-get_alias.asciidoc b/docs/reference-indices-get_alias.asciidoc index ca16ce573..af68a248c 100644 --- a/docs/reference-indices-get_alias.asciidoc +++ b/docs/reference-indices-get_alias.asciidoc @@ -41,10 +41,12 @@ Get aliases. Retrieves information for one or more data stream or index aliases. ---- [discrete] -===== `IndicesGetAliasRequest` +==== IndicesGetAliasRequest -[source,ts] ----- +[pass] +++++ +>, IndicesIndexState> ----- +[pass] +++++ +
+++++ interface IndicesGetAliasRequest extends <+++++ [discrete] -===== `IndicesGetAliasResponse` +==== IndicesGetAliasResponse -[source,ts] ----- +[pass] +++++ +> { name?: < > index?: < > @@ -53,13 +55,21 @@ interface IndicesGetAliasRequest extends < > { ignore_unavailable?: boolean local?: boolean } ----- +[pass] +++++ +
+++++ type IndicesGetAliasResponse = Record<<+++++ diff --git a/docs/reference-indices-get_data_lifecycle.asciidoc b/docs/reference-indices-get_data_lifecycle.asciidoc index b5efebe51..31cefe140 100644 --- a/docs/reference-indices-get_data_lifecycle.asciidoc +++ b/docs/reference-indices-get_data_lifecycle.asciidoc @@ -41,25 +41,35 @@ Get data stream lifecycles. Retrieves the data stream lifecycle configuration of ---- [discrete] -===== `IndicesGetDataLifecycleRequest` +==== IndicesGetDataLifecycleRequest -[source,ts] ----- +[pass] +++++ +>, IndicesGetAliasIndexAliases> ----- +[pass] +++++ +
+++++ interface IndicesGetDataLifecycleRequest extends <+++++ [discrete] -===== `IndicesGetDataLifecycleResponse` +==== IndicesGetDataLifecycleResponse -[source,ts] ----- +[pass] +++++ +> { name: < > expand_wildcards?: < > include_defaults?: boolean master_timeout?: < > } ----- +[pass] +++++ +
+++++
interface IndicesGetDataLifecycleResponse {
data_streams: IndicesGetDataLifecycleDataStreamWithLifecycle[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-indices-get_data_stream.asciidoc b/docs/reference-indices-get_data_stream.asciidoc
index 8fe42fb73..1c12b6b89 100644
--- a/docs/reference-indices-get_data_stream.asciidoc
+++ b/docs/reference-indices-get_data_stream.asciidoc
@@ -41,10 +41,12 @@ Get data streams. Retrieves information about one or more data streams.
----
[discrete]
-===== `IndicesGetDataStreamRequest`
+==== IndicesGetDataStreamRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IndicesGetDataStreamRequest extends <+++++ [discrete] -===== `IndicesGetDataStreamResponse` +==== IndicesGetDataStreamResponse -[source,ts] ----- +[pass] +++++ +> { name?: < > expand_wildcards?: < > @@ -52,15 +54,23 @@ interface IndicesGetDataStreamRequest extends < > { master_timeout?: < > verbose?: boolean } ----- +[pass] +++++ +
+++++
interface IndicesGetDataStreamResponse {
data_streams: IndicesDataStream[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-indices-get_field_mapping.asciidoc b/docs/reference-indices-get_field_mapping.asciidoc
index a7fcf1e38..798f2ddbf 100644
--- a/docs/reference-indices-get_field_mapping.asciidoc
+++ b/docs/reference-indices-get_field_mapping.asciidoc
@@ -41,10 +41,12 @@ Get mapping definitions. Retrieves mapping definitions for one or more fields. F
----
[discrete]
-===== `IndicesGetFieldMappingRequest`
+==== IndicesGetFieldMappingRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IndicesGetFieldMappingRequest extends <+++++ [discrete] -===== `IndicesGetFieldMappingResponse` +==== IndicesGetFieldMappingResponse -[source,ts] ----- +[pass] +++++ +> { fields: < > index?: < > @@ -54,13 +56,21 @@ interface IndicesGetFieldMappingRequest extends < > { include_defaults?: boolean local?: boolean } ----- +[pass] +++++ +
+++++ type IndicesGetFieldMappingResponse = Record<<+++++ diff --git a/docs/reference-indices-get_index_template.asciidoc b/docs/reference-indices-get_index_template.asciidoc index a34459df3..fe4d7ea0e 100644 --- a/docs/reference-indices-get_index_template.asciidoc +++ b/docs/reference-indices-get_index_template.asciidoc @@ -41,10 +41,12 @@ Get index templates. Returns information about one or more index templates. ---- [discrete] -===== `IndicesGetIndexTemplateRequest` +==== IndicesGetIndexTemplateRequest -[source,ts] ----- +[pass] +++++ +>, IndicesGetFieldMappingTypeFieldMappings> ----- +[pass] +++++ +
+++++ interface IndicesGetIndexTemplateRequest extends <+++++ [discrete] -===== `IndicesGetIndexTemplateResponse` +==== IndicesGetIndexTemplateResponse -[source,ts] ----- +[pass] +++++ +> { name?: < > local?: boolean @@ -52,15 +54,23 @@ interface IndicesGetIndexTemplateRequest extends < > { master_timeout?: < > include_defaults?: boolean } ----- +[pass] +++++ +
+++++
interface IndicesGetIndexTemplateResponse {
index_templates: IndicesGetIndexTemplateIndexTemplateItem[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-indices-get_mapping.asciidoc b/docs/reference-indices-get_mapping.asciidoc
index 5771704b0..b9b6c8740 100644
--- a/docs/reference-indices-get_mapping.asciidoc
+++ b/docs/reference-indices-get_mapping.asciidoc
@@ -41,10 +41,12 @@ Get mapping definitions. Retrieves mapping definitions for one or more indices.
----
[discrete]
-===== `IndicesGetMappingRequest`
+==== IndicesGetMappingRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IndicesGetMappingRequest extends <+++++ [discrete] -===== `IndicesGetMappingResponse` +==== IndicesGetMappingResponse -[source,ts] ----- +[pass] +++++ +> { index?: < > allow_no_indices?: boolean @@ -53,13 +55,21 @@ interface IndicesGetMappingRequest extends < > { local?: boolean master_timeout?: < > } ----- +[pass] +++++ +
+++++ type IndicesGetMappingResponse = Record<<+++++ diff --git a/docs/reference-indices-get_settings.asciidoc b/docs/reference-indices-get_settings.asciidoc index 9298342b7..8197231c4 100644 --- a/docs/reference-indices-get_settings.asciidoc +++ b/docs/reference-indices-get_settings.asciidoc @@ -41,10 +41,12 @@ Get index settings. Returns setting information for one or more indices. For dat ---- [discrete] -===== `IndicesGetSettingsRequest` +==== IndicesGetSettingsRequest -[source,ts] ----- +[pass] +++++ +>, IndicesGetMappingIndexMappingRecord> ----- +[pass] +++++ +
+++++ interface IndicesGetSettingsRequest extends <+++++ [discrete] -===== `IndicesGetSettingsResponse` +==== IndicesGetSettingsResponse -[source,ts] ----- +[pass] +++++ +> { index?: < > name?: < > @@ -56,13 +58,21 @@ interface IndicesGetSettingsRequest extends < > { local?: boolean master_timeout?: < > } ----- +[pass] +++++ +
+++++ type IndicesGetSettingsResponse = Record<<+++++ diff --git a/docs/reference-indices-get_template.asciidoc b/docs/reference-indices-get_template.asciidoc index 06ee14ff0..8a6d2a0c2 100644 --- a/docs/reference-indices-get_template.asciidoc +++ b/docs/reference-indices-get_template.asciidoc @@ -41,23 +41,33 @@ Get index templates. Retrieves information about one or more index templates. ---- [discrete] -===== `IndicesGetTemplateRequest` +==== IndicesGetTemplateRequest -[source,ts] ----- +[pass] +++++ +>, IndicesIndexState> ----- +[pass] +++++ +
+++++ interface IndicesGetTemplateRequest extends <+++++ [discrete] -===== `IndicesGetTemplateResponse` +==== IndicesGetTemplateResponse -[source,ts] ----- +[pass] +++++ +> { name?: < > flat_settings?: boolean local?: boolean master_timeout?: < > } ----- +[pass] +++++ +
+++++ type IndicesGetTemplateResponse = Record+++++ diff --git a/docs/reference-indices-migrate_to_data_stream.asciidoc b/docs/reference-indices-migrate_to_data_stream.asciidoc index 648e109c4..5274f471a 100644 --- a/docs/reference-indices-migrate_to_data_stream.asciidoc +++ b/docs/reference-indices-migrate_to_data_stream.asciidoc @@ -41,22 +41,32 @@ Convert an index alias to a data stream. Converts an index alias to a data strea ---- [discrete] -===== `IndicesMigrateToDataStreamRequest` +==== IndicesMigrateToDataStreamRequest -[source,ts] ----- +[pass] +++++ +----- +[pass] +++++ +
+++++ interface IndicesMigrateToDataStreamRequest extends <+++++ [discrete] -===== `IndicesMigrateToDataStreamResponse` +==== IndicesMigrateToDataStreamResponse -[source,ts] ----- +[pass] +++++ +> { name: < > master_timeout?: < > timeout?: < > } ----- +[pass] +++++ +
+++++ type IndicesMigrateToDataStreamResponse = <+++++ diff --git a/docs/reference-indices-modify_data_stream.asciidoc b/docs/reference-indices-modify_data_stream.asciidoc index dc78a293c..52b6c8e4f 100644 --- a/docs/reference-indices-modify_data_stream.asciidoc +++ b/docs/reference-indices-modify_data_stream.asciidoc @@ -41,20 +41,30 @@ Update data streams. Performs one or more data stream modification actions in a ---- [discrete] -===== `IndicesModifyDataStreamRequest` +==== IndicesModifyDataStreamRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IndicesModifyDataStreamRequest extends <+++++ [discrete] -===== `IndicesModifyDataStreamResponse` +==== IndicesModifyDataStreamResponse -[source,ts] ----- +[pass] +++++ +> { actions: IndicesModifyDataStreamAction[] } ----- +[pass] +++++ +
+++++ type IndicesModifyDataStreamResponse = <+++++ diff --git a/docs/reference-indices-open.asciidoc b/docs/reference-indices-open.asciidoc index 275d6e05a..970ffeccd 100644 --- a/docs/reference-indices-open.asciidoc +++ b/docs/reference-indices-open.asciidoc @@ -41,10 +41,12 @@ Opens a closed index. For data streams, the API opens any closed backing indices ---- [discrete] -===== `IndicesOpenRequest` +==== IndicesOpenRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IndicesOpenRequest extends <+++++ [discrete] -===== `IndicesOpenResponse` +==== IndicesOpenResponse -[source,ts] ----- +[pass] +++++ +> { index: < > allow_no_indices?: boolean @@ -54,16 +56,24 @@ interface IndicesOpenRequest extends < > { timeout?: < > wait_for_active_shards?: < > } ----- +[pass] +++++ +
+++++
interface IndicesOpenResponse {
acknowledged: boolean
shards_acknowledged: boolean
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-indices-promote_data_stream.asciidoc b/docs/reference-indices-promote_data_stream.asciidoc
index 9e9b30ceb..a4392e6b8 100644
--- a/docs/reference-indices-promote_data_stream.asciidoc
+++ b/docs/reference-indices-promote_data_stream.asciidoc
@@ -41,21 +41,31 @@ Promotes a data stream from a replicated data stream managed by CCR to a regular
----
[discrete]
-===== `IndicesPromoteDataStreamRequest`
+==== IndicesPromoteDataStreamRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IndicesPromoteDataStreamRequest extends <+++++ [discrete] -===== `IndicesPromoteDataStreamResponse` +==== IndicesPromoteDataStreamResponse -[source,ts] ----- +[pass] +++++ +> { name: < > master_timeout?: < > } ----- +[pass] +++++ +
+++++ type IndicesPromoteDataStreamResponse = any ----- +[pass] +++++ ++++++ diff --git a/docs/reference-indices-put_alias.asciidoc b/docs/reference-indices-put_alias.asciidoc index 132bbc268..6b47fb75b 100644 --- a/docs/reference-indices-put_alias.asciidoc +++ b/docs/reference-indices-put_alias.asciidoc @@ -41,10 +41,12 @@ Create or update an alias. Adds a data stream or index to an alias. ---- [discrete] -===== `IndicesPutAliasRequest` +==== IndicesPutAliasRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface IndicesPutAliasRequest extends <+++++ [discrete] -===== `IndicesPutAliasResponse` +==== IndicesPutAliasResponse -[source,ts] ----- +[pass] +++++ +> { index: < > name: < > @@ -56,13 +58,21 @@ interface IndicesPutAliasRequest extends < > { routing?: < > search_routing?: < > } ----- +[pass] +++++ +
+++++ type IndicesPutAliasResponse = <+++++ diff --git a/docs/reference-indices-put_data_lifecycle.asciidoc b/docs/reference-indices-put_data_lifecycle.asciidoc index 65c278d07..c8b224904 100644 --- a/docs/reference-indices-put_data_lifecycle.asciidoc +++ b/docs/reference-indices-put_data_lifecycle.asciidoc @@ -41,10 +41,12 @@ Update data stream lifecycles. Update the data stream lifecycle of the specified ---- [discrete] -===== `IndicesPutDataLifecycleRequest` +==== IndicesPutDataLifecycleRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IndicesPutDataLifecycleRequest extends <+++++ [discrete] -===== `IndicesPutDataLifecycleResponse` +==== IndicesPutDataLifecycleResponse -[source,ts] ----- +[pass] +++++ +> { name: < > expand_wildcards?: < > @@ -53,13 +55,21 @@ interface IndicesPutDataLifecycleRequest extends < > { data_retention?: < > downsampling?: IndicesDataStreamLifecycleDownsampling } ----- +[pass] +++++ +
+++++ type IndicesPutDataLifecycleResponse = <+++++ diff --git a/docs/reference-indices-put_index_template.asciidoc b/docs/reference-indices-put_index_template.asciidoc index ec471728f..67c8c88fe 100644 --- a/docs/reference-indices-put_index_template.asciidoc +++ b/docs/reference-indices-put_index_template.asciidoc @@ -41,10 +41,12 @@ Create or update an index template. Index templates define settings, mappings, a ---- [discrete] -===== `IndicesPutIndexTemplateRequest` +==== IndicesPutIndexTemplateRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IndicesPutIndexTemplateRequest extends <+++++ [discrete] -===== `IndicesPutIndexTemplateResponse` +==== IndicesPutIndexTemplateResponse -[source,ts] ----- +[pass] +++++ +> { name: < > create?: boolean @@ -54,20 +56,28 @@ interface IndicesPutIndexTemplateRequest extends < > { composed_of?: < >[] template?: IndicesPutIndexTemplateIndexTemplateMapping data_stream?: IndicesDataStreamVisibility - priority?: < > + priority?: number version?: < > _meta?: < > allow_auto_create?: boolean ignore_missing_component_templates?: string[] deprecated?: boolean } ----- +[pass] +++++ +
+++++ type IndicesPutIndexTemplateResponse = <+++++ diff --git a/docs/reference-indices-put_mapping.asciidoc b/docs/reference-indices-put_mapping.asciidoc index afb8d687f..78f058df4 100644 --- a/docs/reference-indices-put_mapping.asciidoc +++ b/docs/reference-indices-put_mapping.asciidoc @@ -41,10 +41,12 @@ Update field mappings. Adds new fields to an existing data stream or index. You ---- [discrete] -===== `IndicesPutMappingRequest` +==== IndicesPutMappingRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IndicesPutMappingRequest extends <+++++ [discrete] -===== `IndicesPutMappingResponse` +==== IndicesPutMappingResponse -[source,ts] ----- +[pass] +++++ +> { index: < > allow_no_indices?: boolean @@ -65,13 +67,21 @@ interface IndicesPutMappingRequest extends < > { _source?: MappingSourceField runtime?: MappingRuntimeFields } ----- +[pass] +++++ +
+++++ type IndicesPutMappingResponse = <+++++ diff --git a/docs/reference-indices-put_settings.asciidoc b/docs/reference-indices-put_settings.asciidoc index 9fe0434f8..a6a74f3ba 100644 --- a/docs/reference-indices-put_settings.asciidoc +++ b/docs/reference-indices-put_settings.asciidoc @@ -41,10 +41,12 @@ Update index settings. Changes dynamic index settings in real time. For data str ---- [discrete] -===== `IndicesPutSettingsRequest` +==== IndicesPutSettingsRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IndicesPutSettingsRequest extends <+++++ [discrete] -===== `IndicesPutSettingsResponse` +==== IndicesPutSettingsResponse -[source,ts] ----- +[pass] +++++ +> { index?: < > allow_no_indices?: boolean @@ -56,13 +58,21 @@ interface IndicesPutSettingsRequest extends < > { timeout?: < > settings?: IndicesIndexSettings } ----- +[pass] +++++ +
+++++ type IndicesPutSettingsResponse = <+++++ diff --git a/docs/reference-indices-put_template.asciidoc b/docs/reference-indices-put_template.asciidoc index d06e375fd..36ea8c7af 100644 --- a/docs/reference-indices-put_template.asciidoc +++ b/docs/reference-indices-put_template.asciidoc @@ -41,10 +41,12 @@ Create or update an index template. Index templates define settings, mappings, a ---- [discrete] -===== `IndicesPutTemplateRequest` +==== IndicesPutTemplateRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IndicesPutTemplateRequest extends <+++++ [discrete] -===== `IndicesPutTemplateResponse` +==== IndicesPutTemplateResponse -[source,ts] ----- +[pass] +++++ +> { name: < > create?: boolean @@ -53,17 +55,25 @@ interface IndicesPutTemplateRequest extends < > { aliases?: Record<< >, IndicesAlias> index_patterns?: string | string[] mappings?: MappingTypeMapping - order?: < > + order?: number settings?: IndicesIndexSettings version?: < > } ----- +[pass] +++++ +
+++++ type IndicesPutTemplateResponse = <+++++ diff --git a/docs/reference-indices-recovery.asciidoc b/docs/reference-indices-recovery.asciidoc index 111663f08..e1432b639 100644 --- a/docs/reference-indices-recovery.asciidoc +++ b/docs/reference-indices-recovery.asciidoc @@ -41,22 +41,32 @@ Returns information about ongoing and completed shard recoveries for one or more ---- [discrete] -===== `IndicesRecoveryRequest` +==== IndicesRecoveryRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IndicesRecoveryRequest extends <+++++ [discrete] -===== `IndicesRecoveryResponse` +==== IndicesRecoveryResponse -[source,ts] ----- +[pass] +++++ +> { index?: < > active_only?: boolean detailed?: boolean } ----- +[pass] +++++ +
+++++ type IndicesRecoveryResponse = Record<<+++++ diff --git a/docs/reference-indices-refresh.asciidoc b/docs/reference-indices-refresh.asciidoc index f96305064..57af9a9b9 100644 --- a/docs/reference-indices-refresh.asciidoc +++ b/docs/reference-indices-refresh.asciidoc @@ -41,23 +41,33 @@ Refresh an index. A refresh makes recent operations performed on one or more ind ---- [discrete] -===== `IndicesRefreshRequest` +==== IndicesRefreshRequest -[source,ts] ----- +[pass] +++++ +>, IndicesRecoveryRecoveryStatus> ----- +[pass] +++++ +
+++++ interface IndicesRefreshRequest extends <+++++ [discrete] -===== `IndicesRefreshResponse` +==== IndicesRefreshResponse -[source,ts] ----- +[pass] +++++ +> { index?: < > allow_no_indices?: boolean expand_wildcards?: < > ignore_unavailable?: boolean } ----- +[pass] +++++ +
+++++ type IndicesRefreshResponse = <+++++ diff --git a/docs/reference-indices-reload_search_analyzers.asciidoc b/docs/reference-indices-reload_search_analyzers.asciidoc index c07a2b5c8..9b32f5979 100644 --- a/docs/reference-indices-reload_search_analyzers.asciidoc +++ b/docs/reference-indices-reload_search_analyzers.asciidoc @@ -41,23 +41,33 @@ Reloads an index's search analyzers and their resources. ---- [discrete] -===== `IndicesReloadSearchAnalyzersRequest` +==== IndicesReloadSearchAnalyzersRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IndicesReloadSearchAnalyzersRequest extends <+++++ [discrete] -===== `IndicesReloadSearchAnalyzersResponse` +==== IndicesReloadSearchAnalyzersResponse -[source,ts] ----- +[pass] +++++ +> { index: < > allow_no_indices?: boolean expand_wildcards?: < > ignore_unavailable?: boolean } ----- +[pass] +++++ +
+++++ type IndicesReloadSearchAnalyzersResponse = IndicesReloadSearchAnalyzersReloadResult ----- +[pass] +++++ ++++++ diff --git a/docs/reference-indices-resolve_cluster.asciidoc b/docs/reference-indices-resolve_cluster.asciidoc index be0275a09..b77625af1 100644 --- a/docs/reference-indices-resolve_cluster.asciidoc +++ b/docs/reference-indices-resolve_cluster.asciidoc @@ -41,10 +41,12 @@ Resolves the specified index expressions to return information about each cluste ---- [discrete] -===== `IndicesResolveClusterRequest` +==== IndicesResolveClusterRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface IndicesResolveClusterRequest extends <+++++ [discrete] -===== `IndicesResolveClusterResponse` +==== IndicesResolveClusterResponse -[source,ts] ----- +[pass] +++++ +> { name: < > allow_no_indices?: boolean @@ -52,13 +54,21 @@ interface IndicesResolveClusterRequest extends < > { ignore_throttled?: boolean ignore_unavailable?: boolean } ----- +[pass] +++++ +
+++++ type IndicesResolveClusterResponse = Record<<+++++ diff --git a/docs/reference-indices-resolve_index.asciidoc b/docs/reference-indices-resolve_index.asciidoc index c8561b32a..8dc6e3de9 100644 --- a/docs/reference-indices-resolve_index.asciidoc +++ b/docs/reference-indices-resolve_index.asciidoc @@ -41,27 +41,37 @@ Resolves the specified name(s) and/or index patterns for indices, aliases, and d ---- [discrete] -===== `IndicesResolveIndexRequest` +==== IndicesResolveIndexRequest -[source,ts] ----- +[pass] +++++ +>, IndicesResolveClusterResolveClusterInfo> ----- +[pass] +++++ +
+++++ interface IndicesResolveIndexRequest extends <+++++ [discrete] -===== `IndicesResolveIndexResponse` +==== IndicesResolveIndexResponse -[source,ts] ----- +[pass] +++++ +> { name: < > expand_wildcards?: < > ignore_unavailable?: boolean allow_no_indices?: boolean } ----- +[pass] +++++ +
+++++
interface IndicesResolveIndexResponse {
indices: IndicesResolveIndexResolveIndexItem[]
aliases: IndicesResolveIndexResolveIndexAliasItem[]
data_streams: IndicesResolveIndexResolveIndexDataStreamsItem[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-indices-rollover.asciidoc b/docs/reference-indices-rollover.asciidoc
index ac0acc3a1..5b308030f 100644
--- a/docs/reference-indices-rollover.asciidoc
+++ b/docs/reference-indices-rollover.asciidoc
@@ -41,10 +41,12 @@ Roll over to a new index. Creates a new index for a data stream or index alias.
----
[discrete]
-===== `IndicesRolloverRequest`
+==== IndicesRolloverRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IndicesRolloverRequest extends <+++++ [discrete] -===== `IndicesRolloverResponse` +==== IndicesRolloverResponse -[source,ts] ----- +[pass] +++++ +> { alias: < > new_index?: < > @@ -57,13 +59,18 @@ interface IndicesRolloverRequest extends < > { mappings?: MappingTypeMapping settings?: Record } ----- +[pass] +++++ +
+++++
interface IndicesRolloverResponse {
acknowledged: boolean
conditions: Record
@@ -73,5 +80,8 @@ interface IndicesRolloverResponse {
rolled_over: boolean
shards_acknowledged: boolean
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-indices-segments.asciidoc b/docs/reference-indices-segments.asciidoc
index 5de594def..856972506 100644
--- a/docs/reference-indices-segments.asciidoc
+++ b/docs/reference-indices-segments.asciidoc
@@ -41,10 +41,12 @@ Returns low-level information about the Lucene segments in index shards. For dat
----
[discrete]
-===== `IndicesSegmentsRequest`
+==== IndicesSegmentsRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IndicesSegmentsRequest extends <+++++ [discrete] -===== `IndicesSegmentsResponse` +==== IndicesSegmentsResponse -[source,ts] ----- +[pass] +++++ +> { index?: < > allow_no_indices?: boolean @@ -52,16 +54,24 @@ interface IndicesSegmentsRequest extends < > { ignore_unavailable?: boolean verbose?: boolean } ----- +[pass] +++++ +
+++++
interface IndicesSegmentsResponse {
indices: Record
_shards: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-indices-shard_stores.asciidoc b/docs/reference-indices-shard_stores.asciidoc
index 55347b494..d7d172ffa 100644
--- a/docs/reference-indices-shard_stores.asciidoc
+++ b/docs/reference-indices-shard_stores.asciidoc
@@ -41,10 +41,12 @@ Retrieves store information about replica shards in one or more indices. For dat
----
[discrete]
-===== `IndicesShardStoresRequest`
+==== IndicesShardStoresRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IndicesShardStoresRequest extends <+++++ [discrete] -===== `IndicesShardStoresResponse` +==== IndicesShardStoresResponse -[source,ts] ----- +[pass] +++++ +> { index?: < > allow_no_indices?: boolean @@ -52,15 +54,23 @@ interface IndicesShardStoresRequest extends < > { ignore_unavailable?: boolean status?: IndicesShardStoresShardStoreStatus | IndicesShardStoresShardStoreStatus[] } ----- +[pass] +++++ +
+++++
interface IndicesShardStoresResponse {
indices: Record<<>, IndicesShardStoresIndicesShardStores>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-indices-shrink.asciidoc b/docs/reference-indices-shrink.asciidoc
index 96f0717d4..c43f1652b 100644
--- a/docs/reference-indices-shrink.asciidoc
+++ b/docs/reference-indices-shrink.asciidoc
@@ -41,10 +41,12 @@ Shrinks an existing index into a new index with fewer primary shards.
----
[discrete]
-===== `IndicesShrinkRequest`
+==== IndicesShrinkRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IndicesShrinkRequest extends <+++++ [discrete] -===== `IndicesShrinkResponse` +==== IndicesShrinkResponse -[source,ts] ----- +[pass] +++++ +> { index: < > target: < > @@ -54,17 +56,25 @@ interface IndicesShrinkRequest extends < > { aliases?: Record<< >, IndicesAlias> settings?: Record } ----- +[pass] +++++ +
+++++
interface IndicesShrinkResponse {
acknowledged: boolean
shards_acknowledged: boolean
index: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-indices-simulate_index_template.asciidoc b/docs/reference-indices-simulate_index_template.asciidoc
index 27d031b63..118044e31 100644
--- a/docs/reference-indices-simulate_index_template.asciidoc
+++ b/docs/reference-indices-simulate_index_template.asciidoc
@@ -41,25 +41,35 @@ Simulate an index. Returns the index configuration that would be applied to the
----
[discrete]
-===== `IndicesSimulateIndexTemplateRequest`
+==== IndicesSimulateIndexTemplateRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IndicesSimulateIndexTemplateRequest extends <+++++ [discrete] -===== `IndicesSimulateIndexTemplateResponse` +==== IndicesSimulateIndexTemplateResponse -[source,ts] ----- +[pass] +++++ +> { name: < > master_timeout?: < > include_defaults?: boolean } ----- +[pass] +++++ +
+++++
interface IndicesSimulateIndexTemplateResponse {
overlapping?: IndicesSimulateTemplateOverlapping[]
template: IndicesSimulateTemplateTemplate
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-indices-simulate_template.asciidoc b/docs/reference-indices-simulate_template.asciidoc
index 9ea9eb8bd..ff4498031 100644
--- a/docs/reference-indices-simulate_template.asciidoc
+++ b/docs/reference-indices-simulate_template.asciidoc
@@ -41,10 +41,12 @@ Simulate an index template. Returns the index configuration that would be applie
----
[discrete]
-===== `IndicesSimulateTemplateRequest`
+==== IndicesSimulateTemplateRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IndicesSimulateTemplateRequest extends <+++++ [discrete] -===== `IndicesSimulateTemplateResponse` +==== IndicesSimulateTemplateResponse -[source,ts] ----- +[pass] +++++ +> { name?: < > create?: boolean @@ -55,22 +57,30 @@ interface IndicesSimulateTemplateRequest extends < > { composed_of?: < >[] template?: IndicesPutIndexTemplateIndexTemplateMapping data_stream?: IndicesDataStreamVisibility - priority?: < > + priority?: number version?: < > _meta?: < > ignore_missing_component_templates?: string[] deprecated?: boolean } ----- +[pass] +++++ +
+++++
interface IndicesSimulateTemplateResponse {
overlapping?: IndicesSimulateTemplateOverlapping[]
template: IndicesSimulateTemplateTemplate
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-indices-split.asciidoc b/docs/reference-indices-split.asciidoc
index 761d114e6..6f5b42e25 100644
--- a/docs/reference-indices-split.asciidoc
+++ b/docs/reference-indices-split.asciidoc
@@ -41,10 +41,12 @@ Splits an existing index into a new index with more primary shards.
----
[discrete]
-===== `IndicesSplitRequest`
+==== IndicesSplitRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IndicesSplitRequest extends <+++++ [discrete] -===== `IndicesSplitResponse` +==== IndicesSplitResponse -[source,ts] ----- +[pass] +++++ +> { index: < > target: < > @@ -54,17 +56,25 @@ interface IndicesSplitRequest extends < > { aliases?: Record<< >, IndicesAlias> settings?: Record } ----- +[pass] +++++ +
+++++
interface IndicesSplitResponse {
acknowledged: boolean
shards_acknowledged: boolean
index: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-indices-stats.asciidoc b/docs/reference-indices-stats.asciidoc
index d22753e4e..91eb3584f 100644
--- a/docs/reference-indices-stats.asciidoc
+++ b/docs/reference-indices-stats.asciidoc
@@ -41,10 +41,12 @@ Returns statistics for one or more indices. For data streams, the API retrieves
----
[discrete]
-===== `IndicesStatsRequest`
+==== IndicesStatsRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IndicesStatsRequest extends <+++++ [discrete] -===== `IndicesStatsResponse` +==== IndicesStatsResponse -[source,ts] ----- +[pass] +++++ +> { metric?: < > index?: < > @@ -58,17 +60,25 @@ interface IndicesStatsRequest extends < > { include_unloaded_segments?: boolean level?: < > } ----- +[pass] +++++ +
+++++
interface IndicesStatsResponse {
indices?: Record
_shards: <>
_all: IndicesStatsIndicesStats
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-indices-unfreeze.asciidoc b/docs/reference-indices-unfreeze.asciidoc
index f7a210f7b..fc3b34872 100644
--- a/docs/reference-indices-unfreeze.asciidoc
+++ b/docs/reference-indices-unfreeze.asciidoc
@@ -41,10 +41,12 @@ Unfreezes an index.
----
[discrete]
-===== `IndicesUnfreezeRequest`
+==== IndicesUnfreezeRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IndicesUnfreezeRequest extends <+++++ [discrete] -===== `IndicesUnfreezeResponse` +==== IndicesUnfreezeResponse -[source,ts] ----- +[pass] +++++ +> { index: < > allow_no_indices?: boolean @@ -54,16 +56,24 @@ interface IndicesUnfreezeRequest extends < > { timeout?: < > wait_for_active_shards?: string } ----- +[pass] +++++ +
+++++
interface IndicesUnfreezeResponse {
acknowledged: boolean
shards_acknowledged: boolean
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-indices-update_aliases.asciidoc b/docs/reference-indices-update_aliases.asciidoc
index d2df15f7c..97153713c 100644
--- a/docs/reference-indices-update_aliases.asciidoc
+++ b/docs/reference-indices-update_aliases.asciidoc
@@ -41,22 +41,32 @@ Create or update an alias. Adds a data stream or index to an alias.
----
[discrete]
-===== `IndicesUpdateAliasesRequest`
+==== IndicesUpdateAliasesRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IndicesUpdateAliasesRequest extends <+++++ [discrete] -===== `IndicesUpdateAliasesResponse` +==== IndicesUpdateAliasesResponse -[source,ts] ----- +[pass] +++++ +> { master_timeout?: < > timeout?: < > actions?: IndicesUpdateAliasesAction[] } ----- +[pass] +++++ +
+++++ type IndicesUpdateAliasesResponse = <+++++ diff --git a/docs/reference-indices-validate_query.asciidoc b/docs/reference-indices-validate_query.asciidoc index c9188c8ce..999ff301f 100644 --- a/docs/reference-indices-validate_query.asciidoc +++ b/docs/reference-indices-validate_query.asciidoc @@ -41,10 +41,12 @@ Validate a query. Validates a query without running it. ---- [discrete] -===== `IndicesValidateQueryRequest` +==== IndicesValidateQueryRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IndicesValidateQueryRequest extends <+++++ [discrete] -===== `IndicesValidateQueryResponse` +==== IndicesValidateQueryResponse -[source,ts] ----- +[pass] +++++ +> { index?: < > allow_no_indices?: boolean @@ -61,18 +63,26 @@ interface IndicesValidateQueryRequest extends < > { q?: string query?: QueryDslQueryContainer } ----- +[pass] +++++ +
+++++
interface IndicesValidateQueryResponse {
explanations?: IndicesValidateQueryIndicesValidationExplanation[]
_shards?: <>
valid: boolean
error?: string
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-inference-delete.asciidoc b/docs/reference-inference-delete.asciidoc
index d21954153..41a2cbe9f 100644
--- a/docs/reference-inference-delete.asciidoc
+++ b/docs/reference-inference-delete.asciidoc
@@ -41,23 +41,33 @@ Delete an inference endpoint
----
[discrete]
-===== `InferenceDeleteRequest`
+==== InferenceDeleteRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface InferenceDeleteRequest extends <+++++ [discrete] -===== `InferenceDeleteResponse` +==== InferenceDeleteResponse -[source,ts] ----- +[pass] +++++ +> { task_type?: InferenceTaskType inference_id: < > dry_run?: boolean force?: boolean } ----- +[pass] +++++ +
+++++ type InferenceDeleteResponse = InferenceDeleteInferenceEndpointResult ----- +[pass] +++++ ++++++ diff --git a/docs/reference-inference-get.asciidoc b/docs/reference-inference-get.asciidoc index 22febeae4..07d23b74b 100644 --- a/docs/reference-inference-get.asciidoc +++ b/docs/reference-inference-get.asciidoc @@ -41,23 +41,33 @@ Get an inference endpoint ---- [discrete] -===== `InferenceGetRequest` +==== InferenceGetRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface InferenceGetRequest extends <+++++ [discrete] -===== `InferenceGetResponse` +==== InferenceGetResponse -[source,ts] ----- +[pass] +++++ +> { task_type?: InferenceTaskType inference_id?: < > } ----- +[pass] +++++ +
+++++
interface InferenceGetResponse {
endpoints: InferenceInferenceEndpointInfo[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-inference-inference.asciidoc b/docs/reference-inference-inference.asciidoc
index bc19290ea..215604029 100644
--- a/docs/reference-inference-inference.asciidoc
+++ b/docs/reference-inference-inference.asciidoc
@@ -41,10 +41,12 @@ Perform inference on the service
----
[discrete]
-===== `InferenceInferenceRequest`
+==== InferenceInferenceRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface InferenceInferenceRequest extends <+++++ [discrete] -===== `InferenceInferenceResponse` +==== InferenceInferenceResponse -[source,ts] ----- +[pass] +++++ +> { task_type?: InferenceTaskType inference_id: < > @@ -53,13 +55,21 @@ interface InferenceInferenceRequest extends < > { input: string | string[] task_settings?: InferenceTaskSettings } ----- +[pass] +++++ +
+++++ type InferenceInferenceResponse = InferenceInferenceResult ----- +[pass] +++++ ++++++ diff --git a/docs/reference-inference-put.asciidoc b/docs/reference-inference-put.asciidoc index ba73f5a85..bc3e9fe8f 100644 --- a/docs/reference-inference-put.asciidoc +++ b/docs/reference-inference-put.asciidoc @@ -41,22 +41,32 @@ Create an inference endpoint ---- [discrete] -===== `InferencePutRequest` +==== InferencePutRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface InferencePutRequest extends <+++++ [discrete] -===== `InferencePutResponse` +==== InferencePutResponse -[source,ts] ----- +[pass] +++++ +> { task_type?: InferenceTaskType inference_id: < > inference_config?: InferenceInferenceEndpoint } ----- +[pass] +++++ +
+++++ type InferencePutResponse = InferenceInferenceEndpointInfo ----- +[pass] +++++ ++++++ diff --git a/docs/reference-inference-stream_inference.asciidoc b/docs/reference-inference-stream_inference.asciidoc index 184054640..9eaf3fc0e 100644 --- a/docs/reference-inference-stream_inference.asciidoc +++ b/docs/reference-inference-stream_inference.asciidoc @@ -38,20 +38,3 @@ Perform streaming inference (InferenceStreamInferenceRequest, options?): Promise
+++++ interface InfoRequest extends <+++++ [discrete] -===== `InfoResponse` +==== InfoResponse -[source,ts] ----- +[pass] +++++ +> { } ----- +[pass] +++++ +
+++++
interface InfoResponse {
cluster_name: <>
cluster_uuid: <>
@@ -61,5 +68,8 @@ interface InfoResponse {
tagline: string
version: <>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-ingest-delete_geoip_database.asciidoc b/docs/reference-ingest-delete_geoip_database.asciidoc
index 8953a983b..fb2ba794c 100644
--- a/docs/reference-ingest-delete_geoip_database.asciidoc
+++ b/docs/reference-ingest-delete_geoip_database.asciidoc
@@ -41,22 +41,32 @@ Deletes a geoip database configuration.
----
[discrete]
-===== `IngestDeleteGeoipDatabaseRequest`
+==== IngestDeleteGeoipDatabaseRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IngestDeleteGeoipDatabaseRequest extends <+++++ [discrete] -===== `IngestDeleteGeoipDatabaseResponse` +==== IngestDeleteGeoipDatabaseResponse -[source,ts] ----- +[pass] +++++ +> { id: < > master_timeout?: < > timeout?: < > } ----- +[pass] +++++ +
+++++ type IngestDeleteGeoipDatabaseResponse = <+++++ diff --git a/docs/reference-ingest-delete_pipeline.asciidoc b/docs/reference-ingest-delete_pipeline.asciidoc index 9f70eb5d6..c6387b125 100644 --- a/docs/reference-ingest-delete_pipeline.asciidoc +++ b/docs/reference-ingest-delete_pipeline.asciidoc @@ -41,22 +41,32 @@ Deletes one or more existing ingest pipeline. ---- [discrete] -===== `IngestDeletePipelineRequest` +==== IngestDeletePipelineRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IngestDeletePipelineRequest extends <+++++ [discrete] -===== `IngestDeletePipelineResponse` +==== IngestDeletePipelineResponse -[source,ts] ----- +[pass] +++++ +> { id: < > master_timeout?: < > timeout?: < > } ----- +[pass] +++++ +
+++++ type IngestDeletePipelineResponse = <+++++ diff --git a/docs/reference-ingest-geo_ip_stats.asciidoc b/docs/reference-ingest-geo_ip_stats.asciidoc index 3288a67f6..6c419f0aa 100644 --- a/docs/reference-ingest-geo_ip_stats.asciidoc +++ b/docs/reference-ingest-geo_ip_stats.asciidoc @@ -41,22 +41,32 @@ Gets download statistics for GeoIP2 databases used with the geoip processor. ---- [discrete] -===== `IngestGeoIpStatsRequest` +==== IngestGeoIpStatsRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IngestGeoIpStatsRequest extends <+++++ [discrete] -===== `IngestGeoIpStatsResponse` +==== IngestGeoIpStatsResponse -[source,ts] ----- +[pass] +++++ +> { } ----- +[pass] +++++ +
+++++
interface IngestGeoIpStatsResponse {
stats: IngestGeoIpStatsGeoIpDownloadStatistics
nodes: Record<<>, IngestGeoIpStatsGeoIpNodeDatabases>
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-ingest-get_geoip_database.asciidoc b/docs/reference-ingest-get_geoip_database.asciidoc
index bbe581a36..041719496 100644
--- a/docs/reference-ingest-get_geoip_database.asciidoc
+++ b/docs/reference-ingest-get_geoip_database.asciidoc
@@ -41,23 +41,33 @@ Returns information about one or more geoip database configurations.
----
[discrete]
-===== `IngestGetGeoipDatabaseRequest`
+==== IngestGetGeoipDatabaseRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IngestGetGeoipDatabaseRequest extends <+++++ [discrete] -===== `IngestGetGeoipDatabaseResponse` +==== IngestGetGeoipDatabaseResponse -[source,ts] ----- +[pass] +++++ +> { id?: < > master_timeout?: < > } ----- +[pass] +++++ +
+++++
interface IngestGetGeoipDatabaseResponse {
databases: IngestGetGeoipDatabaseDatabaseConfigurationMetadata[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-ingest-get_pipeline.asciidoc b/docs/reference-ingest-get_pipeline.asciidoc
index 1e725e195..9ac8b6f3e 100644
--- a/docs/reference-ingest-get_pipeline.asciidoc
+++ b/docs/reference-ingest-get_pipeline.asciidoc
@@ -41,22 +41,32 @@ Returns information about one or more ingest pipelines. This API returns a local
----
[discrete]
-===== `IngestGetPipelineRequest`
+==== IngestGetPipelineRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IngestGetPipelineRequest extends <+++++ [discrete] -===== `IngestGetPipelineResponse` +==== IngestGetPipelineResponse -[source,ts] ----- +[pass] +++++ +> { id?: < > master_timeout?: < > summary?: boolean } ----- +[pass] +++++ +
+++++ type IngestGetPipelineResponse = Record+++++ diff --git a/docs/reference-ingest-processor_grok.asciidoc b/docs/reference-ingest-processor_grok.asciidoc index d51ae5c3f..17919199c 100644 --- a/docs/reference-ingest-processor_grok.asciidoc +++ b/docs/reference-ingest-processor_grok.asciidoc @@ -41,21 +41,31 @@ Extracts structured fields out of a single text field within a document. You cho ---- [discrete] -===== `IngestProcessorGrokRequest` +==== IngestProcessorGrokRequest -[source,ts] ----- +[pass] +++++ +----- +[pass] +++++ +
+++++ interface IngestProcessorGrokRequest extends <+++++ [discrete] -===== `IngestProcessorGrokResponse` +==== IngestProcessorGrokResponse -[source,ts] ----- +[pass] +++++ +> { } ----- +[pass] +++++ +
+++++
interface IngestProcessorGrokResponse {
patterns: Record
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-ingest-put_geoip_database.asciidoc b/docs/reference-ingest-put_geoip_database.asciidoc
index 54f71fa39..ae7e37a0e 100644
--- a/docs/reference-ingest-put_geoip_database.asciidoc
+++ b/docs/reference-ingest-put_geoip_database.asciidoc
@@ -41,10 +41,12 @@ Returns information about one or more geoip database configurations.
----
[discrete]
-===== `IngestPutGeoipDatabaseRequest`
+==== IngestPutGeoipDatabaseRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface IngestPutGeoipDatabaseRequest extends <+++++ [discrete] -===== `IngestPutGeoipDatabaseResponse` +==== IngestPutGeoipDatabaseResponse -[source,ts] ----- +[pass] +++++ +> { id: < > master_timeout?: < > @@ -52,13 +54,21 @@ interface IngestPutGeoipDatabaseRequest extends < > { name: < > maxmind: IngestMaxmind } ----- +[pass] +++++ +
+++++ type IngestPutGeoipDatabaseResponse = <+++++ diff --git a/docs/reference-ingest-put_pipeline.asciidoc b/docs/reference-ingest-put_pipeline.asciidoc index 44aa2e00c..ead07aa14 100644 --- a/docs/reference-ingest-put_pipeline.asciidoc +++ b/docs/reference-ingest-put_pipeline.asciidoc @@ -41,10 +41,12 @@ Creates or updates an ingest pipeline. Changes made using this API take effect i ---- [discrete] -===== `IngestPutPipelineRequest` +==== IngestPutPipelineRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IngestPutPipelineRequest extends <+++++ [discrete] -===== `IngestPutPipelineResponse` +==== IngestPutPipelineResponse -[source,ts] ----- +[pass] +++++ +> { id: < > master_timeout?: < > @@ -57,13 +59,21 @@ interface IngestPutPipelineRequest extends < > { version?: < > deprecated?: boolean } ----- +[pass] +++++ +
+++++ type IngestPutPipelineResponse = <+++++ diff --git a/docs/reference-ingest-simulate.asciidoc b/docs/reference-ingest-simulate.asciidoc index a76a08f1d..937c1f225 100644 --- a/docs/reference-ingest-simulate.asciidoc +++ b/docs/reference-ingest-simulate.asciidoc @@ -41,25 +41,35 @@ Executes an ingest pipeline against a set of provided documents. ---- [discrete] -===== `IngestSimulateRequest` +==== IngestSimulateRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface IngestSimulateRequest extends <+++++ [discrete] -===== `IngestSimulateResponse` +==== IngestSimulateResponse -[source,ts] ----- +[pass] +++++ +> { id?: < > verbose?: boolean docs: IngestSimulateDocument[] pipeline?: IngestPipeline } ----- +[pass] +++++ +
+++++
interface IngestSimulateResponse {
docs: IngestSimulateSimulateDocumentResult[]
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-knn_search.asciidoc b/docs/reference-knn_search.asciidoc
index 89ef33f2a..48da6c3ac 100644
--- a/docs/reference-knn_search.asciidoc
+++ b/docs/reference-knn_search.asciidoc
@@ -41,10 +41,12 @@ Run a knn search. NOTE: The kNN search API has been replaced by the `knn` option
----
[discrete]
-===== `KnnSearchRequest`
+==== KnnSearchRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface KnnSearchRequest extends <+++++ [discrete] -===== `KnnSearchResponse` +==== KnnSearchResponse -[source,ts] ----- +[pass] +++++ +> { index: < > routing?: < > @@ -55,20 +57,28 @@ interface KnnSearchRequest extends < > { filter?: QueryDslQueryContainer | QueryDslQueryContainer[] knn: KnnSearchQuery } ----- +[pass] +++++ +
+++++ interface KnnSearchResponse+++++ diff --git a/docs/reference-license-delete.asciidoc b/docs/reference-license-delete.asciidoc index 514a10743..811c3bc6a 100644 --- a/docs/reference-license-delete.asciidoc +++ b/docs/reference-license-delete.asciidoc @@ -41,19 +41,29 @@ Deletes licensing information for the cluster ---- [discrete] -===== `LicenseDeleteRequest` +==== LicenseDeleteRequest -[source,ts] ----- +[pass] +++++ +{ - took: < > + took: number timed_out: boolean _shards: < > hits: SearchHitsMetadata fields?: Record - max_score?: < > + max_score?: number } ----- +[pass] +++++ +
+++++ interface LicenseDeleteRequest extends <+++++ [discrete] -===== `LicenseDeleteResponse` +==== LicenseDeleteResponse -[source,ts] ----- +[pass] +++++ +> { } ----- +[pass] +++++ +
+++++ type LicenseDeleteResponse = <+++++ diff --git a/docs/reference-license-get.asciidoc b/docs/reference-license-get.asciidoc index 9bc1eeef0..27316c090 100644 --- a/docs/reference-license-get.asciidoc +++ b/docs/reference-license-get.asciidoc @@ -41,23 +41,33 @@ Get license information. Returns information about your Elastic license, includi ---- [discrete] -===== `LicenseGetRequest` +==== LicenseGetRequest -[source,ts] ----- +[pass] +++++ +> ----- +[pass] +++++ +
+++++ interface LicenseGetRequest extends <+++++ [discrete] -===== `LicenseGetResponse` +==== LicenseGetResponse -[source,ts] ----- +[pass] +++++ +> { accept_enterprise?: boolean local?: boolean } ----- +[pass] +++++ +
+++++
interface LicenseGetResponse {
license: LicenseGetLicenseInformation
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-license-get_basic_status.asciidoc b/docs/reference-license-get_basic_status.asciidoc
index 82286cbab..0402d464b 100644
--- a/docs/reference-license-get_basic_status.asciidoc
+++ b/docs/reference-license-get_basic_status.asciidoc
@@ -41,21 +41,31 @@ Retrieves information about the status of the basic license.
----
[discrete]
-===== `LicenseGetBasicStatusRequest`
+==== LicenseGetBasicStatusRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface LicenseGetBasicStatusRequest extends <+++++ [discrete] -===== `LicenseGetBasicStatusResponse` +==== LicenseGetBasicStatusResponse -[source,ts] ----- +[pass] +++++ +> { } ----- +[pass] +++++ +
+++++
interface LicenseGetBasicStatusResponse {
eligible_to_start_basic: boolean
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-license-get_trial_status.asciidoc b/docs/reference-license-get_trial_status.asciidoc
index f637fa144..49d7ec88c 100644
--- a/docs/reference-license-get_trial_status.asciidoc
+++ b/docs/reference-license-get_trial_status.asciidoc
@@ -41,21 +41,31 @@ Retrieves information about the status of the trial license.
----
[discrete]
-===== `LicenseGetTrialStatusRequest`
+==== LicenseGetTrialStatusRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface LicenseGetTrialStatusRequest extends <+++++ [discrete] -===== `LicenseGetTrialStatusResponse` +==== LicenseGetTrialStatusResponse -[source,ts] ----- +[pass] +++++ +> { } ----- +[pass] +++++ +
+++++
interface LicenseGetTrialStatusResponse {
eligible_to_start_trial: boolean
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-license-post.asciidoc b/docs/reference-license-post.asciidoc
index 240dfe544..1ee7e4e38 100644
--- a/docs/reference-license-post.asciidoc
+++ b/docs/reference-license-post.asciidoc
@@ -41,26 +41,36 @@ Updates the license for the cluster.
----
[discrete]
-===== `LicensePostRequest`
+==== LicensePostRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface LicensePostRequest extends <+++++ [discrete] -===== `LicensePostResponse` +==== LicensePostResponse -[source,ts] ----- +[pass] +++++ +> { acknowledge?: boolean license?: LicenseLicense licenses?: LicenseLicense[] } ----- +[pass] +++++ +
+++++
interface LicensePostResponse {
acknowledge?: LicensePostAcknowledgement
acknowledged: boolean
license_status: LicenseLicenseStatus
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-license-post_start_basic.asciidoc b/docs/reference-license-post_start_basic.asciidoc
index 571e98b57..0c0f2ae38 100644
--- a/docs/reference-license-post_start_basic.asciidoc
+++ b/docs/reference-license-post_start_basic.asciidoc
@@ -41,20 +41,27 @@ The start basic API enables you to initiate an indefinite basic license, which g
----
[discrete]
-===== `LicensePostStartBasicRequest`
+==== LicensePostStartBasicRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface LicensePostStartBasicRequest extends <+++++ [discrete] -===== `LicensePostStartBasicResponse` +==== LicensePostStartBasicResponse -[source,ts] ----- +[pass] +++++ +> { acknowledge?: boolean } ----- +[pass] +++++ +
+++++
interface LicensePostStartBasicResponse {
acknowledged: boolean
basic_was_started: boolean
@@ -62,5 +69,8 @@ interface LicensePostStartBasicResponse {
type?: LicenseLicenseType
acknowledge?: Record
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-license-post_start_trial.asciidoc b/docs/reference-license-post_start_trial.asciidoc
index e86871eb5..76cf37447 100644
--- a/docs/reference-license-post_start_trial.asciidoc
+++ b/docs/reference-license-post_start_trial.asciidoc
@@ -41,26 +41,36 @@ The start trial API enables you to start a 30-day trial, which gives access to a
----
[discrete]
-===== `LicensePostStartTrialRequest`
+==== LicensePostStartTrialRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface LicensePostStartTrialRequest extends <+++++ [discrete] -===== `LicensePostStartTrialResponse` +==== LicensePostStartTrialResponse -[source,ts] ----- +[pass] +++++ +> { acknowledge?: boolean type_query_string?: string } ----- +[pass] +++++ +
+++++
interface LicensePostStartTrialResponse {
acknowledged: boolean
error_message?: string
trial_was_started: boolean
type?: LicenseLicenseType
}
-----
+[pass]
+++++
+
+++++
diff --git a/docs/reference-logstash-delete_pipeline.asciidoc b/docs/reference-logstash-delete_pipeline.asciidoc
index 700c74454..dd228c84e 100644
--- a/docs/reference-logstash-delete_pipeline.asciidoc
+++ b/docs/reference-logstash-delete_pipeline.asciidoc
@@ -41,20 +41,30 @@ Deletes a pipeline used for Logstash Central Management.
----
[discrete]
-===== `LogstashDeletePipelineRequest`
+==== LogstashDeletePipelineRequest
-[source,ts]
-----
+[pass]
+++++
++++++ interface LogstashDeletePipelineRequest extends <+++++ [discrete] -===== `LogstashDeletePipelineResponse` +==== LogstashDeletePipelineResponse -[source,ts] ----- +[pass] +++++ +> { id: < > } ----- +[pass] +++++ +
+++++ type LogstashDeletePipelineResponse = boolean ----- +[pass] +++++ ++++++ diff --git a/docs/reference-logstash-get_pipeline.asciidoc b/docs/reference-logstash-get_pipeline.asciidoc index 70beea717..d4c90b087 100644 --- a/docs/reference-logstash-get_pipeline.asciidoc +++ b/docs/reference-logstash-get_pipeline.asciidoc @@ -41,20 +41,30 @@ Retrieves pipelines used for Logstash Central Management. ---- [discrete] -===== `LogstashGetPipelineRequest` +==== LogstashGetPipelineRequest -[source,ts] ----- +[pass] +++++ +
+++++ interface LogstashGetPipelineRequest extends <+++++ [discrete] -===== `LogstashGetPipelineResponse` +==== LogstashGetPipelineResponse -[source,ts] ----- +[pass] +++++ +> { id?: < > } ----- +[pass] +++++ +
+++++ type LogstashGetPipelineResponse = Record<<+++++ diff --git a/docs/reference-logstash-put_pipeline.asciidoc b/docs/reference-logstash-put_pipeline.asciidoc index 0f60773d7..e5d892813 100644 --- a/docs/reference-logstash-put_pipeline.asciidoc +++ b/docs/reference-logstash-put_pipeline.asciidoc @@ -41,21 +41,31 @@ Creates or updates a pipeline used for Logstash Central Management. ---- [discrete] -===== `LogstashPutPipelineRequest` +==== LogstashPutPipelineRequest -[source,ts] ----- +[pass] +++++ +>, LogstashPipeline> ----- +[pass] +++++ +
+++++ interface LogstashPutPipelineRequest extends <+++++ [discrete] -===== `LogstashPutPipelineResponse` +==== LogstashPutPipelineResponse -[source,ts] ----- +[pass] +++++ +> { id: < > pipeline?: LogstashPipeline } ----- +[pass] +++++ +
+++++ type LogstashPutPipelineResponse = boolean ----- +[pass] +++++ ++++++ diff --git a/docs/reference-main-index.asciidoc b/docs/reference-main-index.asciidoc index ee010859c..e82300820 100644 --- a/docs/reference-main-index.asciidoc +++ b/docs/reference-main-index.asciidoc @@ -1,5 +1,5 @@ [[reference-main-index]] -== API reference +== API Reference include::reference-shared-types.asciidoc[] include::reference-async_search-delete.asciidoc[] @@ -503,502 +503,502 @@ include::reference-xpack-info.asciidoc[] include::reference-xpack-usage.asciidoc[] -* asyncSearch.delete: <