diff --git a/docs/reference-async_search-delete.asciidoc b/docs/reference-async_search-delete.asciidoc index ea7b44eff..ef3bfa339 100644 --- a/docs/reference-async_search-delete.asciidoc +++ b/docs/reference-async_search-delete.asciidoc @@ -45,8 +45,8 @@ Delete an async search. If the asynchronous search is still running, it is cance [source,ts] ---- -interface AsyncSearchDeleteRequest extends <> { - id: <> +interface AsyncSearchDeleteRequest extends <> { + id: <> } ---- @@ -55,6 +55,6 @@ interface AsyncSearchDeleteRequest extends <> +type AsyncSearchDeleteResponse = <> ---- diff --git a/docs/reference-async_search-get.asciidoc b/docs/reference-async_search-get.asciidoc index a31dfbcf9..4d9eee425 100644 --- a/docs/reference-async_search-get.asciidoc +++ b/docs/reference-async_search-get.asciidoc @@ -45,11 +45,11 @@ Get async search results. Retrieve the results of a previously submitted asynchr [source,ts] ---- -interface AsyncSearchGetRequest extends <> { - id: <> - keep_alive?: <> +interface AsyncSearchGetRequest extends <> { + id: <> + keep_alive?: <> typed_keys?: boolean - wait_for_completion_timeout?: <> + wait_for_completion_timeout?: <> } ---- @@ -58,6 +58,6 @@ interface AsyncSearchGetRequest extends < [source,ts] ---- -type AsyncSearchGetResponse>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase +type AsyncSearchGetResponse>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase ---- diff --git a/docs/reference-async_search-status.asciidoc b/docs/reference-async_search-status.asciidoc index f283fc939..9bfe7f1a5 100644 --- a/docs/reference-async_search-status.asciidoc +++ b/docs/reference-async_search-status.asciidoc @@ -45,8 +45,8 @@ Get the async search status. Get the status of a previously submitted async sear [source,ts] ---- -interface AsyncSearchStatusRequest extends <> { - id: <> +interface AsyncSearchStatusRequest extends <> { + id: <> } ---- diff --git a/docs/reference-async_search-submit.asciidoc b/docs/reference-async_search-submit.asciidoc index db079d085..d07dbe348 100644 --- a/docs/reference-async_search-submit.asciidoc +++ b/docs/reference-async_search-submit.asciidoc @@ -45,39 +45,39 @@ Run an async search. When the primary sort of the results is an indexed field, s [source,ts] ---- -interface AsyncSearchSubmitRequest extends <> { - index?: <> - wait_for_completion_timeout?: <> +interface AsyncSearchSubmitRequest extends <> { + index?: <> + wait_for_completion_timeout?: <> keep_on_completion?: boolean - keep_alive?: <> + keep_alive?: <> allow_no_indices?: boolean allow_partial_search_results?: boolean analyzer?: string analyze_wildcard?: boolean - batched_reduce_size?: <> + batched_reduce_size?: <> ccs_minimize_roundtrips?: boolean default_operator?: QueryDslOperator df?: string - expand_wildcards?: <> + expand_wildcards?: <> ignore_throttled?: boolean ignore_unavailable?: boolean lenient?: boolean - max_concurrent_shard_requests?: <> - min_compatible_shard_node?: <> + max_concurrent_shard_requests?: <> + min_compatible_shard_node?: <> preference?: string - pre_filter_shard_size?: <> + pre_filter_shard_size?: <> request_cache?: boolean - routing?: <> - scroll?: <> - search_type?: <> - suggest_field?: <> - suggest_mode?: <> - suggest_size?: <> + routing?: <> + scroll?: <> + search_type?: <> + suggest_field?: <> + suggest_mode?: <> + suggest_size?: <> suggest_text?: string typed_keys?: boolean rest_total_hits_as_int?: boolean - _source_excludes?: <> - _source_includes?: <> + _source_excludes?: <> + _source_includes?: <> q?: string aggregations?: Record /** @alias aggregations */ @@ -85,31 +85,31 @@ interface AsyncSearchSubmitRequest extends < - from?: <> + from?: <> highlight?: SearchHighlight track_total_hits?: SearchTrackHits - indices_boost?: Record<<>, <>>[] - docvalue_fields?: (QueryDslFieldAndFormat | <>)[] - knn?: <> | <>[] - min_score?: <> + indices_boost?: Record<<>, <>>[] + docvalue_fields?: (QueryDslFieldAndFormat | <>)[] + knn?: <> | <>[] + min_score?: <> post_filter?: QueryDslQueryContainer profile?: boolean query?: QueryDslQueryContainer rescore?: SearchRescore | SearchRescore[] - script_fields?: Record>> - search_after?: <> - size?: <> - slice?: <> - sort?: <> + script_fields?: Record>> + search_after?: <> + size?: <> + slice?: <> + sort?: <> _source?: SearchSourceConfig - fields?: (QueryDslFieldAndFormat | <>)[] + fields?: (QueryDslFieldAndFormat | <>)[] suggest?: SearchSuggester - terminate_after?: <> + terminate_after?: <> timeout?: string track_scores?: boolean version?: boolean seq_no_primary_term?: boolean - stored_fields?: <> + stored_fields?: <> pit?: SearchPointInTimeReference runtime_mappings?: MappingRuntimeFields stats?: string[] @@ -121,6 +121,6 @@ interface AsyncSearchSubmitRequest extends <>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase +type AsyncSearchSubmitResponse>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase ---- diff --git a/docs/reference-autoscaling-delete_autoscaling_policy.asciidoc b/docs/reference-autoscaling-delete_autoscaling_policy.asciidoc index 9ad26d828..58a95bcf3 100644 --- a/docs/reference-autoscaling-delete_autoscaling_policy.asciidoc +++ b/docs/reference-autoscaling-delete_autoscaling_policy.asciidoc @@ -45,8 +45,8 @@ Delete an autoscaling policy. NOTE: This feature is designed for indirect use by [source,ts] ---- -interface AutoscalingDeleteAutoscalingPolicyRequest extends <> { - name: <> +interface AutoscalingDeleteAutoscalingPolicyRequest extends <> { + name: <> } ---- @@ -55,6 +55,6 @@ interface AutoscalingDeleteAutoscalingPolicyRequest extends <> +type AutoscalingDeleteAutoscalingPolicyResponse = <> ---- diff --git a/docs/reference-autoscaling-get_autoscaling_capacity.asciidoc b/docs/reference-autoscaling-get_autoscaling_capacity.asciidoc index ea41b2413..a91e491e6 100644 --- a/docs/reference-autoscaling-get_autoscaling_capacity.asciidoc +++ b/docs/reference-autoscaling-get_autoscaling_capacity.asciidoc @@ -45,7 +45,7 @@ Get the autoscaling capacity. NOTE: This feature is designed for indirect use by [source,ts] ---- -interface AutoscalingGetAutoscalingCapacityRequest extends <> { +interface AutoscalingGetAutoscalingCapacityRequest extends <> { } ---- diff --git a/docs/reference-autoscaling-get_autoscaling_policy.asciidoc b/docs/reference-autoscaling-get_autoscaling_policy.asciidoc index 93a759224..ba403f233 100644 --- a/docs/reference-autoscaling-get_autoscaling_policy.asciidoc +++ b/docs/reference-autoscaling-get_autoscaling_policy.asciidoc @@ -45,8 +45,8 @@ Get an autoscaling policy. NOTE: This feature is designed for indirect use by El [source,ts] ---- -interface AutoscalingGetAutoscalingPolicyRequest extends <> { - name: <> +interface AutoscalingGetAutoscalingPolicyRequest extends <> { + name: <> } ---- diff --git a/docs/reference-autoscaling-put_autoscaling_policy.asciidoc b/docs/reference-autoscaling-put_autoscaling_policy.asciidoc index 9b7d4718f..93b66749f 100644 --- a/docs/reference-autoscaling-put_autoscaling_policy.asciidoc +++ b/docs/reference-autoscaling-put_autoscaling_policy.asciidoc @@ -45,8 +45,8 @@ Create or update an autoscaling policy. NOTE: This feature is designed for indir [source,ts] ---- -interface AutoscalingPutAutoscalingPolicyRequest extends <> { - name: <> +interface AutoscalingPutAutoscalingPolicyRequest extends <> { + name: <> policy?: AutoscalingAutoscalingPolicy } ---- @@ -56,6 +56,6 @@ interface AutoscalingPutAutoscalingPolicyRequest extends <> +type AutoscalingPutAutoscalingPolicyResponse = <> ---- diff --git a/docs/reference-bulk.asciidoc b/docs/reference-bulk.asciidoc index d1f984a70..265a0ff2e 100644 --- a/docs/reference-bulk.asciidoc +++ b/docs/reference-bulk.asciidoc @@ -45,16 +45,16 @@ Bulk index or delete documents. Performs multiple indexing or delete operations [source,ts] ---- -interface BulkRequest extends <> { - index?: <> +interface BulkRequest extends <> { + index?: <> pipeline?: string - refresh?: <> - routing?: <> + refresh?: <> + routing?: <> _source?: SearchSourceConfigParam - _source_excludes?: <> - _source_includes?: <> - timeout?: <> - wait_for_active_shards?: <> + _source_excludes?: <> + _source_includes?: <> + timeout?: <> + wait_for_active_shards?: <> require_alias?: boolean operations?: (BulkOperationContainer | BulkUpdateAction | TDocument)[] } @@ -68,8 +68,8 @@ interface BulkRequest extends < interface BulkResponse { errors: boolean items: Partial>[] - took: <> - ingest_took?: <> + took: <> + ingest_took?: <> } ---- diff --git a/docs/reference-cat-aliases.asciidoc b/docs/reference-cat-aliases.asciidoc index e324d30d1..9c5628b58 100644 --- a/docs/reference-cat-aliases.asciidoc +++ b/docs/reference-cat-aliases.asciidoc @@ -46,8 +46,8 @@ Get aliases. Retrieves the cluster’s index aliases, including filter and routi [source,ts] ---- interface CatAliasesRequest extends CatCatRequestBase { - name?: <> - expand_wildcards?: <> + name?: <> + expand_wildcards?: <> } ---- diff --git a/docs/reference-cat-allocation.asciidoc b/docs/reference-cat-allocation.asciidoc index 13f2a3b6b..13e69ef13 100644 --- a/docs/reference-cat-allocation.asciidoc +++ b/docs/reference-cat-allocation.asciidoc @@ -46,8 +46,8 @@ Provides a snapshot of the number of shards allocated to each data node and thei [source,ts] ---- interface CatAllocationRequest extends CatCatRequestBase { - node_id?: <> - bytes?: <> + node_id?: <> + bytes?: <> } ---- diff --git a/docs/reference-cat-count.asciidoc b/docs/reference-cat-count.asciidoc index bdec787cf..2948f69b5 100644 --- a/docs/reference-cat-count.asciidoc +++ b/docs/reference-cat-count.asciidoc @@ -46,7 +46,7 @@ Get a document count. Provides quick access to a document count for a data strea [source,ts] ---- interface CatCountRequest extends CatCatRequestBase { - index?: <> + index?: <> } ---- diff --git a/docs/reference-cat-fielddata.asciidoc b/docs/reference-cat-fielddata.asciidoc index e54098ff6..6f4280b26 100644 --- a/docs/reference-cat-fielddata.asciidoc +++ b/docs/reference-cat-fielddata.asciidoc @@ -46,8 +46,8 @@ Returns the amount of heap memory currently used by the field data cache on ever [source,ts] ---- interface CatFielddataRequest extends CatCatRequestBase { - fields?: <> - bytes?: <> + fields?: <> + bytes?: <> } ---- diff --git a/docs/reference-cat-health.asciidoc b/docs/reference-cat-health.asciidoc index c918c3ad9..408e0b087 100644 --- a/docs/reference-cat-health.asciidoc +++ b/docs/reference-cat-health.asciidoc @@ -46,7 +46,7 @@ Returns the health status of a cluster, similar to the cluster health API. IMPOR [source,ts] ---- interface CatHealthRequest extends CatCatRequestBase { - time?: <> + time?: <> ts?: boolean } ---- diff --git a/docs/reference-cat-indices.asciidoc b/docs/reference-cat-indices.asciidoc index 712e2dd69..0dd322635 100644 --- a/docs/reference-cat-indices.asciidoc +++ b/docs/reference-cat-indices.asciidoc @@ -46,13 +46,13 @@ Get index information. Returns high-level information about indices in a cluster [source,ts] ---- interface CatIndicesRequest extends CatCatRequestBase { - index?: <> - bytes?: <> - expand_wildcards?: <> - health?: <> + index?: <> + bytes?: <> + expand_wildcards?: <> + health?: <> include_unloaded_segments?: boolean pri?: boolean - time?: <> + time?: <> } ---- diff --git a/docs/reference-cat-ml_data_frame_analytics.asciidoc b/docs/reference-cat-ml_data_frame_analytics.asciidoc index 5f6d2565b..2359c0b41 100644 --- a/docs/reference-cat-ml_data_frame_analytics.asciidoc +++ b/docs/reference-cat-ml_data_frame_analytics.asciidoc @@ -46,12 +46,12 @@ Get data frame analytics jobs. Returns configuration and usage information about [source,ts] ---- interface CatMlDataFrameAnalyticsRequest extends CatCatRequestBase { - id?: <> + id?: <> allow_no_match?: boolean - bytes?: <> + bytes?: <> h?: CatCatDfaColumns s?: CatCatDfaColumns - time?: <> + time?: <> } ---- diff --git a/docs/reference-cat-ml_datafeeds.asciidoc b/docs/reference-cat-ml_datafeeds.asciidoc index ee0b55e05..fee750d64 100644 --- a/docs/reference-cat-ml_datafeeds.asciidoc +++ b/docs/reference-cat-ml_datafeeds.asciidoc @@ -46,11 +46,11 @@ Get datafeeds. Returns configuration and usage information about datafeeds. This [source,ts] ---- interface CatMlDatafeedsRequest extends CatCatRequestBase { - datafeed_id?: <> + datafeed_id?: <> allow_no_match?: boolean h?: CatCatDatafeedColumns s?: CatCatDatafeedColumns - time?: <> + time?: <> } ---- diff --git a/docs/reference-cat-ml_jobs.asciidoc b/docs/reference-cat-ml_jobs.asciidoc index 713621775..29f3d5136 100644 --- a/docs/reference-cat-ml_jobs.asciidoc +++ b/docs/reference-cat-ml_jobs.asciidoc @@ -46,12 +46,12 @@ Get anomaly detection jobs. Returns configuration and usage information for anom [source,ts] ---- interface CatMlJobsRequest extends CatCatRequestBase { - job_id?: <> + job_id?: <> allow_no_match?: boolean - bytes?: <> + bytes?: <> h?: CatCatAnonalyDetectorColumns s?: CatCatAnonalyDetectorColumns - time?: <> + time?: <> } ---- diff --git a/docs/reference-cat-ml_trained_models.asciidoc b/docs/reference-cat-ml_trained_models.asciidoc index 74aebc295..85140bb52 100644 --- a/docs/reference-cat-ml_trained_models.asciidoc +++ b/docs/reference-cat-ml_trained_models.asciidoc @@ -46,13 +46,13 @@ Get trained models. Returns configuration and usage information about inference [source,ts] ---- interface CatMlTrainedModelsRequest extends CatCatRequestBase { - model_id?: <> + model_id?: <> allow_no_match?: boolean - bytes?: <> + bytes?: <> h?: CatCatTrainedModelsColumns s?: CatCatTrainedModelsColumns - from?: <> - size?: <> + from?: <> + size?: <> } ---- diff --git a/docs/reference-cat-nodes.asciidoc b/docs/reference-cat-nodes.asciidoc index be64457d0..ad69da952 100644 --- a/docs/reference-cat-nodes.asciidoc +++ b/docs/reference-cat-nodes.asciidoc @@ -46,7 +46,7 @@ Returns information about the nodes in a cluster. IMPORTANT: cat APIs are only i [source,ts] ---- interface CatNodesRequest extends CatCatRequestBase { - bytes?: <> + bytes?: <> full_id?: boolean | string include_unloaded_segments?: boolean } diff --git a/docs/reference-cat-recovery.asciidoc b/docs/reference-cat-recovery.asciidoc index d79867511..0ef0228fa 100644 --- a/docs/reference-cat-recovery.asciidoc +++ b/docs/reference-cat-recovery.asciidoc @@ -46,9 +46,9 @@ Returns information about ongoing and completed shard recoveries. Shard recovery [source,ts] ---- interface CatRecoveryRequest extends CatCatRequestBase { - index?: <> + index?: <> active_only?: boolean - bytes?: <> + bytes?: <> detailed?: boolean } ---- diff --git a/docs/reference-cat-segments.asciidoc b/docs/reference-cat-segments.asciidoc index 4a1de7bae..4862ff312 100644 --- a/docs/reference-cat-segments.asciidoc +++ b/docs/reference-cat-segments.asciidoc @@ -46,8 +46,8 @@ Returns low-level information about the Lucene segments in index shards. For dat [source,ts] ---- interface CatSegmentsRequest extends CatCatRequestBase { - index?: <> - bytes?: <> + index?: <> + bytes?: <> } ---- diff --git a/docs/reference-cat-shards.asciidoc b/docs/reference-cat-shards.asciidoc index f1ce92cdb..939ef6c93 100644 --- a/docs/reference-cat-shards.asciidoc +++ b/docs/reference-cat-shards.asciidoc @@ -46,8 +46,8 @@ Returns information about the shards in a cluster. For data streams, the API ret [source,ts] ---- interface CatShardsRequest extends CatCatRequestBase { - index?: <> - bytes?: <> + index?: <> + bytes?: <> } ---- diff --git a/docs/reference-cat-snapshots.asciidoc b/docs/reference-cat-snapshots.asciidoc index d1c770d92..4898ed988 100644 --- a/docs/reference-cat-snapshots.asciidoc +++ b/docs/reference-cat-snapshots.asciidoc @@ -46,7 +46,7 @@ Returns information about the snapshots stored in one or more repositories. A sn [source,ts] ---- interface CatSnapshotsRequest extends CatCatRequestBase { - repository?: <> + repository?: <> ignore_unavailable?: boolean } ---- diff --git a/docs/reference-cat-templates.asciidoc b/docs/reference-cat-templates.asciidoc index ce7d5b8af..6b8d7bd89 100644 --- a/docs/reference-cat-templates.asciidoc +++ b/docs/reference-cat-templates.asciidoc @@ -46,7 +46,7 @@ Returns information about index templates in a cluster. You can use index templa [source,ts] ---- interface CatTemplatesRequest extends CatCatRequestBase { - name?: <> + name?: <> } ---- diff --git a/docs/reference-cat-thread_pool.asciidoc b/docs/reference-cat-thread_pool.asciidoc index 368b1d065..0726614c0 100644 --- a/docs/reference-cat-thread_pool.asciidoc +++ b/docs/reference-cat-thread_pool.asciidoc @@ -46,8 +46,8 @@ Returns thread pool statistics for each node in a cluster. Returned information [source,ts] ---- interface CatThreadPoolRequest extends CatCatRequestBase { - thread_pool_patterns?: <> - time?: <> + thread_pool_patterns?: <> + time?: <> } ---- diff --git a/docs/reference-cat-transforms.asciidoc b/docs/reference-cat-transforms.asciidoc index 0747ea735..37b0fa11e 100644 --- a/docs/reference-cat-transforms.asciidoc +++ b/docs/reference-cat-transforms.asciidoc @@ -46,13 +46,13 @@ Get transforms. Returns configuration and usage information about transforms. CA [source,ts] ---- interface CatTransformsRequest extends CatCatRequestBase { - transform_id?: <> + transform_id?: <> allow_no_match?: boolean - from?: <> + from?: <> h?: CatCatTransformColumns s?: CatCatTransformColumns - time?: <> - size?: <> + time?: <> + size?: <> } ---- diff --git a/docs/reference-ccr-delete_auto_follow_pattern.asciidoc b/docs/reference-ccr-delete_auto_follow_pattern.asciidoc index 80cb4b2fb..9cc165b78 100644 --- a/docs/reference-ccr-delete_auto_follow_pattern.asciidoc +++ b/docs/reference-ccr-delete_auto_follow_pattern.asciidoc @@ -45,8 +45,8 @@ Deletes auto-follow patterns. [source,ts] ---- -interface CcrDeleteAutoFollowPatternRequest extends <> { - name: <> +interface CcrDeleteAutoFollowPatternRequest extends <> { + name: <> } ---- @@ -55,6 +55,6 @@ interface CcrDeleteAutoFollowPatternRequest extends <> +type CcrDeleteAutoFollowPatternResponse = <> ---- diff --git a/docs/reference-ccr-follow.asciidoc b/docs/reference-ccr-follow.asciidoc index 7efa85e0f..bb6c2d42b 100644 --- a/docs/reference-ccr-follow.asciidoc +++ b/docs/reference-ccr-follow.asciidoc @@ -45,20 +45,20 @@ Creates a new follower index configured to follow the referenced leader index. [source,ts] ---- -interface CcrFollowRequest extends <> { - index: <> - wait_for_active_shards?: <> - leader_index?: <> - max_outstanding_read_requests?: <> - max_outstanding_write_requests?: <> - max_read_request_operation_count?: <> +interface CcrFollowRequest extends <> { + index: <> + wait_for_active_shards?: <> + leader_index?: <> + max_outstanding_read_requests?: <> + max_outstanding_write_requests?: <> + max_read_request_operation_count?: <> max_read_request_size?: string - max_retry_delay?: <> - max_write_buffer_count?: <> + max_retry_delay?: <> + max_write_buffer_count?: <> max_write_buffer_size?: string - max_write_request_operation_count?: <> + max_write_request_operation_count?: <> max_write_request_size?: string - read_poll_timeout?: <> + read_poll_timeout?: <> remote_cluster?: string } ---- diff --git a/docs/reference-ccr-follow_info.asciidoc b/docs/reference-ccr-follow_info.asciidoc index d5765de5f..451438c1a 100644 --- a/docs/reference-ccr-follow_info.asciidoc +++ b/docs/reference-ccr-follow_info.asciidoc @@ -45,8 +45,8 @@ Retrieves information about all follower indices, including parameters and statu [source,ts] ---- -interface CcrFollowInfoRequest extends <> { - index: <> +interface CcrFollowInfoRequest extends <> { + index: <> } ---- diff --git a/docs/reference-ccr-follow_stats.asciidoc b/docs/reference-ccr-follow_stats.asciidoc index 3e65632d1..853eeee16 100644 --- a/docs/reference-ccr-follow_stats.asciidoc +++ b/docs/reference-ccr-follow_stats.asciidoc @@ -45,8 +45,8 @@ Retrieves follower stats. return shard-level stats about the following tasks ass [source,ts] ---- -interface CcrFollowStatsRequest extends <> { - index: <> +interface CcrFollowStatsRequest extends <> { + index: <> } ---- diff --git a/docs/reference-ccr-forget_follower.asciidoc b/docs/reference-ccr-forget_follower.asciidoc index 4911dcc35..b752afd3e 100644 --- a/docs/reference-ccr-forget_follower.asciidoc +++ b/docs/reference-ccr-forget_follower.asciidoc @@ -45,11 +45,11 @@ Removes the follower retention leases from the leader. [source,ts] ---- -interface CcrForgetFollowerRequest extends <> { - index: <> +interface CcrForgetFollowerRequest extends <> { + index: <> follower_cluster?: string - follower_index?: <> - follower_index_uuid?: <> + follower_index?: <> + follower_index_uuid?: <> leader_remote_cluster?: string } ---- @@ -60,7 +60,7 @@ interface CcrForgetFollowerRequest extends <> + _shards: <> } ---- diff --git a/docs/reference-ccr-get_auto_follow_pattern.asciidoc b/docs/reference-ccr-get_auto_follow_pattern.asciidoc index ed4e5e43e..62dae8862 100644 --- a/docs/reference-ccr-get_auto_follow_pattern.asciidoc +++ b/docs/reference-ccr-get_auto_follow_pattern.asciidoc @@ -45,8 +45,8 @@ Gets configured auto-follow patterns. Returns the specified auto-follow pattern [source,ts] ---- -interface CcrGetAutoFollowPatternRequest extends <> { - name?: <> +interface CcrGetAutoFollowPatternRequest extends <> { + name?: <> } ---- diff --git a/docs/reference-ccr-pause_auto_follow_pattern.asciidoc b/docs/reference-ccr-pause_auto_follow_pattern.asciidoc index 8824b2124..9d13e03e2 100644 --- a/docs/reference-ccr-pause_auto_follow_pattern.asciidoc +++ b/docs/reference-ccr-pause_auto_follow_pattern.asciidoc @@ -45,8 +45,8 @@ Pauses an auto-follow pattern [source,ts] ---- -interface CcrPauseAutoFollowPatternRequest extends <> { - name: <> +interface CcrPauseAutoFollowPatternRequest extends <> { + name: <> } ---- @@ -55,6 +55,6 @@ interface CcrPauseAutoFollowPatternRequest extends <> +type CcrPauseAutoFollowPatternResponse = <> ---- diff --git a/docs/reference-ccr-pause_follow.asciidoc b/docs/reference-ccr-pause_follow.asciidoc index 5dbee490b..2856ecc10 100644 --- a/docs/reference-ccr-pause_follow.asciidoc +++ b/docs/reference-ccr-pause_follow.asciidoc @@ -45,8 +45,8 @@ Pauses a follower index. The follower index will not fetch any additional operat [source,ts] ---- -interface CcrPauseFollowRequest extends <> { - index: <> +interface CcrPauseFollowRequest extends <> { + index: <> } ---- @@ -55,6 +55,6 @@ interface CcrPauseFollowRequest extends < [source,ts] ---- -type CcrPauseFollowResponse = <> +type CcrPauseFollowResponse = <> ---- diff --git a/docs/reference-ccr-put_auto_follow_pattern.asciidoc b/docs/reference-ccr-put_auto_follow_pattern.asciidoc index b4b5f6585..6c6878547 100644 --- a/docs/reference-ccr-put_auto_follow_pattern.asciidoc +++ b/docs/reference-ccr-put_auto_follow_pattern.asciidoc @@ -45,23 +45,23 @@ Creates a new named collection of auto-follow patterns against a specified remot [source,ts] ---- -interface CcrPutAutoFollowPatternRequest extends <> { - name: <> +interface CcrPutAutoFollowPatternRequest extends <> { + name: <> remote_cluster: string - follow_index_pattern?: <> - leader_index_patterns?: <> - leader_index_exclusion_patterns?: <> - max_outstanding_read_requests?: <> + follow_index_pattern?: <> + leader_index_patterns?: <> + leader_index_exclusion_patterns?: <> + max_outstanding_read_requests?: <> settings?: Record - max_outstanding_write_requests?: <> - read_poll_timeout?: <> - max_read_request_operation_count?: <> - max_read_request_size?: <> - max_retry_delay?: <> - max_write_buffer_count?: <> - max_write_buffer_size?: <> - max_write_request_operation_count?: <> - max_write_request_size?: <> + max_outstanding_write_requests?: <> + read_poll_timeout?: <> + max_read_request_operation_count?: <> + max_read_request_size?: <> + max_retry_delay?: <> + max_write_buffer_count?: <> + max_write_buffer_size?: <> + max_write_request_operation_count?: <> + max_write_request_size?: <> } ---- @@ -70,6 +70,6 @@ interface CcrPutAutoFollowPatternRequest extends <> +type CcrPutAutoFollowPatternResponse = <> ---- diff --git a/docs/reference-ccr-resume_auto_follow_pattern.asciidoc b/docs/reference-ccr-resume_auto_follow_pattern.asciidoc index 7e73fae09..291ea1aa8 100644 --- a/docs/reference-ccr-resume_auto_follow_pattern.asciidoc +++ b/docs/reference-ccr-resume_auto_follow_pattern.asciidoc @@ -45,8 +45,8 @@ Resumes an auto-follow pattern that has been paused [source,ts] ---- -interface CcrResumeAutoFollowPatternRequest extends <> { - name: <> +interface CcrResumeAutoFollowPatternRequest extends <> { + name: <> } ---- @@ -55,6 +55,6 @@ interface CcrResumeAutoFollowPatternRequest extends <> +type CcrResumeAutoFollowPatternResponse = <> ---- diff --git a/docs/reference-ccr-resume_follow.asciidoc b/docs/reference-ccr-resume_follow.asciidoc index 5b25b4678..700defa44 100644 --- a/docs/reference-ccr-resume_follow.asciidoc +++ b/docs/reference-ccr-resume_follow.asciidoc @@ -45,18 +45,18 @@ Resumes a follower index that has been paused [source,ts] ---- -interface CcrResumeFollowRequest extends <> { - index: <> - max_outstanding_read_requests?: <> - max_outstanding_write_requests?: <> - max_read_request_operation_count?: <> +interface CcrResumeFollowRequest extends <> { + index: <> + max_outstanding_read_requests?: <> + max_outstanding_write_requests?: <> + max_read_request_operation_count?: <> max_read_request_size?: string - max_retry_delay?: <> - max_write_buffer_count?: <> + max_retry_delay?: <> + max_write_buffer_count?: <> max_write_buffer_size?: string - max_write_request_operation_count?: <> + max_write_request_operation_count?: <> max_write_request_size?: string - read_poll_timeout?: <> + read_poll_timeout?: <> } ---- @@ -65,6 +65,6 @@ interface CcrResumeFollowRequest extends <> +type CcrResumeFollowResponse = <> ---- diff --git a/docs/reference-ccr-stats.asciidoc b/docs/reference-ccr-stats.asciidoc index 9ecb48733..b1a4ba275 100644 --- a/docs/reference-ccr-stats.asciidoc +++ b/docs/reference-ccr-stats.asciidoc @@ -45,7 +45,7 @@ Gets all stats related to cross-cluster replication. [source,ts] ---- -interface CcrStatsRequest extends <> { +interface CcrStatsRequest extends <> { } ---- diff --git a/docs/reference-ccr-unfollow.asciidoc b/docs/reference-ccr-unfollow.asciidoc index 1a5e41e28..d0f071518 100644 --- a/docs/reference-ccr-unfollow.asciidoc +++ b/docs/reference-ccr-unfollow.asciidoc @@ -45,8 +45,8 @@ Stops the following task associated with a follower index and removes index meta [source,ts] ---- -interface CcrUnfollowRequest extends <> { - index: <> +interface CcrUnfollowRequest extends <> { + index: <> } ---- @@ -55,6 +55,6 @@ interface CcrUnfollowRequest extends <> { [source,ts] ---- -type CcrUnfollowResponse = <> +type CcrUnfollowResponse = <> ---- diff --git a/docs/reference-clear_scroll.asciidoc b/docs/reference-clear_scroll.asciidoc index 72e66fdda..2bc343786 100644 --- a/docs/reference-clear_scroll.asciidoc +++ b/docs/reference-clear_scroll.asciidoc @@ -45,8 +45,8 @@ Clear a scrolling search. Clear the search context and results for a scrolling s [source,ts] ---- -interface ClearScrollRequest extends <> { - scroll_id?: <> +interface ClearScrollRequest extends <> { + scroll_id?: <> } ---- @@ -57,7 +57,7 @@ interface ClearScrollRequest extends <> { ---- interface ClearScrollResponse { succeeded: boolean - num_freed: <> + num_freed: <> } ---- diff --git a/docs/reference-close_point_in_time.asciidoc b/docs/reference-close_point_in_time.asciidoc index f126c1243..2e4c9f2f7 100644 --- a/docs/reference-close_point_in_time.asciidoc +++ b/docs/reference-close_point_in_time.asciidoc @@ -45,8 +45,8 @@ Close a point in time. A point in time must be opened explicitly before being us [source,ts] ---- -interface ClosePointInTimeRequest extends <> { - id: <> +interface ClosePointInTimeRequest extends <> { + id: <> } ---- @@ -57,7 +57,7 @@ interface ClosePointInTimeRequest extends <> + num_freed: <> } ---- diff --git a/docs/reference-cluster-allocation_explain.asciidoc b/docs/reference-cluster-allocation_explain.asciidoc index 89f1655d0..e85bfcd1e 100644 --- a/docs/reference-cluster-allocation_explain.asciidoc +++ b/docs/reference-cluster-allocation_explain.asciidoc @@ -45,13 +45,13 @@ Provides explanations for shard allocations in the cluster. [source,ts] ---- -interface ClusterAllocationExplainRequest extends <> { +interface ClusterAllocationExplainRequest extends <> { include_disk_info?: boolean include_yes_decisions?: boolean current_node?: string - index?: <> + index?: <> primary?: boolean - shard?: <> + shard?: <> } ---- @@ -62,8 +62,8 @@ interface ClusterAllocationExplainRequest extends <> - allocation_delay_in_millis?: <><<>> + allocation_delay?: <> + allocation_delay_in_millis?: <><<>> can_allocate?: ClusterAllocationExplainDecision can_move_to_other_node?: ClusterAllocationExplainDecision can_rebalance_cluster?: ClusterAllocationExplainDecision @@ -72,18 +72,18 @@ interface ClusterAllocationExplainResponse { can_remain_decisions?: ClusterAllocationExplainAllocationDecision[] can_remain_on_current_node?: ClusterAllocationExplainDecision cluster_info?: ClusterAllocationExplainClusterInfo - configured_delay?: <> - configured_delay_in_millis?: <><<>> + configured_delay?: <> + configured_delay_in_millis?: <><<>> current_node?: ClusterAllocationExplainCurrentNode current_state: string - index: <> + index: <> move_explanation?: string node_allocation_decisions?: ClusterAllocationExplainNodeAllocationExplanation[] primary: boolean rebalance_explanation?: string - remaining_delay?: <> - remaining_delay_in_millis?: <><<>> - shard: <> + remaining_delay?: <> + remaining_delay_in_millis?: <><<>> + shard: <> unassigned_info?: ClusterAllocationExplainUnassignedInformation note?: string } diff --git a/docs/reference-cluster-delete_component_template.asciidoc b/docs/reference-cluster-delete_component_template.asciidoc index 9bd68791d..3d5b460da 100644 --- a/docs/reference-cluster-delete_component_template.asciidoc +++ b/docs/reference-cluster-delete_component_template.asciidoc @@ -45,10 +45,10 @@ Delete component templates. Deletes component templates. Component templates are [source,ts] ---- -interface ClusterDeleteComponentTemplateRequest extends <> { - name: <> - master_timeout?: <> - timeout?: <> +interface ClusterDeleteComponentTemplateRequest extends <> { + name: <> + master_timeout?: <> + timeout?: <> } ---- @@ -57,6 +57,6 @@ interface ClusterDeleteComponentTemplateRequest extends <> +type ClusterDeleteComponentTemplateResponse = <> ---- diff --git a/docs/reference-cluster-delete_voting_config_exclusions.asciidoc b/docs/reference-cluster-delete_voting_config_exclusions.asciidoc index 210c6054e..1a95d2f54 100644 --- a/docs/reference-cluster-delete_voting_config_exclusions.asciidoc +++ b/docs/reference-cluster-delete_voting_config_exclusions.asciidoc @@ -45,7 +45,7 @@ Clears cluster voting config exclusions. [source,ts] ---- -interface ClusterDeleteVotingConfigExclusionsRequest extends <> { +interface ClusterDeleteVotingConfigExclusionsRequest extends <> { wait_for_removal?: boolean } ---- diff --git a/docs/reference-cluster-exists_component_template.asciidoc b/docs/reference-cluster-exists_component_template.asciidoc index 1ccb0a92d..ffb8e5ba4 100644 --- a/docs/reference-cluster-exists_component_template.asciidoc +++ b/docs/reference-cluster-exists_component_template.asciidoc @@ -45,9 +45,9 @@ Check component templates. Returns information about whether a particular compon [source,ts] ---- -interface ClusterExistsComponentTemplateRequest extends <> { - name: <> - master_timeout?: <> +interface ClusterExistsComponentTemplateRequest extends <> { + name: <> + master_timeout?: <> local?: boolean } ---- diff --git a/docs/reference-cluster-get_component_template.asciidoc b/docs/reference-cluster-get_component_template.asciidoc index 88c229597..b547aa17c 100644 --- a/docs/reference-cluster-get_component_template.asciidoc +++ b/docs/reference-cluster-get_component_template.asciidoc @@ -45,12 +45,12 @@ Get component templates. Retrieves information about component templates. [source,ts] ---- -interface ClusterGetComponentTemplateRequest extends <> { - name?: <> +interface ClusterGetComponentTemplateRequest extends <> { + name?: <> flat_settings?: boolean include_defaults?: boolean local?: boolean - master_timeout?: <> + master_timeout?: <> } ---- diff --git a/docs/reference-cluster-get_settings.asciidoc b/docs/reference-cluster-get_settings.asciidoc index 40ab9b33e..adcf8e948 100644 --- a/docs/reference-cluster-get_settings.asciidoc +++ b/docs/reference-cluster-get_settings.asciidoc @@ -45,11 +45,11 @@ Returns cluster-wide settings. By default, it returns only settings that have be [source,ts] ---- -interface ClusterGetSettingsRequest extends <> { +interface ClusterGetSettingsRequest extends <> { flat_settings?: boolean include_defaults?: boolean - master_timeout?: <> - timeout?: <> + master_timeout?: <> + timeout?: <> } ---- diff --git a/docs/reference-cluster-health.asciidoc b/docs/reference-cluster-health.asciidoc index 2988c1668..7c80c37a1 100644 --- a/docs/reference-cluster-health.asciidoc +++ b/docs/reference-cluster-health.asciidoc @@ -45,19 +45,19 @@ The cluster health API returns a simple status on the health of the cluster. You [source,ts] ---- -interface ClusterHealthRequest extends <> { - index?: <> - expand_wildcards?: <> - level?: <> +interface ClusterHealthRequest extends <> { + index?: <> + expand_wildcards?: <> + level?: <> local?: boolean - master_timeout?: <> - timeout?: <> - wait_for_active_shards?: <> - wait_for_events?: <> - wait_for_nodes?: string | <> + master_timeout?: <> + timeout?: <> + wait_for_active_shards?: <> + wait_for_events?: <> + wait_for_nodes?: string | <> wait_for_no_initializing_shards?: boolean wait_for_no_relocating_shards?: boolean - wait_for_status?: <> + wait_for_status?: <> } ---- diff --git a/docs/reference-cluster-info.asciidoc b/docs/reference-cluster-info.asciidoc index d0535babc..14d9c1889 100644 --- a/docs/reference-cluster-info.asciidoc +++ b/docs/reference-cluster-info.asciidoc @@ -45,8 +45,8 @@ Get cluster info. Returns basic information about the cluster. [source,ts] ---- -interface ClusterInfoRequest extends <> { - target: <> +interface ClusterInfoRequest extends <> { + target: <> } ---- @@ -56,7 +56,7 @@ interface ClusterInfoRequest extends <> { [source,ts] ---- interface ClusterInfoResponse { - cluster_name: <> + cluster_name: <> http?: NodesHttp ingest?: NodesIngest thread_pool?: Record diff --git a/docs/reference-cluster-pending_tasks.asciidoc b/docs/reference-cluster-pending_tasks.asciidoc index ec9b75aeb..d528df913 100644 --- a/docs/reference-cluster-pending_tasks.asciidoc +++ b/docs/reference-cluster-pending_tasks.asciidoc @@ -45,9 +45,9 @@ Returns cluster-level changes (such as create index, update mapping, allocate or [source,ts] ---- -interface ClusterPendingTasksRequest extends <> { +interface ClusterPendingTasksRequest extends <> { local?: boolean - master_timeout?: <> + master_timeout?: <> } ---- diff --git a/docs/reference-cluster-post_voting_config_exclusions.asciidoc b/docs/reference-cluster-post_voting_config_exclusions.asciidoc index e4f372ae4..76c0757e1 100644 --- a/docs/reference-cluster-post_voting_config_exclusions.asciidoc +++ b/docs/reference-cluster-post_voting_config_exclusions.asciidoc @@ -45,10 +45,10 @@ Updates the cluster voting config exclusions by node ids or node names. [source,ts] ---- -interface ClusterPostVotingConfigExclusionsRequest extends <> { - node_names?: <> - node_ids?: <> - timeout?: <> +interface ClusterPostVotingConfigExclusionsRequest extends <> { + node_names?: <> + node_ids?: <> + timeout?: <> } ---- diff --git a/docs/reference-cluster-put_component_template.asciidoc b/docs/reference-cluster-put_component_template.asciidoc index fc5aa4a7b..db145d28f 100644 --- a/docs/reference-cluster-put_component_template.asciidoc +++ b/docs/reference-cluster-put_component_template.asciidoc @@ -45,13 +45,13 @@ Create or update a component template. Creates or updates a component template. [source,ts] ---- -interface ClusterPutComponentTemplateRequest extends <> { - name: <> +interface ClusterPutComponentTemplateRequest extends <> { + name: <> create?: boolean - master_timeout?: <> + master_timeout?: <> template: IndicesIndexState - version?: <> - _meta?: <> + version?: <> + _meta?: <> deprecated?: boolean } ---- @@ -61,6 +61,6 @@ interface ClusterPutComponentTemplateRequest extends <> +type ClusterPutComponentTemplateResponse = <> ---- diff --git a/docs/reference-cluster-put_settings.asciidoc b/docs/reference-cluster-put_settings.asciidoc index 6e4069fa3..7e6a9bc31 100644 --- a/docs/reference-cluster-put_settings.asciidoc +++ b/docs/reference-cluster-put_settings.asciidoc @@ -45,10 +45,10 @@ Updates the cluster settings. [source,ts] ---- -interface ClusterPutSettingsRequest extends <> { +interface ClusterPutSettingsRequest extends <> { flat_settings?: boolean - master_timeout?: <> - timeout?: <> + master_timeout?: <> + timeout?: <> persistent?: Record transient?: Record } diff --git a/docs/reference-cluster-remote_info.asciidoc b/docs/reference-cluster-remote_info.asciidoc index 15c44616e..10078a0a4 100644 --- a/docs/reference-cluster-remote_info.asciidoc +++ b/docs/reference-cluster-remote_info.asciidoc @@ -45,7 +45,7 @@ The cluster remote info API allows you to retrieve all of the configured remote [source,ts] ---- -interface ClusterRemoteInfoRequest extends <> { +interface ClusterRemoteInfoRequest extends <> { } ---- diff --git a/docs/reference-cluster-reroute.asciidoc b/docs/reference-cluster-reroute.asciidoc index 1868ff7d9..2d28e8f8e 100644 --- a/docs/reference-cluster-reroute.asciidoc +++ b/docs/reference-cluster-reroute.asciidoc @@ -45,13 +45,13 @@ Allows to manually change the allocation of individual shards in the cluster. [source,ts] ---- -interface ClusterRerouteRequest extends <> { +interface ClusterRerouteRequest extends <> { dry_run?: boolean explain?: boolean - metric?: <> + metric?: <> retry_failed?: boolean - master_timeout?: <> - timeout?: <> + master_timeout?: <> + timeout?: <> commands?: ClusterRerouteCommand[] } ---- diff --git a/docs/reference-cluster-state.asciidoc b/docs/reference-cluster-state.asciidoc index 7da73387b..1498d90a1 100644 --- a/docs/reference-cluster-state.asciidoc +++ b/docs/reference-cluster-state.asciidoc @@ -45,17 +45,17 @@ Returns a comprehensive information about the state of the cluster. [source,ts] ---- -interface ClusterStateRequest extends <> { - metric?: <> - index?: <> +interface ClusterStateRequest extends <> { + metric?: <> + index?: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> flat_settings?: boolean ignore_unavailable?: boolean local?: boolean - master_timeout?: <> - wait_for_metadata_version?: <> - wait_for_timeout?: <> + master_timeout?: <> + wait_for_metadata_version?: <> + wait_for_timeout?: <> } ---- diff --git a/docs/reference-cluster-stats.asciidoc b/docs/reference-cluster-stats.asciidoc index 3079b88c1..c11e17ed2 100644 --- a/docs/reference-cluster-stats.asciidoc +++ b/docs/reference-cluster-stats.asciidoc @@ -45,10 +45,10 @@ Returns cluster statistics. It returns basic index metrics (shard numbers, store [source,ts] ---- -interface ClusterStatsRequest extends <> { - node_id?: <> +interface ClusterStatsRequest extends <> { + node_id?: <> include_remotes?: boolean - timeout?: <> + timeout?: <> } ---- diff --git a/docs/reference-connector-check_in.asciidoc b/docs/reference-connector-check_in.asciidoc index 532ef0cf6..55dd98b92 100644 --- a/docs/reference-connector-check_in.asciidoc +++ b/docs/reference-connector-check_in.asciidoc @@ -45,8 +45,8 @@ Check in a connector. Update the `last_seen` field in the connector and set it t [source,ts] ---- -interface ConnectorCheckInRequest extends <> { - connector_id: <> +interface ConnectorCheckInRequest extends <> { + connector_id: <> } ---- @@ -56,7 +56,7 @@ interface ConnectorCheckInRequest extends <> + result: <> } ---- diff --git a/docs/reference-connector-delete.asciidoc b/docs/reference-connector-delete.asciidoc index 548adc565..9ddb9ba8d 100644 --- a/docs/reference-connector-delete.asciidoc +++ b/docs/reference-connector-delete.asciidoc @@ -45,8 +45,8 @@ Delete a connector. Removes a connector and associated sync jobs. This is a dest [source,ts] ---- -interface ConnectorDeleteRequest extends <> { - connector_id: <> +interface ConnectorDeleteRequest extends <> { + connector_id: <> delete_sync_jobs?: boolean } ---- @@ -56,6 +56,6 @@ interface ConnectorDeleteRequest extends <> +type ConnectorDeleteResponse = <> ---- diff --git a/docs/reference-connector-get.asciidoc b/docs/reference-connector-get.asciidoc index 67ba6ae6e..f0894535f 100644 --- a/docs/reference-connector-get.asciidoc +++ b/docs/reference-connector-get.asciidoc @@ -45,8 +45,8 @@ Get a connector. Get the details about a connector. [source,ts] ---- -interface ConnectorGetRequest extends <> { - connector_id: <> +interface ConnectorGetRequest extends <> { + connector_id: <> } ---- diff --git a/docs/reference-connector-list.asciidoc b/docs/reference-connector-list.asciidoc index 0886ba465..ec61e4ff6 100644 --- a/docs/reference-connector-list.asciidoc +++ b/docs/reference-connector-list.asciidoc @@ -45,12 +45,12 @@ Get all connectors. Get information about all connectors. [source,ts] ---- -interface ConnectorListRequest extends <> { - from?: <> - size?: <> - index_name?: <> - connector_name?: <> - service_type?: <> +interface ConnectorListRequest extends <> { + from?: <> + size?: <> + index_name?: <> + connector_name?: <> + service_type?: <> query?: string } ---- @@ -61,7 +61,7 @@ interface ConnectorListRequest extends <> [source,ts] ---- interface ConnectorListResponse { - count: <> + count: <> results: ConnectorConnector[] } ---- diff --git a/docs/reference-connector-post.asciidoc b/docs/reference-connector-post.asciidoc index 9e847e9cd..0aca7b9b1 100644 --- a/docs/reference-connector-post.asciidoc +++ b/docs/reference-connector-post.asciidoc @@ -45,9 +45,9 @@ Create a connector. Connectors are Elasticsearch integrations that bring content [source,ts] ---- -interface ConnectorPostRequest extends <> { +interface ConnectorPostRequest extends <> { description?: string - index_name?: <> + index_name?: <> is_native?: boolean language?: string name?: string @@ -61,8 +61,8 @@ interface ConnectorPostRequest extends <> [source,ts] ---- interface ConnectorPostResponse { - result: <> - id: <> + result: <> + id: <> } ---- diff --git a/docs/reference-connector-put.asciidoc b/docs/reference-connector-put.asciidoc index 3ff54c951..939d109d8 100644 --- a/docs/reference-connector-put.asciidoc +++ b/docs/reference-connector-put.asciidoc @@ -45,10 +45,10 @@ Create or update a connector. [source,ts] ---- -interface ConnectorPutRequest extends <> { - connector_id?: <> +interface ConnectorPutRequest extends <> { + connector_id?: <> description?: string - index_name?: <> + index_name?: <> is_native?: boolean language?: string name?: string @@ -62,8 +62,8 @@ interface ConnectorPutRequest extends <> [source,ts] ---- interface ConnectorPutResponse { - result: <> - id: <> + result: <> + id: <> } ---- diff --git a/docs/reference-connector-sync_job_cancel.asciidoc b/docs/reference-connector-sync_job_cancel.asciidoc index 397dced52..e977c0f1e 100644 --- a/docs/reference-connector-sync_job_cancel.asciidoc +++ b/docs/reference-connector-sync_job_cancel.asciidoc @@ -45,8 +45,8 @@ Cancel a connector sync job. Cancel a connector sync job, which sets the status [source,ts] ---- -interface ConnectorSyncJobCancelRequest extends <> { - connector_sync_job_id: <> +interface ConnectorSyncJobCancelRequest extends <> { + connector_sync_job_id: <> } ---- @@ -56,7 +56,7 @@ interface ConnectorSyncJobCancelRequest extends <> + result: <> } ---- diff --git a/docs/reference-connector-sync_job_delete.asciidoc b/docs/reference-connector-sync_job_delete.asciidoc index f98d5d947..e8186c33a 100644 --- a/docs/reference-connector-sync_job_delete.asciidoc +++ b/docs/reference-connector-sync_job_delete.asciidoc @@ -45,8 +45,8 @@ Delete a connector sync job. Remove a connector sync job and its associated data [source,ts] ---- -interface ConnectorSyncJobDeleteRequest extends <> { - connector_sync_job_id: <> +interface ConnectorSyncJobDeleteRequest extends <> { + connector_sync_job_id: <> } ---- @@ -55,6 +55,6 @@ interface ConnectorSyncJobDeleteRequest extends <> +type ConnectorSyncJobDeleteResponse = <> ---- diff --git a/docs/reference-connector-sync_job_get.asciidoc b/docs/reference-connector-sync_job_get.asciidoc index 3439c1200..32ce6fd94 100644 --- a/docs/reference-connector-sync_job_get.asciidoc +++ b/docs/reference-connector-sync_job_get.asciidoc @@ -45,8 +45,8 @@ Get a connector sync job. [source,ts] ---- -interface ConnectorSyncJobGetRequest extends <> { - connector_sync_job_id: <> +interface ConnectorSyncJobGetRequest extends <> { + connector_sync_job_id: <> } ---- diff --git a/docs/reference-connector-sync_job_list.asciidoc b/docs/reference-connector-sync_job_list.asciidoc index 0f2c9ffbf..5ad848fcf 100644 --- a/docs/reference-connector-sync_job_list.asciidoc +++ b/docs/reference-connector-sync_job_list.asciidoc @@ -45,11 +45,11 @@ Get all connector sync jobs. Get information about all stored connector sync job [source,ts] ---- -interface ConnectorSyncJobListRequest extends <> { - from?: <> - size?: <> +interface ConnectorSyncJobListRequest extends <> { + from?: <> + size?: <> status?: ConnectorSyncStatus - connector_id?: <> + connector_id?: <> job_type?: ConnectorSyncJobType | ConnectorSyncJobType[] } ---- @@ -60,7 +60,7 @@ interface ConnectorSyncJobListRequest extends <> + count: <> results: ConnectorConnectorSyncJob[] } ---- diff --git a/docs/reference-connector-sync_job_post.asciidoc b/docs/reference-connector-sync_job_post.asciidoc index 6dc0597e0..a02c86f66 100644 --- a/docs/reference-connector-sync_job_post.asciidoc +++ b/docs/reference-connector-sync_job_post.asciidoc @@ -45,8 +45,8 @@ Create a connector sync job. Create a connector sync job document in the interna [source,ts] ---- -interface ConnectorSyncJobPostRequest extends <> { - id: <> +interface ConnectorSyncJobPostRequest extends <> { + id: <> job_type?: ConnectorSyncJobType trigger_method?: ConnectorSyncJobTriggerMethod } @@ -58,7 +58,7 @@ interface ConnectorSyncJobPostRequest extends <> + id: <> } ---- diff --git a/docs/reference-connector-update_active_filtering.asciidoc b/docs/reference-connector-update_active_filtering.asciidoc index 2830c9f78..3905b60f8 100644 --- a/docs/reference-connector-update_active_filtering.asciidoc +++ b/docs/reference-connector-update_active_filtering.asciidoc @@ -45,8 +45,8 @@ Activate the connector draft filter. Activates the valid draft filtering for a c [source,ts] ---- -interface ConnectorUpdateActiveFilteringRequest extends <> { - connector_id: <> +interface ConnectorUpdateActiveFilteringRequest extends <> { + connector_id: <> } ---- @@ -56,7 +56,7 @@ interface ConnectorUpdateActiveFilteringRequest extends <> + result: <> } ---- diff --git a/docs/reference-connector-update_api_key_id.asciidoc b/docs/reference-connector-update_api_key_id.asciidoc index 1ca5ef059..e78f1af6a 100644 --- a/docs/reference-connector-update_api_key_id.asciidoc +++ b/docs/reference-connector-update_api_key_id.asciidoc @@ -45,8 +45,8 @@ Update the connector API key ID. Update the `api_key_id` and `api_key_secret_id` [source,ts] ---- -interface ConnectorUpdateApiKeyIdRequest extends <> { - connector_id: <> +interface ConnectorUpdateApiKeyIdRequest extends <> { + connector_id: <> api_key_id?: string api_key_secret_id?: string } @@ -58,7 +58,7 @@ interface ConnectorUpdateApiKeyIdRequest extends <> + result: <> } ---- diff --git a/docs/reference-connector-update_configuration.asciidoc b/docs/reference-connector-update_configuration.asciidoc index f08862717..82c080c2c 100644 --- a/docs/reference-connector-update_configuration.asciidoc +++ b/docs/reference-connector-update_configuration.asciidoc @@ -45,8 +45,8 @@ Update the connector configuration. Update the configuration field in the connec [source,ts] ---- -interface ConnectorUpdateConfigurationRequest extends <> { - connector_id: <> +interface ConnectorUpdateConfigurationRequest extends <> { + connector_id: <> configuration?: ConnectorConnectorConfiguration values?: Record } @@ -58,7 +58,7 @@ interface ConnectorUpdateConfigurationRequest extends <> + result: <> } ---- diff --git a/docs/reference-connector-update_error.asciidoc b/docs/reference-connector-update_error.asciidoc index d3dcc566a..9f3dae2e4 100644 --- a/docs/reference-connector-update_error.asciidoc +++ b/docs/reference-connector-update_error.asciidoc @@ -45,8 +45,8 @@ Update the connector error field. Set the error field for the connector. If the [source,ts] ---- -interface ConnectorUpdateErrorRequest extends <> { - connector_id: <> +interface ConnectorUpdateErrorRequest extends <> { + connector_id: <> error: SpecUtilsWithNullValue } ---- @@ -57,7 +57,7 @@ interface ConnectorUpdateErrorRequest extends <> + result: <> } ---- diff --git a/docs/reference-connector-update_filtering.asciidoc b/docs/reference-connector-update_filtering.asciidoc index 2fab8b40b..b6bca94ea 100644 --- a/docs/reference-connector-update_filtering.asciidoc +++ b/docs/reference-connector-update_filtering.asciidoc @@ -45,8 +45,8 @@ Update the connector filtering. Update the draft filtering configuration of a co [source,ts] ---- -interface ConnectorUpdateFilteringRequest extends <> { - connector_id: <> +interface ConnectorUpdateFilteringRequest extends <> { + connector_id: <> filtering?: ConnectorFilteringConfig[] rules?: ConnectorFilteringRule[] advanced_snippet?: ConnectorFilteringAdvancedSnippet @@ -59,7 +59,7 @@ interface ConnectorUpdateFilteringRequest extends <> + result: <> } ---- diff --git a/docs/reference-connector-update_filtering_validation.asciidoc b/docs/reference-connector-update_filtering_validation.asciidoc index 877d76682..8a83ef4f6 100644 --- a/docs/reference-connector-update_filtering_validation.asciidoc +++ b/docs/reference-connector-update_filtering_validation.asciidoc @@ -43,8 +43,8 @@ Update the connector draft filtering validation. Update the draft filtering vali [source,ts] ---- -interface ConnectorUpdateFilteringValidationRequest extends <> { - connector_id: <> +interface ConnectorUpdateFilteringValidationRequest extends <> { + connector_id: <> validation: ConnectorFilteringRulesValidation } ---- @@ -55,7 +55,7 @@ interface ConnectorUpdateFilteringValidationRequest extends <> + result: <> } ---- diff --git a/docs/reference-connector-update_index_name.asciidoc b/docs/reference-connector-update_index_name.asciidoc index e13f2d775..56109727c 100644 --- a/docs/reference-connector-update_index_name.asciidoc +++ b/docs/reference-connector-update_index_name.asciidoc @@ -45,9 +45,9 @@ Update the connector index name. Update the `index_name` field of a connector, s [source,ts] ---- -interface ConnectorUpdateIndexNameRequest extends <> { - connector_id: <> - index_name: SpecUtilsWithNullValue<<>> +interface ConnectorUpdateIndexNameRequest extends <> { + connector_id: <> + index_name: SpecUtilsWithNullValue<<>> } ---- @@ -57,7 +57,7 @@ interface ConnectorUpdateIndexNameRequest extends <> + result: <> } ---- diff --git a/docs/reference-connector-update_name.asciidoc b/docs/reference-connector-update_name.asciidoc index c1716c5b6..c60bd18a7 100644 --- a/docs/reference-connector-update_name.asciidoc +++ b/docs/reference-connector-update_name.asciidoc @@ -45,8 +45,8 @@ Update the connector name and description. [source,ts] ---- -interface ConnectorUpdateNameRequest extends <> { - connector_id: <> +interface ConnectorUpdateNameRequest extends <> { + connector_id: <> name?: string description?: string } @@ -58,7 +58,7 @@ interface ConnectorUpdateNameRequest extends <> + result: <> } ---- diff --git a/docs/reference-connector-update_native.asciidoc b/docs/reference-connector-update_native.asciidoc index 288b88827..df3d72f68 100644 --- a/docs/reference-connector-update_native.asciidoc +++ b/docs/reference-connector-update_native.asciidoc @@ -43,8 +43,8 @@ Update the connector is_native flag. [source,ts] ---- -interface ConnectorUpdateNativeRequest extends <> { - connector_id: <> +interface ConnectorUpdateNativeRequest extends <> { + connector_id: <> is_native: boolean } ---- @@ -55,7 +55,7 @@ interface ConnectorUpdateNativeRequest extends <> + result: <> } ---- diff --git a/docs/reference-connector-update_pipeline.asciidoc b/docs/reference-connector-update_pipeline.asciidoc index 37911dd56..eda967b41 100644 --- a/docs/reference-connector-update_pipeline.asciidoc +++ b/docs/reference-connector-update_pipeline.asciidoc @@ -45,8 +45,8 @@ Update the connector pipeline. When you create a new connector, the configuratio [source,ts] ---- -interface ConnectorUpdatePipelineRequest extends <> { - connector_id: <> +interface ConnectorUpdatePipelineRequest extends <> { + connector_id: <> pipeline: ConnectorIngestPipelineParams } ---- @@ -57,7 +57,7 @@ interface ConnectorUpdatePipelineRequest extends <> + result: <> } ---- diff --git a/docs/reference-connector-update_scheduling.asciidoc b/docs/reference-connector-update_scheduling.asciidoc index 7eaca3c4d..76cceaa41 100644 --- a/docs/reference-connector-update_scheduling.asciidoc +++ b/docs/reference-connector-update_scheduling.asciidoc @@ -45,8 +45,8 @@ Update the connector scheduling. [source,ts] ---- -interface ConnectorUpdateSchedulingRequest extends <> { - connector_id: <> +interface ConnectorUpdateSchedulingRequest extends <> { + connector_id: <> scheduling: ConnectorSchedulingConfiguration } ---- @@ -57,7 +57,7 @@ interface ConnectorUpdateSchedulingRequest extends <> + result: <> } ---- diff --git a/docs/reference-connector-update_service_type.asciidoc b/docs/reference-connector-update_service_type.asciidoc index e82725586..9e93523cf 100644 --- a/docs/reference-connector-update_service_type.asciidoc +++ b/docs/reference-connector-update_service_type.asciidoc @@ -45,8 +45,8 @@ Update the connector service type. [source,ts] ---- -interface ConnectorUpdateServiceTypeRequest extends <> { - connector_id: <> +interface ConnectorUpdateServiceTypeRequest extends <> { + connector_id: <> service_type: string } ---- @@ -57,7 +57,7 @@ interface ConnectorUpdateServiceTypeRequest extends <> + result: <> } ---- diff --git a/docs/reference-connector-update_status.asciidoc b/docs/reference-connector-update_status.asciidoc index f35072c82..ae0b32122 100644 --- a/docs/reference-connector-update_status.asciidoc +++ b/docs/reference-connector-update_status.asciidoc @@ -45,8 +45,8 @@ Update the connector status. [source,ts] ---- -interface ConnectorUpdateStatusRequest extends <> { - connector_id: <> +interface ConnectorUpdateStatusRequest extends <> { + connector_id: <> status: ConnectorConnectorStatus } ---- @@ -57,7 +57,7 @@ interface ConnectorUpdateStatusRequest extends <> + result: <> } ---- diff --git a/docs/reference-count.asciidoc b/docs/reference-count.asciidoc index 12d641929..0c1fb860a 100644 --- a/docs/reference-count.asciidoc +++ b/docs/reference-count.asciidoc @@ -45,21 +45,21 @@ Returns number of documents matching a query. [source,ts] ---- -interface CountRequest extends <> { - index?: <> +interface CountRequest extends <> { + index?: <> allow_no_indices?: boolean analyzer?: string analyze_wildcard?: boolean default_operator?: QueryDslOperator df?: string - expand_wildcards?: <> + expand_wildcards?: <> ignore_throttled?: boolean ignore_unavailable?: boolean lenient?: boolean - min_score?: <> + min_score?: <> preference?: string - routing?: <> - terminate_after?: <> + routing?: <> + terminate_after?: <> q?: string query?: QueryDslQueryContainer } @@ -71,8 +71,8 @@ interface CountRequest extends <> { [source,ts] ---- interface CountResponse { - count: <> - _shards: <> + count: <> + _shards: <> } ---- diff --git a/docs/reference-create.asciidoc b/docs/reference-create.asciidoc index 43453e186..44184a497 100644 --- a/docs/reference-create.asciidoc +++ b/docs/reference-create.asciidoc @@ -45,16 +45,16 @@ Index a document. Adds a JSON document to the specified data stream or index and [source,ts] ---- -interface CreateRequest extends <> { - id: <> - index: <> +interface CreateRequest extends <> { + id: <> + index: <> pipeline?: string - refresh?: <> - routing?: <> - timeout?: <> - version?: <> - version_type?: <> - wait_for_active_shards?: <> + refresh?: <> + routing?: <> + timeout?: <> + version?: <> + version_type?: <> + wait_for_active_shards?: <> document?: TDocument } ---- @@ -64,6 +64,6 @@ interface CreateRequest extends <> +type CreateResponse = <> ---- diff --git a/docs/reference-dangling_indices-delete_dangling_index.asciidoc b/docs/reference-dangling_indices-delete_dangling_index.asciidoc index a792988f6..6e93d9105 100644 --- a/docs/reference-dangling_indices-delete_dangling_index.asciidoc +++ b/docs/reference-dangling_indices-delete_dangling_index.asciidoc @@ -45,11 +45,11 @@ Delete a dangling index. If Elasticsearch encounters index data that is absent f [source,ts] ---- -interface DanglingIndicesDeleteDanglingIndexRequest extends <> { - index_uuid: <> +interface DanglingIndicesDeleteDanglingIndexRequest extends <> { + index_uuid: <> accept_data_loss: boolean - master_timeout?: <> - timeout?: <> + master_timeout?: <> + timeout?: <> } ---- @@ -58,6 +58,6 @@ interface DanglingIndicesDeleteDanglingIndexRequest extends <> +type DanglingIndicesDeleteDanglingIndexResponse = <> ---- diff --git a/docs/reference-dangling_indices-import_dangling_index.asciidoc b/docs/reference-dangling_indices-import_dangling_index.asciidoc index 8d2af4bf2..4a1d0cf6c 100644 --- a/docs/reference-dangling_indices-import_dangling_index.asciidoc +++ b/docs/reference-dangling_indices-import_dangling_index.asciidoc @@ -45,11 +45,11 @@ Import a dangling index. If Elasticsearch encounters index data that is absent f [source,ts] ---- -interface DanglingIndicesImportDanglingIndexRequest extends <> { - index_uuid: <> +interface DanglingIndicesImportDanglingIndexRequest extends <> { + index_uuid: <> accept_data_loss: boolean - master_timeout?: <> - timeout?: <> + master_timeout?: <> + timeout?: <> } ---- @@ -58,6 +58,6 @@ interface DanglingIndicesImportDanglingIndexRequest extends <> +type DanglingIndicesImportDanglingIndexResponse = <> ---- diff --git a/docs/reference-dangling_indices-list_dangling_indices.asciidoc b/docs/reference-dangling_indices-list_dangling_indices.asciidoc index 402e87d46..b9438f60b 100644 --- a/docs/reference-dangling_indices-list_dangling_indices.asciidoc +++ b/docs/reference-dangling_indices-list_dangling_indices.asciidoc @@ -45,7 +45,7 @@ Get the dangling indices. If Elasticsearch encounters index data that is absent [source,ts] ---- -interface DanglingIndicesListDanglingIndicesRequest extends <> { +interface DanglingIndicesListDanglingIndicesRequest extends <> { } ---- diff --git a/docs/reference-delete.asciidoc b/docs/reference-delete.asciidoc index 3476cf1f7..04210c15f 100644 --- a/docs/reference-delete.asciidoc +++ b/docs/reference-delete.asciidoc @@ -45,17 +45,17 @@ Delete a document. Removes a JSON document from the specified index. [source,ts] ---- -interface DeleteRequest extends <> { - id: <> - index: <> - if_primary_term?: <> - if_seq_no?: <> - refresh?: <> - routing?: <> - timeout?: <> - version?: <> - version_type?: <> - wait_for_active_shards?: <> +interface DeleteRequest extends <> { + id: <> + index: <> + if_primary_term?: <> + if_seq_no?: <> + refresh?: <> + routing?: <> + timeout?: <> + version?: <> + version_type?: <> + wait_for_active_shards?: <> } ---- @@ -64,6 +64,6 @@ interface DeleteRequest extends <> { [source,ts] ---- -type DeleteResponse = <> +type DeleteResponse = <> ---- diff --git a/docs/reference-delete_by_query.asciidoc b/docs/reference-delete_by_query.asciidoc index 78c8c75d5..f73d3e4c6 100644 --- a/docs/reference-delete_by_query.asciidoc +++ b/docs/reference-delete_by_query.asciidoc @@ -45,39 +45,39 @@ Delete documents. Deletes documents that match the specified query. [source,ts] ---- -interface DeleteByQueryRequest extends <> { - index: <> +interface DeleteByQueryRequest extends <> { + index: <> allow_no_indices?: boolean analyzer?: string analyze_wildcard?: boolean - conflicts?: <> + conflicts?: <> default_operator?: QueryDslOperator df?: string - expand_wildcards?: <> - from?: <> + expand_wildcards?: <> + from?: <> ignore_unavailable?: boolean lenient?: boolean preference?: string refresh?: boolean request_cache?: boolean - requests_per_second?: <> - routing?: <> + requests_per_second?: <> + routing?: <> q?: string - scroll?: <> - scroll_size?: <> - search_timeout?: <> - search_type?: <> - slices?: <> + scroll?: <> + scroll_size?: <> + search_timeout?: <> + search_type?: <> + slices?: <> sort?: string[] stats?: string[] - terminate_after?: <> - timeout?: <> + terminate_after?: <> + timeout?: <> version?: boolean - wait_for_active_shards?: <> + wait_for_active_shards?: <> wait_for_completion?: boolean - max_docs?: <> + max_docs?: <> query?: QueryDslQueryContainer - slice?: <> + slice?: <> } ---- @@ -87,22 +87,22 @@ interface DeleteByQueryRequest extends <> [source,ts] ---- interface DeleteByQueryResponse { - batches?: <> - deleted?: <> - failures?: <>[] - noops?: <> - requests_per_second?: <> - retries?: <> - slice_id?: <> - task?: <> - throttled?: <> - throttled_millis?: <><<>> - throttled_until?: <> - throttled_until_millis?: <><<>> + batches?: <> + deleted?: <> + failures?: <>[] + noops?: <> + requests_per_second?: <> + retries?: <> + slice_id?: <> + task?: <> + throttled?: <> + throttled_millis?: <><<>> + throttled_until?: <> + throttled_until_millis?: <><<>> timed_out?: boolean - took?: <><<>> - total?: <> - version_conflicts?: <> + took?: <><<>> + total?: <> + version_conflicts?: <> } ---- diff --git a/docs/reference-delete_by_query_rethrottle.asciidoc b/docs/reference-delete_by_query_rethrottle.asciidoc index cb0747ea5..199af459c 100644 --- a/docs/reference-delete_by_query_rethrottle.asciidoc +++ b/docs/reference-delete_by_query_rethrottle.asciidoc @@ -45,9 +45,9 @@ Throttle a delete by query operation. Change the number of requests per second f [source,ts] ---- -interface DeleteByQueryRethrottleRequest extends <> { - task_id: <> - requests_per_second?: <> +interface DeleteByQueryRethrottleRequest extends <> { + task_id: <> + requests_per_second?: <> } ---- diff --git a/docs/reference-delete_script.asciidoc b/docs/reference-delete_script.asciidoc index d49c10add..a1ee7107c 100644 --- a/docs/reference-delete_script.asciidoc +++ b/docs/reference-delete_script.asciidoc @@ -45,10 +45,10 @@ Delete a script or search template. Deletes a stored script or search template. [source,ts] ---- -interface DeleteScriptRequest extends <> { - id: <> - master_timeout?: <> - timeout?: <> +interface DeleteScriptRequest extends <> { + id: <> + master_timeout?: <> + timeout?: <> } ---- @@ -57,6 +57,6 @@ interface DeleteScriptRequest extends <> [source,ts] ---- -type DeleteScriptResponse = <> +type DeleteScriptResponse = <> ---- diff --git a/docs/reference-enrich-delete_policy.asciidoc b/docs/reference-enrich-delete_policy.asciidoc index e1b5df7d5..61741e442 100644 --- a/docs/reference-enrich-delete_policy.asciidoc +++ b/docs/reference-enrich-delete_policy.asciidoc @@ -45,8 +45,8 @@ Delete an enrich policy. Deletes an existing enrich policy and its enrich index. [source,ts] ---- -interface EnrichDeletePolicyRequest extends <> { - name: <> +interface EnrichDeletePolicyRequest extends <> { + name: <> } ---- @@ -55,6 +55,6 @@ interface EnrichDeletePolicyRequest extends <> +type EnrichDeletePolicyResponse = <> ---- diff --git a/docs/reference-enrich-execute_policy.asciidoc b/docs/reference-enrich-execute_policy.asciidoc index 9cd1c6aea..1d0756d0f 100644 --- a/docs/reference-enrich-execute_policy.asciidoc +++ b/docs/reference-enrich-execute_policy.asciidoc @@ -45,8 +45,8 @@ Creates the enrich index for an existing enrich policy. [source,ts] ---- -interface EnrichExecutePolicyRequest extends <> { - name: <> +interface EnrichExecutePolicyRequest extends <> { + name: <> wait_for_completion?: boolean } ---- @@ -58,7 +58,7 @@ interface EnrichExecutePolicyRequest extends <> + task_id?: <> } ---- diff --git a/docs/reference-enrich-get_policy.asciidoc b/docs/reference-enrich-get_policy.asciidoc index b2b818d0c..9faa027ca 100644 --- a/docs/reference-enrich-get_policy.asciidoc +++ b/docs/reference-enrich-get_policy.asciidoc @@ -45,8 +45,8 @@ Get an enrich policy. Returns information about an enrich policy. [source,ts] ---- -interface EnrichGetPolicyRequest extends <> { - name?: <> +interface EnrichGetPolicyRequest extends <> { + name?: <> } ---- diff --git a/docs/reference-enrich-put_policy.asciidoc b/docs/reference-enrich-put_policy.asciidoc index 723734465..57aba40f9 100644 --- a/docs/reference-enrich-put_policy.asciidoc +++ b/docs/reference-enrich-put_policy.asciidoc @@ -45,8 +45,8 @@ Create an enrich policy. Creates an enrich policy. [source,ts] ---- -interface EnrichPutPolicyRequest extends <> { - name: <> +interface EnrichPutPolicyRequest extends <> { + name: <> geo_match?: EnrichPolicy match?: EnrichPolicy range?: EnrichPolicy @@ -58,6 +58,6 @@ interface EnrichPutPolicyRequest extends <> +type EnrichPutPolicyResponse = <> ---- diff --git a/docs/reference-enrich-stats.asciidoc b/docs/reference-enrich-stats.asciidoc index 9ff421709..d5c5cbc8c 100644 --- a/docs/reference-enrich-stats.asciidoc +++ b/docs/reference-enrich-stats.asciidoc @@ -45,7 +45,7 @@ Get enrich stats. Returns enrich coordinator statistics and information about en [source,ts] ---- -interface EnrichStatsRequest extends <> { +interface EnrichStatsRequest extends <> { } ---- diff --git a/docs/reference-eql-delete.asciidoc b/docs/reference-eql-delete.asciidoc index d2260e2f9..1bda4bbed 100644 --- a/docs/reference-eql-delete.asciidoc +++ b/docs/reference-eql-delete.asciidoc @@ -45,8 +45,8 @@ Deletes an async EQL search or a stored synchronous EQL search. The API also del [source,ts] ---- -interface EqlDeleteRequest extends <> { - id: <> +interface EqlDeleteRequest extends <> { + id: <> } ---- @@ -55,6 +55,6 @@ interface EqlDeleteRequest extends <> { [source,ts] ---- -type EqlDeleteResponse = <> +type EqlDeleteResponse = <> ---- diff --git a/docs/reference-eql-get.asciidoc b/docs/reference-eql-get.asciidoc index 202618cfd..81566c4d9 100644 --- a/docs/reference-eql-get.asciidoc +++ b/docs/reference-eql-get.asciidoc @@ -45,10 +45,10 @@ Returns the current status and available results for an async EQL search or a st [source,ts] ---- -interface EqlGetRequest extends <> { - id: <> - keep_alive?: <> - wait_for_completion_timeout?: <> +interface EqlGetRequest extends <> { + id: <> + keep_alive?: <> + wait_for_completion_timeout?: <> } ---- diff --git a/docs/reference-eql-get_status.asciidoc b/docs/reference-eql-get_status.asciidoc index 7fe4ca200..95c35e105 100644 --- a/docs/reference-eql-get_status.asciidoc +++ b/docs/reference-eql-get_status.asciidoc @@ -45,8 +45,8 @@ Returns the current status for an async EQL search or a stored synchronous EQL s [source,ts] ---- -interface EqlGetStatusRequest extends <> { - id: <> +interface EqlGetStatusRequest extends <> { + id: <> } ---- @@ -56,12 +56,12 @@ interface EqlGetStatusRequest extends <> [source,ts] ---- interface EqlGetStatusResponse { - id: <> + id: <> is_partial: boolean is_running: boolean - start_time_in_millis?: <><<>> - expiration_time_in_millis?: <><<>> - completion_status?: <> + start_time_in_millis?: <><<>> + expiration_time_in_millis?: <><<>> + completion_status?: <> } ---- diff --git a/docs/reference-eql-search.asciidoc b/docs/reference-eql-search.asciidoc index 3354f26e2..2491ebcd2 100644 --- a/docs/reference-eql-search.asciidoc +++ b/docs/reference-eql-search.asciidoc @@ -45,23 +45,23 @@ Returns results matching a query expressed in Event Query Language (EQL) [source,ts] ---- -interface EqlSearchRequest extends <> { - index: <> +interface EqlSearchRequest extends <> { + index: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_unavailable?: boolean query: string case_sensitive?: boolean - event_category_field?: <> - tiebreaker_field?: <> - timestamp_field?: <> - fetch_size?: <> + event_category_field?: <> + tiebreaker_field?: <> + timestamp_field?: <> + fetch_size?: <> filter?: QueryDslQueryContainer | QueryDslQueryContainer[] - keep_alive?: <> + keep_alive?: <> keep_on_completion?: boolean - wait_for_completion_timeout?: <> - size?: <> - fields?: QueryDslFieldAndFormat | <> | (QueryDslFieldAndFormat | <>)[] + wait_for_completion_timeout?: <> + size?: <> + fields?: QueryDslFieldAndFormat | <> | (QueryDslFieldAndFormat | <>)[] result_position?: EqlSearchResultPosition runtime_mappings?: MappingRuntimeFields } diff --git a/docs/reference-esql-query.asciidoc b/docs/reference-esql-query.asciidoc index 30586cffd..b0829d0e8 100644 --- a/docs/reference-esql-query.asciidoc +++ b/docs/reference-esql-query.asciidoc @@ -45,14 +45,14 @@ Executes an ES|QL request [source,ts] ---- -interface EsqlQueryRequest extends <> { +interface EsqlQueryRequest extends <> { format?: EsqlQueryEsqlFormat delimiter?: string drop_null_columns?: boolean columnar?: boolean filter?: QueryDslQueryContainer locale?: string - params?: <>[] + params?: <>[] profile?: boolean query: string tables?: Record> @@ -64,6 +64,6 @@ interface EsqlQueryRequest extends <> { [source,ts] ---- -type EsqlQueryResponse = <> +type EsqlQueryResponse = <> ---- diff --git a/docs/reference-exists.asciidoc b/docs/reference-exists.asciidoc index d16504355..36722d62f 100644 --- a/docs/reference-exists.asciidoc +++ b/docs/reference-exists.asciidoc @@ -45,19 +45,19 @@ Check a document. Checks if a specified document exists. [source,ts] ---- -interface ExistsRequest extends <> { - id: <> - index: <> +interface ExistsRequest extends <> { + id: <> + index: <> preference?: string realtime?: boolean refresh?: boolean - routing?: <> + routing?: <> _source?: SearchSourceConfigParam - _source_excludes?: <> - _source_includes?: <> - stored_fields?: <> - version?: <> - version_type?: <> + _source_excludes?: <> + _source_includes?: <> + stored_fields?: <> + version?: <> + version_type?: <> } ---- diff --git a/docs/reference-exists_source.asciidoc b/docs/reference-exists_source.asciidoc index e07df6f88..3baa64d45 100644 --- a/docs/reference-exists_source.asciidoc +++ b/docs/reference-exists_source.asciidoc @@ -45,18 +45,18 @@ Check for a document source. Checks if a document's `_source` is stored. [source,ts] ---- -interface ExistsSourceRequest extends <> { - id: <> - index: <> +interface ExistsSourceRequest extends <> { + id: <> + index: <> preference?: string realtime?: boolean refresh?: boolean - routing?: <> + routing?: <> _source?: SearchSourceConfigParam - _source_excludes?: <> - _source_includes?: <> - version?: <> - version_type?: <> + _source_excludes?: <> + _source_includes?: <> + version?: <> + version_type?: <> } ---- diff --git a/docs/reference-explain.asciidoc b/docs/reference-explain.asciidoc index 04a5a4d11..07c01ba5c 100644 --- a/docs/reference-explain.asciidoc +++ b/docs/reference-explain.asciidoc @@ -45,20 +45,20 @@ Explain a document match result. Returns information about why a specific docume [source,ts] ---- -interface ExplainRequest extends <> { - id: <> - index: <> +interface ExplainRequest extends <> { + id: <> + index: <> analyzer?: string analyze_wildcard?: boolean default_operator?: QueryDslOperator df?: string lenient?: boolean preference?: string - routing?: <> + routing?: <> _source?: SearchSourceConfigParam - _source_excludes?: <> - _source_includes?: <> - stored_fields?: <> + _source_excludes?: <> + _source_includes?: <> + stored_fields?: <> q?: string query?: QueryDslQueryContainer } @@ -70,11 +70,11 @@ interface ExplainRequest extends <> { [source,ts] ---- interface ExplainResponse { - _index: <> - _id: <> + _index: <> + _id: <> matched: boolean explanation?: ExplainExplanationDetail - get?: <> + get?: <> } ---- diff --git a/docs/reference-features-get_features.asciidoc b/docs/reference-features-get_features.asciidoc index b30187fac..30f1d3b60 100644 --- a/docs/reference-features-get_features.asciidoc +++ b/docs/reference-features-get_features.asciidoc @@ -45,7 +45,7 @@ Gets a list of features which can be included in snapshots using the feature_sta [source,ts] ---- -interface FeaturesGetFeaturesRequest extends <> { +interface FeaturesGetFeaturesRequest extends <> { } ---- diff --git a/docs/reference-features-reset_features.asciidoc b/docs/reference-features-reset_features.asciidoc index 9839a20de..584b9d913 100644 --- a/docs/reference-features-reset_features.asciidoc +++ b/docs/reference-features-reset_features.asciidoc @@ -45,7 +45,7 @@ Resets the internal state of features, usually by deleting system indices [source,ts] ---- -interface FeaturesResetFeaturesRequest extends <> { +interface FeaturesResetFeaturesRequest extends <> { } ---- diff --git a/docs/reference-field_caps.asciidoc b/docs/reference-field_caps.asciidoc index 8df5df73b..3a39fb613 100644 --- a/docs/reference-field_caps.asciidoc +++ b/docs/reference-field_caps.asciidoc @@ -45,16 +45,16 @@ Get the field capabilities. Get information about the capabilities of fields amo [source,ts] ---- -interface FieldCapsRequest extends <> { - index?: <> +interface FieldCapsRequest extends <> { + index?: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_unavailable?: boolean include_unmapped?: boolean filters?: string types?: string[] include_empty_fields?: boolean - fields?: <> + fields?: <> index_filter?: QueryDslQueryContainer runtime_mappings?: MappingRuntimeFields } @@ -66,8 +66,8 @@ interface FieldCapsRequest extends <> { [source,ts] ---- interface FieldCapsResponse { - indices: <> - fields: Record<<>, Record> + indices: <> + fields: Record<<>, Record> } ---- diff --git a/docs/reference-fleet-global_checkpoints.asciidoc b/docs/reference-fleet-global_checkpoints.asciidoc index 26a0921c1..2f32e348e 100644 --- a/docs/reference-fleet-global_checkpoints.asciidoc +++ b/docs/reference-fleet-global_checkpoints.asciidoc @@ -45,12 +45,12 @@ Returns the current global checkpoints for an index. This API is design for inte [source,ts] ---- -interface FleetGlobalCheckpointsRequest extends <> { - index: <> | <> +interface FleetGlobalCheckpointsRequest extends <> { + index: <> | <> wait_for_advance?: boolean wait_for_index?: boolean checkpoints?: FleetCheckpoint[] - timeout?: <> + timeout?: <> } ---- diff --git a/docs/reference-fleet-msearch.asciidoc b/docs/reference-fleet-msearch.asciidoc index d5377d798..467986729 100644 --- a/docs/reference-fleet-msearch.asciidoc +++ b/docs/reference-fleet-msearch.asciidoc @@ -43,17 +43,17 @@ Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/ [source,ts] ---- -interface FleetMsearchRequest extends <> { - index?: <> | <> +interface FleetMsearchRequest extends <> { + index?: <> | <> allow_no_indices?: boolean ccs_minimize_roundtrips?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_throttled?: boolean ignore_unavailable?: boolean - max_concurrent_searches?: <> - max_concurrent_shard_requests?: <> - pre_filter_shard_size?: <> - search_type?: <> + max_concurrent_searches?: <> + max_concurrent_shard_requests?: <> + pre_filter_shard_size?: <> + search_type?: <> rest_total_hits_as_int?: boolean typed_keys?: boolean wait_for_checkpoints?: FleetCheckpoint[] diff --git a/docs/reference-fleet-search.asciidoc b/docs/reference-fleet-search.asciidoc index 9f2cb2fc9..57f038d7e 100644 --- a/docs/reference-fleet-search.asciidoc +++ b/docs/reference-fleet-search.asciidoc @@ -43,35 +43,35 @@ The purpose of the fleet search api is to provide a search api where the search [source,ts] ---- -interface FleetSearchRequest extends <> { - index: <> | <> +interface FleetSearchRequest extends <> { + index: <> | <> allow_no_indices?: boolean analyzer?: string analyze_wildcard?: boolean - batched_reduce_size?: <> + batched_reduce_size?: <> ccs_minimize_roundtrips?: boolean default_operator?: QueryDslOperator df?: string - expand_wildcards?: <> + expand_wildcards?: <> ignore_throttled?: boolean ignore_unavailable?: boolean lenient?: boolean - max_concurrent_shard_requests?: <> - min_compatible_shard_node?: <> + max_concurrent_shard_requests?: <> + min_compatible_shard_node?: <> preference?: string - pre_filter_shard_size?: <> + pre_filter_shard_size?: <> request_cache?: boolean - routing?: <> - scroll?: <> - search_type?: <> - suggest_field?: <> - suggest_mode?: <> - suggest_size?: <> + routing?: <> + scroll?: <> + search_type?: <> + suggest_field?: <> + suggest_mode?: <> + suggest_size?: <> suggest_text?: string typed_keys?: boolean rest_total_hits_as_int?: boolean - _source_excludes?: <> - _source_includes?: <> + _source_excludes?: <> + _source_includes?: <> q?: string wait_for_checkpoints?: FleetCheckpoint[] allow_partial_search_results?: boolean @@ -81,30 +81,30 @@ interface FleetSearchRequest extends <> { collapse?: SearchFieldCollapse explain?: boolean ext?: Record - from?: <> + from?: <> highlight?: SearchHighlight track_total_hits?: SearchTrackHits - indices_boost?: Record<<>, <>>[] - docvalue_fields?: (QueryDslFieldAndFormat | <>)[] - min_score?: <> + indices_boost?: Record<<>, <>>[] + docvalue_fields?: (QueryDslFieldAndFormat | <>)[] + min_score?: <> post_filter?: QueryDslQueryContainer profile?: boolean query?: QueryDslQueryContainer rescore?: SearchRescore | SearchRescore[] - script_fields?: Record>> - search_after?: <> - size?: <> - slice?: <> - sort?: <> + script_fields?: Record>> + search_after?: <> + size?: <> + slice?: <> + sort?: <> _source?: SearchSourceConfig - fields?: (QueryDslFieldAndFormat | <>)[] + fields?: (QueryDslFieldAndFormat | <>)[] suggest?: SearchSuggester - terminate_after?: <> + terminate_after?: <> timeout?: string track_scores?: boolean version?: boolean seq_no_primary_term?: boolean - stored_fields?: <> + stored_fields?: <> pit?: SearchPointInTimeReference runtime_mappings?: MappingRuntimeFields stats?: string[] @@ -117,19 +117,19 @@ interface FleetSearchRequest extends <> { [source,ts] ---- interface FleetSearchResponse { - took: <> + took: <> timed_out: boolean - _shards: <> + _shards: <> hits: SearchHitsMetadata - aggregations?: Record<<>, AggregationsAggregate> - _clusters?: <> + aggregations?: Record<<>, AggregationsAggregate> + _clusters?: <> fields?: Record - max_score?: <> - num_reduce_phases?: <> + max_score?: <> + num_reduce_phases?: <> profile?: SearchProfile - pit_id?: <> - _scroll_id?: <> - suggest?: Record<<>, SearchSuggest[]> + pit_id?: <> + _scroll_id?: <> + suggest?: Record<<>, SearchSuggest[]> terminated_early?: boolean } ---- diff --git a/docs/reference-get.asciidoc b/docs/reference-get.asciidoc index 72ac6f1a0..813abe1e0 100644 --- a/docs/reference-get.asciidoc +++ b/docs/reference-get.asciidoc @@ -45,20 +45,20 @@ Get a document by its ID. Retrieves the document with the specified ID from an i [source,ts] ---- -interface GetRequest extends <> { - id: <> - index: <> +interface GetRequest extends <> { + id: <> + index: <> force_synthetic_source?: boolean preference?: string realtime?: boolean refresh?: boolean - routing?: <> + routing?: <> _source?: SearchSourceConfigParam - _source_excludes?: <> - _source_includes?: <> - stored_fields?: <> - version?: <> - version_type?: <> + _source_excludes?: <> + _source_includes?: <> + stored_fields?: <> + version?: <> + version_type?: <> } ---- diff --git a/docs/reference-get_script.asciidoc b/docs/reference-get_script.asciidoc index 0c912e325..b056d6fc4 100644 --- a/docs/reference-get_script.asciidoc +++ b/docs/reference-get_script.asciidoc @@ -45,9 +45,9 @@ Get a script or search template. Retrieves a stored script or search template. [source,ts] ---- -interface GetScriptRequest extends <> { - id: <> - master_timeout?: <> +interface GetScriptRequest extends <> { + id: <> + master_timeout?: <> } ---- @@ -57,9 +57,9 @@ interface GetScriptRequest extends <> { [source,ts] ---- interface GetScriptResponse { - _id: <> + _id: <> found: boolean - script?: <> + script?: <> } ---- diff --git a/docs/reference-get_script_context.asciidoc b/docs/reference-get_script_context.asciidoc index 2eb64c789..b1a0f567f 100644 --- a/docs/reference-get_script_context.asciidoc +++ b/docs/reference-get_script_context.asciidoc @@ -45,7 +45,7 @@ Get script contexts. Get a list of supported script contexts and their methods. [source,ts] ---- -interface GetScriptContextRequest extends <> { +interface GetScriptContextRequest extends <> { } ---- diff --git a/docs/reference-get_script_languages.asciidoc b/docs/reference-get_script_languages.asciidoc index 86a71f2f1..c80a7b88f 100644 --- a/docs/reference-get_script_languages.asciidoc +++ b/docs/reference-get_script_languages.asciidoc @@ -45,7 +45,7 @@ Get script languages. Get a list of available script types, languages, and conte [source,ts] ---- -interface GetScriptLanguagesRequest extends <> { +interface GetScriptLanguagesRequest extends <> { } ---- diff --git a/docs/reference-get_source.asciidoc b/docs/reference-get_source.asciidoc index b5c13c3ee..43a3d3e1e 100644 --- a/docs/reference-get_source.asciidoc +++ b/docs/reference-get_source.asciidoc @@ -45,19 +45,19 @@ Get a document's source. Returns the source of a document. [source,ts] ---- -interface GetSourceRequest extends <> { - id: <> - index: <> +interface GetSourceRequest extends <> { + id: <> + index: <> preference?: string realtime?: boolean refresh?: boolean - routing?: <> + routing?: <> _source?: SearchSourceConfigParam - _source_excludes?: <> - _source_includes?: <> - stored_fields?: <> - version?: <> - version_type?: <> + _source_excludes?: <> + _source_includes?: <> + stored_fields?: <> + version?: <> + version_type?: <> } ---- diff --git a/docs/reference-graph-explore.asciidoc b/docs/reference-graph-explore.asciidoc index 835e03fd6..2c3f70a24 100644 --- a/docs/reference-graph-explore.asciidoc +++ b/docs/reference-graph-explore.asciidoc @@ -45,10 +45,10 @@ Extracts and summarizes information about the documents and terms in an Elastics [source,ts] ---- -interface GraphExploreRequest extends <> { - index: <> - routing?: <> - timeout?: <> +interface GraphExploreRequest extends <> { + index: <> + routing?: <> + timeout?: <> connections?: GraphHop controls?: GraphExploreControls query?: QueryDslQueryContainer @@ -63,9 +63,9 @@ interface GraphExploreRequest extends <> ---- interface GraphExploreResponse { connections: GraphConnection[] - failures: <>[] + failures: <>[] timed_out: boolean - took: <> + took: <> vertices: GraphVertex[] } ---- diff --git a/docs/reference-health_report.asciidoc b/docs/reference-health_report.asciidoc index a19de2289..e921e030d 100644 --- a/docs/reference-health_report.asciidoc +++ b/docs/reference-health_report.asciidoc @@ -45,11 +45,11 @@ Returns the health of the cluster. [source,ts] ---- -interface HealthReportRequest extends <> { +interface HealthReportRequest extends <> { feature?: string | string[] - timeout?: <> + timeout?: <> verbose?: boolean - size?: <> + size?: <> } ---- diff --git a/docs/reference-ilm-delete_lifecycle.asciidoc b/docs/reference-ilm-delete_lifecycle.asciidoc index 925734546..6b34af6df 100644 --- a/docs/reference-ilm-delete_lifecycle.asciidoc +++ b/docs/reference-ilm-delete_lifecycle.asciidoc @@ -45,10 +45,10 @@ Deletes the specified lifecycle policy definition. You cannot delete policies th [source,ts] ---- -interface IlmDeleteLifecycleRequest extends <> { - name: <> - master_timeout?: <> - timeout?: <> +interface IlmDeleteLifecycleRequest extends <> { + name: <> + master_timeout?: <> + timeout?: <> } ---- @@ -57,6 +57,6 @@ interface IlmDeleteLifecycleRequest extends <> +type IlmDeleteLifecycleResponse = <> ---- diff --git a/docs/reference-ilm-explain_lifecycle.asciidoc b/docs/reference-ilm-explain_lifecycle.asciidoc index 239d89476..63820af98 100644 --- a/docs/reference-ilm-explain_lifecycle.asciidoc +++ b/docs/reference-ilm-explain_lifecycle.asciidoc @@ -45,12 +45,12 @@ Retrieves information about the index’s current lifecycle state, such as the c [source,ts] ---- -interface IlmExplainLifecycleRequest extends <> { - index: <> +interface IlmExplainLifecycleRequest extends <> { + index: <> only_errors?: boolean only_managed?: boolean - master_timeout?: <> - timeout?: <> + master_timeout?: <> + timeout?: <> } ---- @@ -60,7 +60,7 @@ interface IlmExplainLifecycleRequest extends <>, IlmExplainLifecycleLifecycleExplain> + indices: Record<<>, IlmExplainLifecycleLifecycleExplain> } ---- diff --git a/docs/reference-ilm-get_lifecycle.asciidoc b/docs/reference-ilm-get_lifecycle.asciidoc index 96bcc871d..9e5df441e 100644 --- a/docs/reference-ilm-get_lifecycle.asciidoc +++ b/docs/reference-ilm-get_lifecycle.asciidoc @@ -45,10 +45,10 @@ Retrieves a lifecycle policy. [source,ts] ---- -interface IlmGetLifecycleRequest extends <> { - name?: <> - master_timeout?: <> - timeout?: <> +interface IlmGetLifecycleRequest extends <> { + name?: <> + master_timeout?: <> + timeout?: <> } ---- diff --git a/docs/reference-ilm-get_status.asciidoc b/docs/reference-ilm-get_status.asciidoc index f50cff97e..d60817f81 100644 --- a/docs/reference-ilm-get_status.asciidoc +++ b/docs/reference-ilm-get_status.asciidoc @@ -45,7 +45,7 @@ Retrieves the current index lifecycle management (ILM) status. [source,ts] ---- -interface IlmGetStatusRequest extends <> { +interface IlmGetStatusRequest extends <> { } ---- @@ -55,7 +55,7 @@ interface IlmGetStatusRequest extends <> [source,ts] ---- interface IlmGetStatusResponse { - operation_mode: <> + operation_mode: <> } ---- diff --git a/docs/reference-ilm-migrate_to_data_tiers.asciidoc b/docs/reference-ilm-migrate_to_data_tiers.asciidoc index d52f80cd1..4e9a52ace 100644 --- a/docs/reference-ilm-migrate_to_data_tiers.asciidoc +++ b/docs/reference-ilm-migrate_to_data_tiers.asciidoc @@ -45,7 +45,7 @@ Switches the indices, ILM policies, and legacy, composable and component templat [source,ts] ---- -interface IlmMigrateToDataTiersRequest extends <> { +interface IlmMigrateToDataTiersRequest extends <> { dry_run?: boolean legacy_template_to_delete?: string node_attribute?: string @@ -61,7 +61,7 @@ interface IlmMigrateToDataTiersResponse { dry_run: boolean removed_legacy_template: string migrated_ilm_policies: string[] - migrated_indices: <> + migrated_indices: <> migrated_legacy_templates: string[] migrated_composable_templates: string[] migrated_component_templates: string[] diff --git a/docs/reference-ilm-move_to_step.asciidoc b/docs/reference-ilm-move_to_step.asciidoc index 6115d6857..497862306 100644 --- a/docs/reference-ilm-move_to_step.asciidoc +++ b/docs/reference-ilm-move_to_step.asciidoc @@ -45,8 +45,8 @@ Manually moves an index into the specified step and executes that step. [source,ts] ---- -interface IlmMoveToStepRequest extends <> { - index: <> +interface IlmMoveToStepRequest extends <> { + index: <> current_step: IlmMoveToStepStepKey next_step: IlmMoveToStepStepKey } @@ -57,6 +57,6 @@ interface IlmMoveToStepRequest extends <> [source,ts] ---- -type IlmMoveToStepResponse = <> +type IlmMoveToStepResponse = <> ---- diff --git a/docs/reference-ilm-put_lifecycle.asciidoc b/docs/reference-ilm-put_lifecycle.asciidoc index 9b24ba0ca..1fe6b584b 100644 --- a/docs/reference-ilm-put_lifecycle.asciidoc +++ b/docs/reference-ilm-put_lifecycle.asciidoc @@ -45,10 +45,10 @@ Creates a lifecycle policy. If the specified policy exists, the policy is replac [source,ts] ---- -interface IlmPutLifecycleRequest extends <> { - name: <> - master_timeout?: <> - timeout?: <> +interface IlmPutLifecycleRequest extends <> { + name: <> + master_timeout?: <> + timeout?: <> policy?: IlmPolicy } ---- @@ -58,6 +58,6 @@ interface IlmPutLifecycleRequest extends <> +type IlmPutLifecycleResponse = <> ---- diff --git a/docs/reference-ilm-remove_policy.asciidoc b/docs/reference-ilm-remove_policy.asciidoc index 8bddad3d3..961ac5ead 100644 --- a/docs/reference-ilm-remove_policy.asciidoc +++ b/docs/reference-ilm-remove_policy.asciidoc @@ -45,8 +45,8 @@ Removes the assigned lifecycle policy and stops managing the specified index [source,ts] ---- -interface IlmRemovePolicyRequest extends <> { - index: <> +interface IlmRemovePolicyRequest extends <> { + index: <> } ---- @@ -56,7 +56,7 @@ interface IlmRemovePolicyRequest extends <>[] + failed_indexes: <>[] has_failures: boolean } ---- diff --git a/docs/reference-ilm-retry.asciidoc b/docs/reference-ilm-retry.asciidoc index 6370b4858..1da83eff7 100644 --- a/docs/reference-ilm-retry.asciidoc +++ b/docs/reference-ilm-retry.asciidoc @@ -45,8 +45,8 @@ Retries executing the policy for an index that is in the ERROR step. [source,ts] ---- -interface IlmRetryRequest extends <> { - index: <> +interface IlmRetryRequest extends <> { + index: <> } ---- @@ -55,6 +55,6 @@ interface IlmRetryRequest extends <> { [source,ts] ---- -type IlmRetryResponse = <> +type IlmRetryResponse = <> ---- diff --git a/docs/reference-ilm-start.asciidoc b/docs/reference-ilm-start.asciidoc index b0f3cb7a4..6ad667696 100644 --- a/docs/reference-ilm-start.asciidoc +++ b/docs/reference-ilm-start.asciidoc @@ -45,9 +45,9 @@ Start the index lifecycle management (ILM) plugin. [source,ts] ---- -interface IlmStartRequest extends <> { - master_timeout?: <> - timeout?: <> +interface IlmStartRequest extends <> { + master_timeout?: <> + timeout?: <> } ---- @@ -56,6 +56,6 @@ interface IlmStartRequest extends <> { [source,ts] ---- -type IlmStartResponse = <> +type IlmStartResponse = <> ---- diff --git a/docs/reference-ilm-stop.asciidoc b/docs/reference-ilm-stop.asciidoc index 41233ac6a..64f08b814 100644 --- a/docs/reference-ilm-stop.asciidoc +++ b/docs/reference-ilm-stop.asciidoc @@ -45,9 +45,9 @@ Halts all lifecycle management operations and stops the index lifecycle manageme [source,ts] ---- -interface IlmStopRequest extends <> { - master_timeout?: <> - timeout?: <> +interface IlmStopRequest extends <> { + master_timeout?: <> + timeout?: <> } ---- @@ -56,6 +56,6 @@ interface IlmStopRequest extends <> { [source,ts] ---- -type IlmStopResponse = <> +type IlmStopResponse = <> ---- diff --git a/docs/reference-index.asciidoc b/docs/reference-index.asciidoc index ca4d09d09..ec1810121 100644 --- a/docs/reference-index.asciidoc +++ b/docs/reference-index.asciidoc @@ -45,19 +45,19 @@ Index a document. Adds a JSON document to the specified data stream or index and [source,ts] ---- -interface IndexRequest extends <> { - id?: <> - index: <> - if_primary_term?: <> - if_seq_no?: <> - op_type?: <> +interface IndexRequest extends <> { + id?: <> + index: <> + if_primary_term?: <> + if_seq_no?: <> + op_type?: <> pipeline?: string - refresh?: <> - routing?: <> - timeout?: <> - version?: <> - version_type?: <> - wait_for_active_shards?: <> + refresh?: <> + routing?: <> + timeout?: <> + version?: <> + version_type?: <> + wait_for_active_shards?: <> require_alias?: boolean document?: TDocument } @@ -68,6 +68,6 @@ interface IndexRequest extends <> +type IndexResponse = <> ---- diff --git a/docs/reference-indices-add_block.asciidoc b/docs/reference-indices-add_block.asciidoc index 9d5747755..866d4bb7a 100644 --- a/docs/reference-indices-add_block.asciidoc +++ b/docs/reference-indices-add_block.asciidoc @@ -45,14 +45,14 @@ Add an index block. Limits the operations allowed on an index by blocking specif [source,ts] ---- -interface IndicesAddBlockRequest extends <> { - index: <> +interface IndicesAddBlockRequest extends <> { + index: <> block: IndicesAddBlockIndicesBlockOptions allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_unavailable?: boolean - master_timeout?: <> - timeout?: <> + master_timeout?: <> + timeout?: <> } ---- diff --git a/docs/reference-indices-analyze.asciidoc b/docs/reference-indices-analyze.asciidoc index f64be70ec..d8e0078be 100644 --- a/docs/reference-indices-analyze.asciidoc +++ b/docs/reference-indices-analyze.asciidoc @@ -45,13 +45,13 @@ Get tokens from text analysis. The analyze API performs [analysis](https://www.e [source,ts] ---- -interface IndicesAnalyzeRequest extends <> { - index?: <> +interface IndicesAnalyzeRequest extends <> { + index?: <> analyzer?: string attributes?: string[] char_filter?: AnalysisCharFilter[] explain?: boolean - field?: <> + field?: <> filter?: AnalysisTokenFilter[] normalizer?: string text?: IndicesAnalyzeTextToAnalyze diff --git a/docs/reference-indices-clear_cache.asciidoc b/docs/reference-indices-clear_cache.asciidoc index 7ca4affcf..9c602951d 100644 --- a/docs/reference-indices-clear_cache.asciidoc +++ b/docs/reference-indices-clear_cache.asciidoc @@ -45,12 +45,12 @@ Clears the caches of one or more indices. For data streams, the API clears the c [source,ts] ---- -interface IndicesClearCacheRequest extends <> { - index?: <> +interface IndicesClearCacheRequest extends <> { + index?: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> fielddata?: boolean - fields?: <> + fields?: <> ignore_unavailable?: boolean query?: boolean request?: boolean @@ -62,6 +62,6 @@ interface IndicesClearCacheRequest extends <> +type IndicesClearCacheResponse = <> ---- diff --git a/docs/reference-indices-clone.asciidoc b/docs/reference-indices-clone.asciidoc index ab43ec562..ed2accd29 100644 --- a/docs/reference-indices-clone.asciidoc +++ b/docs/reference-indices-clone.asciidoc @@ -45,13 +45,13 @@ Clones an existing index. [source,ts] ---- -interface IndicesCloneRequest extends <> { - index: <> - target: <> - master_timeout?: <> - timeout?: <> - wait_for_active_shards?: <> - aliases?: Record<<>, IndicesAlias> +interface IndicesCloneRequest extends <> { + index: <> + target: <> + master_timeout?: <> + timeout?: <> + wait_for_active_shards?: <> + aliases?: Record<<>, IndicesAlias> settings?: Record } ---- @@ -63,7 +63,7 @@ interface IndicesCloneRequest extends <> ---- interface IndicesCloneResponse { acknowledged: boolean - index: <> + index: <> shards_acknowledged: boolean } ---- diff --git a/docs/reference-indices-close.asciidoc b/docs/reference-indices-close.asciidoc index 469eec0d1..3ae85506e 100644 --- a/docs/reference-indices-close.asciidoc +++ b/docs/reference-indices-close.asciidoc @@ -45,14 +45,14 @@ Closes an index. [source,ts] ---- -interface IndicesCloseRequest extends <> { - index: <> +interface IndicesCloseRequest extends <> { + index: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_unavailable?: boolean - master_timeout?: <> - timeout?: <> - wait_for_active_shards?: <> + master_timeout?: <> + timeout?: <> + wait_for_active_shards?: <> } ---- @@ -63,7 +63,7 @@ interface IndicesCloseRequest extends <> ---- interface IndicesCloseResponse { acknowledged: boolean - indices: Record<<>, IndicesCloseCloseIndexResult> + indices: Record<<>, IndicesCloseCloseIndexResult> shards_acknowledged: boolean } ---- diff --git a/docs/reference-indices-create.asciidoc b/docs/reference-indices-create.asciidoc index 608828168..8fdf6410e 100644 --- a/docs/reference-indices-create.asciidoc +++ b/docs/reference-indices-create.asciidoc @@ -45,12 +45,12 @@ Create an index. Creates a new index. [source,ts] ---- -interface IndicesCreateRequest extends <> { - index: <> - master_timeout?: <> - timeout?: <> - wait_for_active_shards?: <> - aliases?: Record<<>, IndicesAlias> +interface IndicesCreateRequest extends <> { + index: <> + master_timeout?: <> + timeout?: <> + wait_for_active_shards?: <> + aliases?: Record<<>, IndicesAlias> mappings?: MappingTypeMapping settings?: IndicesIndexSettings } @@ -62,7 +62,7 @@ interface IndicesCreateRequest extends <> [source,ts] ---- interface IndicesCreateResponse { - index: <> + index: <> shards_acknowledged: boolean acknowledged: boolean } diff --git a/docs/reference-indices-create_data_stream.asciidoc b/docs/reference-indices-create_data_stream.asciidoc index 0465ed99b..ead27c8d6 100644 --- a/docs/reference-indices-create_data_stream.asciidoc +++ b/docs/reference-indices-create_data_stream.asciidoc @@ -45,10 +45,10 @@ Create a data stream. Creates a data stream. You must have a matching index temp [source,ts] ---- -interface IndicesCreateDataStreamRequest extends <> { - name: <> - master_timeout?: <> - timeout?: <> +interface IndicesCreateDataStreamRequest extends <> { + name: <> + master_timeout?: <> + timeout?: <> } ---- @@ -57,6 +57,6 @@ interface IndicesCreateDataStreamRequest extends <> +type IndicesCreateDataStreamResponse = <> ---- diff --git a/docs/reference-indices-data_streams_stats.asciidoc b/docs/reference-indices-data_streams_stats.asciidoc index 25f0b5028..ceb73336d 100644 --- a/docs/reference-indices-data_streams_stats.asciidoc +++ b/docs/reference-indices-data_streams_stats.asciidoc @@ -45,9 +45,9 @@ Get data stream stats. Retrieves statistics for one or more data streams. [source,ts] ---- -interface IndicesDataStreamsStatsRequest extends <> { - name?: <> - expand_wildcards?: <> +interface IndicesDataStreamsStatsRequest extends <> { + name?: <> + expand_wildcards?: <> } ---- @@ -57,12 +57,12 @@ interface IndicesDataStreamsStatsRequest extends <> - backing_indices: <> - data_stream_count: <> + _shards: <> + backing_indices: <> + data_stream_count: <> data_streams: IndicesDataStreamsStatsDataStreamsStatsItem[] - total_store_sizes?: <> - total_store_size_bytes: <> + total_store_sizes?: <> + total_store_size_bytes: <> } ---- diff --git a/docs/reference-indices-delete.asciidoc b/docs/reference-indices-delete.asciidoc index f135f3a89..b44e8efbd 100644 --- a/docs/reference-indices-delete.asciidoc +++ b/docs/reference-indices-delete.asciidoc @@ -45,13 +45,13 @@ Delete indices. Deletes one or more indices. [source,ts] ---- -interface IndicesDeleteRequest extends <> { - index: <> +interface IndicesDeleteRequest extends <> { + index: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_unavailable?: boolean - master_timeout?: <> - timeout?: <> + master_timeout?: <> + timeout?: <> } ---- @@ -60,6 +60,6 @@ interface IndicesDeleteRequest extends <> [source,ts] ---- -type IndicesDeleteResponse = <> +type IndicesDeleteResponse = <> ---- diff --git a/docs/reference-indices-delete_alias.asciidoc b/docs/reference-indices-delete_alias.asciidoc index b49895eb1..dbeca577c 100644 --- a/docs/reference-indices-delete_alias.asciidoc +++ b/docs/reference-indices-delete_alias.asciidoc @@ -45,11 +45,11 @@ Delete an alias. Removes a data stream or index from an alias. [source,ts] ---- -interface IndicesDeleteAliasRequest extends <> { - index: <> - name: <> - master_timeout?: <> - timeout?: <> +interface IndicesDeleteAliasRequest extends <> { + index: <> + name: <> + master_timeout?: <> + timeout?: <> } ---- @@ -58,6 +58,6 @@ interface IndicesDeleteAliasRequest extends <> +type IndicesDeleteAliasResponse = <> ---- diff --git a/docs/reference-indices-delete_data_lifecycle.asciidoc b/docs/reference-indices-delete_data_lifecycle.asciidoc index 07e8c3a33..e0141718d 100644 --- a/docs/reference-indices-delete_data_lifecycle.asciidoc +++ b/docs/reference-indices-delete_data_lifecycle.asciidoc @@ -45,11 +45,11 @@ Delete data stream lifecycles. Removes the data stream lifecycle from a data str [source,ts] ---- -interface IndicesDeleteDataLifecycleRequest extends <> { - name: <> - expand_wildcards?: <> - master_timeout?: <> - timeout?: <> +interface IndicesDeleteDataLifecycleRequest extends <> { + name: <> + expand_wildcards?: <> + master_timeout?: <> + timeout?: <> } ---- @@ -58,6 +58,6 @@ interface IndicesDeleteDataLifecycleRequest extends <> +type IndicesDeleteDataLifecycleResponse = <> ---- diff --git a/docs/reference-indices-delete_data_stream.asciidoc b/docs/reference-indices-delete_data_stream.asciidoc index aedd05612..6e48d68d4 100644 --- a/docs/reference-indices-delete_data_stream.asciidoc +++ b/docs/reference-indices-delete_data_stream.asciidoc @@ -45,10 +45,10 @@ Delete data streams. Deletes one or more data streams and their backing indices. [source,ts] ---- -interface IndicesDeleteDataStreamRequest extends <> { - name: <> - master_timeout?: <> - expand_wildcards?: <> +interface IndicesDeleteDataStreamRequest extends <> { + name: <> + master_timeout?: <> + expand_wildcards?: <> } ---- @@ -57,6 +57,6 @@ interface IndicesDeleteDataStreamRequest extends <> +type IndicesDeleteDataStreamResponse = <> ---- diff --git a/docs/reference-indices-delete_index_template.asciidoc b/docs/reference-indices-delete_index_template.asciidoc index 72d258219..238676df4 100644 --- a/docs/reference-indices-delete_index_template.asciidoc +++ b/docs/reference-indices-delete_index_template.asciidoc @@ -45,10 +45,10 @@ Delete an index template. The provided may contain multiple tem [source,ts] ---- -interface IndicesDeleteIndexTemplateRequest extends <> { - name: <> - master_timeout?: <> - timeout?: <> +interface IndicesDeleteIndexTemplateRequest extends <> { + name: <> + master_timeout?: <> + timeout?: <> } ---- @@ -57,6 +57,6 @@ interface IndicesDeleteIndexTemplateRequest extends <> +type IndicesDeleteIndexTemplateResponse = <> ---- diff --git a/docs/reference-indices-delete_template.asciidoc b/docs/reference-indices-delete_template.asciidoc index 049f04d30..c75d68e68 100644 --- a/docs/reference-indices-delete_template.asciidoc +++ b/docs/reference-indices-delete_template.asciidoc @@ -45,10 +45,10 @@ Deletes a legacy index template. [source,ts] ---- -interface IndicesDeleteTemplateRequest extends <> { - name: <> - master_timeout?: <> - timeout?: <> +interface IndicesDeleteTemplateRequest extends <> { + name: <> + master_timeout?: <> + timeout?: <> } ---- @@ -57,6 +57,6 @@ interface IndicesDeleteTemplateRequest extends <> +type IndicesDeleteTemplateResponse = <> ---- diff --git a/docs/reference-indices-disk_usage.asciidoc b/docs/reference-indices-disk_usage.asciidoc index 5e10b0728..5016b03cb 100644 --- a/docs/reference-indices-disk_usage.asciidoc +++ b/docs/reference-indices-disk_usage.asciidoc @@ -45,10 +45,10 @@ Analyzes the disk usage of each field of an index or data stream. [source,ts] ---- -interface IndicesDiskUsageRequest extends <> { - index: <> +interface IndicesDiskUsageRequest extends <> { + index: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> flush?: boolean ignore_unavailable?: boolean run_expensive_tasks?: boolean diff --git a/docs/reference-indices-downsample.asciidoc b/docs/reference-indices-downsample.asciidoc index 61589e167..4c4e94872 100644 --- a/docs/reference-indices-downsample.asciidoc +++ b/docs/reference-indices-downsample.asciidoc @@ -45,9 +45,9 @@ Aggregates a time series (TSDS) index and stores pre-computed statistical summar [source,ts] ---- -interface IndicesDownsampleRequest extends <> { - index: <> - target_index: <> +interface IndicesDownsampleRequest extends <> { + index: <> + target_index: <> config?: IndicesDownsampleConfig } ---- diff --git a/docs/reference-indices-exists.asciidoc b/docs/reference-indices-exists.asciidoc index ffdf4691f..24be1ef39 100644 --- a/docs/reference-indices-exists.asciidoc +++ b/docs/reference-indices-exists.asciidoc @@ -45,10 +45,10 @@ Check indices. Checks if one or more indices, index aliases, or data streams exi [source,ts] ---- -interface IndicesExistsRequest extends <> { - index: <> +interface IndicesExistsRequest extends <> { + index: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> flat_settings?: boolean ignore_unavailable?: boolean include_defaults?: boolean diff --git a/docs/reference-indices-exists_alias.asciidoc b/docs/reference-indices-exists_alias.asciidoc index 5e262cc86..0b9011c65 100644 --- a/docs/reference-indices-exists_alias.asciidoc +++ b/docs/reference-indices-exists_alias.asciidoc @@ -45,11 +45,11 @@ Check aliases. Checks if one or more data stream or index aliases exist. [source,ts] ---- -interface IndicesExistsAliasRequest extends <> { - name: <> - index?: <> +interface IndicesExistsAliasRequest extends <> { + name: <> + index?: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_unavailable?: boolean local?: boolean } diff --git a/docs/reference-indices-exists_index_template.asciidoc b/docs/reference-indices-exists_index_template.asciidoc index ea8105dac..bd78e5a5b 100644 --- a/docs/reference-indices-exists_index_template.asciidoc +++ b/docs/reference-indices-exists_index_template.asciidoc @@ -45,9 +45,9 @@ Returns information about whether a particular index template exists. [source,ts] ---- -interface IndicesExistsIndexTemplateRequest extends <> { - name: <> - master_timeout?: <> +interface IndicesExistsIndexTemplateRequest extends <> { + name: <> + master_timeout?: <> } ---- diff --git a/docs/reference-indices-exists_template.asciidoc b/docs/reference-indices-exists_template.asciidoc index e9179a65c..297a462e7 100644 --- a/docs/reference-indices-exists_template.asciidoc +++ b/docs/reference-indices-exists_template.asciidoc @@ -45,11 +45,11 @@ Check existence of index templates. Returns information about whether a particul [source,ts] ---- -interface IndicesExistsTemplateRequest extends <> { - name: <> +interface IndicesExistsTemplateRequest extends <> { + name: <> flat_settings?: boolean local?: boolean - master_timeout?: <> + master_timeout?: <> } ---- diff --git a/docs/reference-indices-explain_data_lifecycle.asciidoc b/docs/reference-indices-explain_data_lifecycle.asciidoc index bda3ecf8f..19edd9e5d 100644 --- a/docs/reference-indices-explain_data_lifecycle.asciidoc +++ b/docs/reference-indices-explain_data_lifecycle.asciidoc @@ -45,10 +45,10 @@ Get the status for a data stream lifecycle. Retrieves information about an index [source,ts] ---- -interface IndicesExplainDataLifecycleRequest extends <> { - index: <> +interface IndicesExplainDataLifecycleRequest extends <> { + index: <> include_defaults?: boolean - master_timeout?: <> + master_timeout?: <> } ---- @@ -58,7 +58,7 @@ interface IndicesExplainDataLifecycleRequest extends <>, IndicesExplainDataLifecycleDataStreamLifecycleExplain> + indices: Record<<>, IndicesExplainDataLifecycleDataStreamLifecycleExplain> } ---- diff --git a/docs/reference-indices-field_usage_stats.asciidoc b/docs/reference-indices-field_usage_stats.asciidoc index 3f03c310d..75d62ae1a 100644 --- a/docs/reference-indices-field_usage_stats.asciidoc +++ b/docs/reference-indices-field_usage_stats.asciidoc @@ -45,15 +45,15 @@ Returns field usage information for each shard and field of an index. [source,ts] ---- -interface IndicesFieldUsageStatsRequest extends <> { - index: <> +interface IndicesFieldUsageStatsRequest extends <> { + index: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_unavailable?: boolean - fields?: <> - master_timeout?: <> - timeout?: <> - wait_for_active_shards?: <> + fields?: <> + master_timeout?: <> + timeout?: <> + wait_for_active_shards?: <> } ---- diff --git a/docs/reference-indices-flush.asciidoc b/docs/reference-indices-flush.asciidoc index 5176d9909..ac43d259d 100644 --- a/docs/reference-indices-flush.asciidoc +++ b/docs/reference-indices-flush.asciidoc @@ -45,10 +45,10 @@ Flushes one or more data streams or indices. [source,ts] ---- -interface IndicesFlushRequest extends <> { - index?: <> +interface IndicesFlushRequest extends <> { + index?: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> force?: boolean ignore_unavailable?: boolean wait_if_ongoing?: boolean @@ -60,6 +60,6 @@ interface IndicesFlushRequest extends <> [source,ts] ---- -type IndicesFlushResponse = <> +type IndicesFlushResponse = <> ---- diff --git a/docs/reference-indices-forcemerge.asciidoc b/docs/reference-indices-forcemerge.asciidoc index 2c72626f0..2b542103f 100644 --- a/docs/reference-indices-forcemerge.asciidoc +++ b/docs/reference-indices-forcemerge.asciidoc @@ -45,13 +45,13 @@ Performs the force merge operation on one or more indices. [source,ts] ---- -interface IndicesForcemergeRequest extends <> { - index?: <> +interface IndicesForcemergeRequest extends <> { + index?: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> flush?: boolean ignore_unavailable?: boolean - max_num_segments?: <> + max_num_segments?: <> only_expunge_deletes?: boolean wait_for_completion?: boolean } diff --git a/docs/reference-indices-get.asciidoc b/docs/reference-indices-get.asciidoc index 48301abd8..3834a71b8 100644 --- a/docs/reference-indices-get.asciidoc +++ b/docs/reference-indices-get.asciidoc @@ -45,15 +45,15 @@ Get index information. Returns information about one or more indices. For data s [source,ts] ---- -interface IndicesGetRequest extends <> { - index: <> +interface IndicesGetRequest extends <> { + index: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> flat_settings?: boolean ignore_unavailable?: boolean include_defaults?: boolean local?: boolean - master_timeout?: <> + master_timeout?: <> features?: IndicesGetFeatures } ---- @@ -63,6 +63,6 @@ interface IndicesGetRequest extends <> { [source,ts] ---- -type IndicesGetResponse = Record<<>, IndicesIndexState> +type IndicesGetResponse = Record<<>, IndicesIndexState> ---- diff --git a/docs/reference-indices-get_alias.asciidoc b/docs/reference-indices-get_alias.asciidoc index 6c68ec26c..ca16ce573 100644 --- a/docs/reference-indices-get_alias.asciidoc +++ b/docs/reference-indices-get_alias.asciidoc @@ -45,11 +45,11 @@ Get aliases. Retrieves information for one or more data stream or index aliases. [source,ts] ---- -interface IndicesGetAliasRequest extends <> { - name?: <> - index?: <> +interface IndicesGetAliasRequest extends <> { + name?: <> + index?: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_unavailable?: boolean local?: boolean } @@ -60,6 +60,6 @@ interface IndicesGetAliasRequest extends <>, IndicesGetAliasIndexAliases> +type IndicesGetAliasResponse = Record<<>, IndicesGetAliasIndexAliases> ---- diff --git a/docs/reference-indices-get_data_lifecycle.asciidoc b/docs/reference-indices-get_data_lifecycle.asciidoc index 72044e8b3..b5efebe51 100644 --- a/docs/reference-indices-get_data_lifecycle.asciidoc +++ b/docs/reference-indices-get_data_lifecycle.asciidoc @@ -45,11 +45,11 @@ Get data stream lifecycles. Retrieves the data stream lifecycle configuration of [source,ts] ---- -interface IndicesGetDataLifecycleRequest extends <> { - name: <> - expand_wildcards?: <> +interface IndicesGetDataLifecycleRequest extends <> { + name: <> + expand_wildcards?: <> include_defaults?: boolean - master_timeout?: <> + master_timeout?: <> } ---- diff --git a/docs/reference-indices-get_data_stream.asciidoc b/docs/reference-indices-get_data_stream.asciidoc index 12f4796c1..8fe42fb73 100644 --- a/docs/reference-indices-get_data_stream.asciidoc +++ b/docs/reference-indices-get_data_stream.asciidoc @@ -45,11 +45,11 @@ Get data streams. Retrieves information about one or more data streams. [source,ts] ---- -interface IndicesGetDataStreamRequest extends <> { - name?: <> - expand_wildcards?: <> +interface IndicesGetDataStreamRequest extends <> { + name?: <> + expand_wildcards?: <> include_defaults?: boolean - master_timeout?: <> + master_timeout?: <> verbose?: boolean } ---- diff --git a/docs/reference-indices-get_field_mapping.asciidoc b/docs/reference-indices-get_field_mapping.asciidoc index e3075f196..a7fcf1e38 100644 --- a/docs/reference-indices-get_field_mapping.asciidoc +++ b/docs/reference-indices-get_field_mapping.asciidoc @@ -45,11 +45,11 @@ Get mapping definitions. Retrieves mapping definitions for one or more fields. F [source,ts] ---- -interface IndicesGetFieldMappingRequest extends <> { - fields: <> - index?: <> +interface IndicesGetFieldMappingRequest extends <> { + fields: <> + index?: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_unavailable?: boolean include_defaults?: boolean local?: boolean @@ -61,6 +61,6 @@ interface IndicesGetFieldMappingRequest extends <>, IndicesGetFieldMappingTypeFieldMappings> +type IndicesGetFieldMappingResponse = Record<<>, IndicesGetFieldMappingTypeFieldMappings> ---- diff --git a/docs/reference-indices-get_index_template.asciidoc b/docs/reference-indices-get_index_template.asciidoc index ade7d6aaa..a34459df3 100644 --- a/docs/reference-indices-get_index_template.asciidoc +++ b/docs/reference-indices-get_index_template.asciidoc @@ -45,11 +45,11 @@ Get index templates. Returns information about one or more index templates. [source,ts] ---- -interface IndicesGetIndexTemplateRequest extends <> { - name?: <> +interface IndicesGetIndexTemplateRequest extends <> { + name?: <> local?: boolean flat_settings?: boolean - master_timeout?: <> + master_timeout?: <> include_defaults?: boolean } ---- diff --git a/docs/reference-indices-get_mapping.asciidoc b/docs/reference-indices-get_mapping.asciidoc index b7cf4441d..5771704b0 100644 --- a/docs/reference-indices-get_mapping.asciidoc +++ b/docs/reference-indices-get_mapping.asciidoc @@ -45,13 +45,13 @@ Get mapping definitions. Retrieves mapping definitions for one or more indices. [source,ts] ---- -interface IndicesGetMappingRequest extends <> { - index?: <> +interface IndicesGetMappingRequest extends <> { + index?: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_unavailable?: boolean local?: boolean - master_timeout?: <> + master_timeout?: <> } ---- @@ -60,6 +60,6 @@ interface IndicesGetMappingRequest extends <>, IndicesGetMappingIndexMappingRecord> +type IndicesGetMappingResponse = Record<<>, IndicesGetMappingIndexMappingRecord> ---- diff --git a/docs/reference-indices-get_settings.asciidoc b/docs/reference-indices-get_settings.asciidoc index d39fb0708..9298342b7 100644 --- a/docs/reference-indices-get_settings.asciidoc +++ b/docs/reference-indices-get_settings.asciidoc @@ -45,16 +45,16 @@ Get index settings. Returns setting information for one or more indices. For dat [source,ts] ---- -interface IndicesGetSettingsRequest extends <> { - index?: <> - name?: <> +interface IndicesGetSettingsRequest extends <> { + index?: <> + name?: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> flat_settings?: boolean ignore_unavailable?: boolean include_defaults?: boolean local?: boolean - master_timeout?: <> + master_timeout?: <> } ---- @@ -63,6 +63,6 @@ interface IndicesGetSettingsRequest extends <>, IndicesIndexState> +type IndicesGetSettingsResponse = Record<<>, IndicesIndexState> ---- diff --git a/docs/reference-indices-get_template.asciidoc b/docs/reference-indices-get_template.asciidoc index aed4e1f2d..06ee14ff0 100644 --- a/docs/reference-indices-get_template.asciidoc +++ b/docs/reference-indices-get_template.asciidoc @@ -45,11 +45,11 @@ Get index templates. Retrieves information about one or more index templates. [source,ts] ---- -interface IndicesGetTemplateRequest extends <> { - name?: <> +interface IndicesGetTemplateRequest extends <> { + name?: <> flat_settings?: boolean local?: boolean - master_timeout?: <> + master_timeout?: <> } ---- diff --git a/docs/reference-indices-migrate_to_data_stream.asciidoc b/docs/reference-indices-migrate_to_data_stream.asciidoc index a12cd72f2..648e109c4 100644 --- a/docs/reference-indices-migrate_to_data_stream.asciidoc +++ b/docs/reference-indices-migrate_to_data_stream.asciidoc @@ -45,10 +45,10 @@ Convert an index alias to a data stream. Converts an index alias to a data strea [source,ts] ---- -interface IndicesMigrateToDataStreamRequest extends <> { - name: <> - master_timeout?: <> - timeout?: <> +interface IndicesMigrateToDataStreamRequest extends <> { + name: <> + master_timeout?: <> + timeout?: <> } ---- @@ -57,6 +57,6 @@ interface IndicesMigrateToDataStreamRequest extends <> +type IndicesMigrateToDataStreamResponse = <> ---- diff --git a/docs/reference-indices-modify_data_stream.asciidoc b/docs/reference-indices-modify_data_stream.asciidoc index 0f3f14e81..dc78a293c 100644 --- a/docs/reference-indices-modify_data_stream.asciidoc +++ b/docs/reference-indices-modify_data_stream.asciidoc @@ -45,7 +45,7 @@ Update data streams. Performs one or more data stream modification actions in a [source,ts] ---- -interface IndicesModifyDataStreamRequest extends <> { +interface IndicesModifyDataStreamRequest extends <> { actions: IndicesModifyDataStreamAction[] } ---- @@ -55,6 +55,6 @@ interface IndicesModifyDataStreamRequest extends <> +type IndicesModifyDataStreamResponse = <> ---- diff --git a/docs/reference-indices-open.asciidoc b/docs/reference-indices-open.asciidoc index a2cde94a7..275d6e05a 100644 --- a/docs/reference-indices-open.asciidoc +++ b/docs/reference-indices-open.asciidoc @@ -45,14 +45,14 @@ Opens a closed index. For data streams, the API opens any closed backing indices [source,ts] ---- -interface IndicesOpenRequest extends <> { - index: <> +interface IndicesOpenRequest extends <> { + index: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_unavailable?: boolean - master_timeout?: <> - timeout?: <> - wait_for_active_shards?: <> + master_timeout?: <> + timeout?: <> + wait_for_active_shards?: <> } ---- diff --git a/docs/reference-indices-promote_data_stream.asciidoc b/docs/reference-indices-promote_data_stream.asciidoc index 1d1f918c9..9e9b30ceb 100644 --- a/docs/reference-indices-promote_data_stream.asciidoc +++ b/docs/reference-indices-promote_data_stream.asciidoc @@ -45,9 +45,9 @@ Promotes a data stream from a replicated data stream managed by CCR to a regular [source,ts] ---- -interface IndicesPromoteDataStreamRequest extends <> { - name: <> - master_timeout?: <> +interface IndicesPromoteDataStreamRequest extends <> { + name: <> + master_timeout?: <> } ---- diff --git a/docs/reference-indices-put_alias.asciidoc b/docs/reference-indices-put_alias.asciidoc index a273d8e66..132bbc268 100644 --- a/docs/reference-indices-put_alias.asciidoc +++ b/docs/reference-indices-put_alias.asciidoc @@ -45,16 +45,16 @@ Create or update an alias. Adds a data stream or index to an alias. [source,ts] ---- -interface IndicesPutAliasRequest extends <> { - index: <> - name: <> - master_timeout?: <> - timeout?: <> +interface IndicesPutAliasRequest extends <> { + index: <> + name: <> + master_timeout?: <> + timeout?: <> filter?: QueryDslQueryContainer - index_routing?: <> + index_routing?: <> is_write_index?: boolean - routing?: <> - search_routing?: <> + routing?: <> + search_routing?: <> } ---- @@ -63,6 +63,6 @@ interface IndicesPutAliasRequest extends <> +type IndicesPutAliasResponse = <> ---- diff --git a/docs/reference-indices-put_data_lifecycle.asciidoc b/docs/reference-indices-put_data_lifecycle.asciidoc index 02129034c..65c278d07 100644 --- a/docs/reference-indices-put_data_lifecycle.asciidoc +++ b/docs/reference-indices-put_data_lifecycle.asciidoc @@ -45,12 +45,12 @@ Update data stream lifecycles. Update the data stream lifecycle of the specified [source,ts] ---- -interface IndicesPutDataLifecycleRequest extends <> { - name: <> - expand_wildcards?: <> - master_timeout?: <> - timeout?: <> - data_retention?: <> +interface IndicesPutDataLifecycleRequest extends <> { + name: <> + expand_wildcards?: <> + master_timeout?: <> + timeout?: <> + data_retention?: <> downsampling?: IndicesDataStreamLifecycleDownsampling } ---- @@ -60,6 +60,6 @@ interface IndicesPutDataLifecycleRequest extends <> +type IndicesPutDataLifecycleResponse = <> ---- diff --git a/docs/reference-indices-put_index_template.asciidoc b/docs/reference-indices-put_index_template.asciidoc index 994c31846..ec471728f 100644 --- a/docs/reference-indices-put_index_template.asciidoc +++ b/docs/reference-indices-put_index_template.asciidoc @@ -45,18 +45,18 @@ Create or update an index template. Index templates define settings, mappings, a [source,ts] ---- -interface IndicesPutIndexTemplateRequest extends <> { - name: <> +interface IndicesPutIndexTemplateRequest extends <> { + name: <> create?: boolean - master_timeout?: <> + master_timeout?: <> cause?: string - index_patterns?: <> - composed_of?: <>[] + index_patterns?: <> + composed_of?: <>[] template?: IndicesPutIndexTemplateIndexTemplateMapping data_stream?: IndicesDataStreamVisibility - priority?: <> - version?: <> - _meta?: <> + priority?: <> + version?: <> + _meta?: <> allow_auto_create?: boolean ignore_missing_component_templates?: string[] deprecated?: boolean @@ -68,6 +68,6 @@ interface IndicesPutIndexTemplateRequest extends <> +type IndicesPutIndexTemplateResponse = <> ---- diff --git a/docs/reference-indices-put_mapping.asciidoc b/docs/reference-indices-put_mapping.asciidoc index ada522272..afb8d687f 100644 --- a/docs/reference-indices-put_mapping.asciidoc +++ b/docs/reference-indices-put_mapping.asciidoc @@ -45,22 +45,22 @@ Update field mappings. Adds new fields to an existing data stream or index. You [source,ts] ---- -interface IndicesPutMappingRequest extends <> { - index: <> +interface IndicesPutMappingRequest extends <> { + index: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_unavailable?: boolean - master_timeout?: <> - timeout?: <> + master_timeout?: <> + timeout?: <> write_index_only?: boolean date_detection?: boolean dynamic?: MappingDynamicMapping dynamic_date_formats?: string[] dynamic_templates?: Record | Record[] _field_names?: MappingFieldNamesField - _meta?: <> + _meta?: <> numeric_detection?: boolean - properties?: Record<<>, MappingProperty> + properties?: Record<<>, MappingProperty> _routing?: MappingRoutingField _source?: MappingSourceField runtime?: MappingRuntimeFields @@ -72,6 +72,6 @@ interface IndicesPutMappingRequest extends <> +type IndicesPutMappingResponse = <> ---- diff --git a/docs/reference-indices-put_settings.asciidoc b/docs/reference-indices-put_settings.asciidoc index 2feb47509..9fe0434f8 100644 --- a/docs/reference-indices-put_settings.asciidoc +++ b/docs/reference-indices-put_settings.asciidoc @@ -45,15 +45,15 @@ Update index settings. Changes dynamic index settings in real time. For data str [source,ts] ---- -interface IndicesPutSettingsRequest extends <> { - index?: <> +interface IndicesPutSettingsRequest extends <> { + index?: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> flat_settings?: boolean ignore_unavailable?: boolean - master_timeout?: <> + master_timeout?: <> preserve_existing?: boolean - timeout?: <> + timeout?: <> settings?: IndicesIndexSettings } ---- @@ -63,6 +63,6 @@ interface IndicesPutSettingsRequest extends <> +type IndicesPutSettingsResponse = <> ---- diff --git a/docs/reference-indices-put_template.asciidoc b/docs/reference-indices-put_template.asciidoc index 93585b789..d06e375fd 100644 --- a/docs/reference-indices-put_template.asciidoc +++ b/docs/reference-indices-put_template.asciidoc @@ -45,17 +45,17 @@ Create or update an index template. Index templates define settings, mappings, a [source,ts] ---- -interface IndicesPutTemplateRequest extends <> { - name: <> +interface IndicesPutTemplateRequest extends <> { + name: <> create?: boolean - master_timeout?: <> + master_timeout?: <> cause?: string - aliases?: Record<<>, IndicesAlias> + aliases?: Record<<>, IndicesAlias> index_patterns?: string | string[] mappings?: MappingTypeMapping - order?: <> + order?: <> settings?: IndicesIndexSettings - version?: <> + version?: <> } ---- @@ -64,6 +64,6 @@ interface IndicesPutTemplateRequest extends <> +type IndicesPutTemplateResponse = <> ---- diff --git a/docs/reference-indices-recovery.asciidoc b/docs/reference-indices-recovery.asciidoc index 5a282890b..111663f08 100644 --- a/docs/reference-indices-recovery.asciidoc +++ b/docs/reference-indices-recovery.asciidoc @@ -45,8 +45,8 @@ Returns information about ongoing and completed shard recoveries for one or more [source,ts] ---- -interface IndicesRecoveryRequest extends <> { - index?: <> +interface IndicesRecoveryRequest extends <> { + index?: <> active_only?: boolean detailed?: boolean } @@ -57,6 +57,6 @@ interface IndicesRecoveryRequest extends <>, IndicesRecoveryRecoveryStatus> +type IndicesRecoveryResponse = Record<<>, IndicesRecoveryRecoveryStatus> ---- diff --git a/docs/reference-indices-refresh.asciidoc b/docs/reference-indices-refresh.asciidoc index 66741cd93..f96305064 100644 --- a/docs/reference-indices-refresh.asciidoc +++ b/docs/reference-indices-refresh.asciidoc @@ -45,10 +45,10 @@ Refresh an index. A refresh makes recent operations performed on one or more ind [source,ts] ---- -interface IndicesRefreshRequest extends <> { - index?: <> +interface IndicesRefreshRequest extends <> { + index?: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_unavailable?: boolean } ---- @@ -58,6 +58,6 @@ interface IndicesRefreshRequest extends < [source,ts] ---- -type IndicesRefreshResponse = <> +type IndicesRefreshResponse = <> ---- diff --git a/docs/reference-indices-reload_search_analyzers.asciidoc b/docs/reference-indices-reload_search_analyzers.asciidoc index 7f651255c..c07a2b5c8 100644 --- a/docs/reference-indices-reload_search_analyzers.asciidoc +++ b/docs/reference-indices-reload_search_analyzers.asciidoc @@ -45,10 +45,10 @@ Reloads an index's search analyzers and their resources. [source,ts] ---- -interface IndicesReloadSearchAnalyzersRequest extends <> { - index: <> +interface IndicesReloadSearchAnalyzersRequest extends <> { + index: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_unavailable?: boolean } ---- diff --git a/docs/reference-indices-resolve_cluster.asciidoc b/docs/reference-indices-resolve_cluster.asciidoc index 91064c85c..be0275a09 100644 --- a/docs/reference-indices-resolve_cluster.asciidoc +++ b/docs/reference-indices-resolve_cluster.asciidoc @@ -45,10 +45,10 @@ Resolves the specified index expressions to return information about each cluste [source,ts] ---- -interface IndicesResolveClusterRequest extends <> { - name: <> +interface IndicesResolveClusterRequest extends <> { + name: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_throttled?: boolean ignore_unavailable?: boolean } @@ -59,6 +59,6 @@ interface IndicesResolveClusterRequest extends <>, IndicesResolveClusterResolveClusterInfo> +type IndicesResolveClusterResponse = Record<<>, IndicesResolveClusterResolveClusterInfo> ---- diff --git a/docs/reference-indices-resolve_index.asciidoc b/docs/reference-indices-resolve_index.asciidoc index b4056a287..c8561b32a 100644 --- a/docs/reference-indices-resolve_index.asciidoc +++ b/docs/reference-indices-resolve_index.asciidoc @@ -45,9 +45,9 @@ Resolves the specified name(s) and/or index patterns for indices, aliases, and d [source,ts] ---- -interface IndicesResolveIndexRequest extends <> { - name: <> - expand_wildcards?: <> +interface IndicesResolveIndexRequest extends <> { + name: <> + expand_wildcards?: <> ignore_unavailable?: boolean allow_no_indices?: boolean } diff --git a/docs/reference-indices-rollover.asciidoc b/docs/reference-indices-rollover.asciidoc index 113be318e..ac0acc3a1 100644 --- a/docs/reference-indices-rollover.asciidoc +++ b/docs/reference-indices-rollover.asciidoc @@ -45,14 +45,14 @@ Roll over to a new index. Creates a new index for a data stream or index alias. [source,ts] ---- -interface IndicesRolloverRequest extends <> { - alias: <> - new_index?: <> +interface IndicesRolloverRequest extends <> { + alias: <> + new_index?: <> dry_run?: boolean - master_timeout?: <> - timeout?: <> - wait_for_active_shards?: <> - aliases?: Record<<>, IndicesAlias> + master_timeout?: <> + timeout?: <> + wait_for_active_shards?: <> + aliases?: Record<<>, IndicesAlias> conditions?: IndicesRolloverRolloverConditions mappings?: MappingTypeMapping settings?: Record diff --git a/docs/reference-indices-segments.asciidoc b/docs/reference-indices-segments.asciidoc index 35a3c805d..5de594def 100644 --- a/docs/reference-indices-segments.asciidoc +++ b/docs/reference-indices-segments.asciidoc @@ -45,10 +45,10 @@ Returns low-level information about the Lucene segments in index shards. For dat [source,ts] ---- -interface IndicesSegmentsRequest extends <> { - index?: <> +interface IndicesSegmentsRequest extends <> { + index?: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_unavailable?: boolean verbose?: boolean } @@ -61,7 +61,7 @@ interface IndicesSegmentsRequest extends < - _shards: <> + _shards: <> } ---- diff --git a/docs/reference-indices-shard_stores.asciidoc b/docs/reference-indices-shard_stores.asciidoc index 519ab965a..55347b494 100644 --- a/docs/reference-indices-shard_stores.asciidoc +++ b/docs/reference-indices-shard_stores.asciidoc @@ -45,10 +45,10 @@ Retrieves store information about replica shards in one or more indices. For dat [source,ts] ---- -interface IndicesShardStoresRequest extends <> { - index?: <> +interface IndicesShardStoresRequest extends <> { + index?: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_unavailable?: boolean status?: IndicesShardStoresShardStoreStatus | IndicesShardStoresShardStoreStatus[] } @@ -60,7 +60,7 @@ interface IndicesShardStoresRequest extends <>, IndicesShardStoresIndicesShardStores> + indices: Record<<>, IndicesShardStoresIndicesShardStores> } ---- diff --git a/docs/reference-indices-shrink.asciidoc b/docs/reference-indices-shrink.asciidoc index 758a8452f..96f0717d4 100644 --- a/docs/reference-indices-shrink.asciidoc +++ b/docs/reference-indices-shrink.asciidoc @@ -45,13 +45,13 @@ Shrinks an existing index into a new index with fewer primary shards. [source,ts] ---- -interface IndicesShrinkRequest extends <> { - index: <> - target: <> - master_timeout?: <> - timeout?: <> - wait_for_active_shards?: <> - aliases?: Record<<>, IndicesAlias> +interface IndicesShrinkRequest extends <> { + index: <> + target: <> + master_timeout?: <> + timeout?: <> + wait_for_active_shards?: <> + aliases?: Record<<>, IndicesAlias> settings?: Record } ---- @@ -64,7 +64,7 @@ interface IndicesShrinkRequest extends <> interface IndicesShrinkResponse { acknowledged: boolean shards_acknowledged: boolean - index: <> + index: <> } ---- diff --git a/docs/reference-indices-simulate_index_template.asciidoc b/docs/reference-indices-simulate_index_template.asciidoc index 71a79e085..27d031b63 100644 --- a/docs/reference-indices-simulate_index_template.asciidoc +++ b/docs/reference-indices-simulate_index_template.asciidoc @@ -45,9 +45,9 @@ Simulate an index. Returns the index configuration that would be applied to the [source,ts] ---- -interface IndicesSimulateIndexTemplateRequest extends <> { - name: <> - master_timeout?: <> +interface IndicesSimulateIndexTemplateRequest extends <> { + name: <> + master_timeout?: <> include_defaults?: boolean } ---- diff --git a/docs/reference-indices-simulate_template.asciidoc b/docs/reference-indices-simulate_template.asciidoc index 674399345..9ea9eb8bd 100644 --- a/docs/reference-indices-simulate_template.asciidoc +++ b/docs/reference-indices-simulate_template.asciidoc @@ -45,19 +45,19 @@ Simulate an index template. Returns the index configuration that would be applie [source,ts] ---- -interface IndicesSimulateTemplateRequest extends <> { - name?: <> +interface IndicesSimulateTemplateRequest extends <> { + name?: <> create?: boolean - master_timeout?: <> + master_timeout?: <> include_defaults?: boolean allow_auto_create?: boolean - index_patterns?: <> - composed_of?: <>[] + index_patterns?: <> + composed_of?: <>[] template?: IndicesPutIndexTemplateIndexTemplateMapping data_stream?: IndicesDataStreamVisibility - priority?: <> - version?: <> - _meta?: <> + priority?: <> + version?: <> + _meta?: <> ignore_missing_component_templates?: string[] deprecated?: boolean } diff --git a/docs/reference-indices-split.asciidoc b/docs/reference-indices-split.asciidoc index 3154d23aa..761d114e6 100644 --- a/docs/reference-indices-split.asciidoc +++ b/docs/reference-indices-split.asciidoc @@ -45,13 +45,13 @@ Splits an existing index into a new index with more primary shards. [source,ts] ---- -interface IndicesSplitRequest extends <> { - index: <> - target: <> - master_timeout?: <> - timeout?: <> - wait_for_active_shards?: <> - aliases?: Record<<>, IndicesAlias> +interface IndicesSplitRequest extends <> { + index: <> + target: <> + master_timeout?: <> + timeout?: <> + wait_for_active_shards?: <> + aliases?: Record<<>, IndicesAlias> settings?: Record } ---- @@ -64,7 +64,7 @@ interface IndicesSplitRequest extends <> interface IndicesSplitResponse { acknowledged: boolean shards_acknowledged: boolean - index: <> + index: <> } ---- diff --git a/docs/reference-indices-stats.asciidoc b/docs/reference-indices-stats.asciidoc index 107414a33..d22753e4e 100644 --- a/docs/reference-indices-stats.asciidoc +++ b/docs/reference-indices-stats.asciidoc @@ -45,18 +45,18 @@ Returns statistics for one or more indices. For data streams, the API retrieves [source,ts] ---- -interface IndicesStatsRequest extends <> { - metric?: <> - index?: <> - completion_fields?: <> - expand_wildcards?: <> - fielddata_fields?: <> - fields?: <> +interface IndicesStatsRequest extends <> { + metric?: <> + index?: <> + completion_fields?: <> + expand_wildcards?: <> + fielddata_fields?: <> + fields?: <> forbid_closed_indices?: boolean groups?: string | string[] include_segment_file_sizes?: boolean include_unloaded_segments?: boolean - level?: <> + level?: <> } ---- @@ -67,7 +67,7 @@ interface IndicesStatsRequest extends <> ---- interface IndicesStatsResponse { indices?: Record - _shards: <> + _shards: <> _all: IndicesStatsIndicesStats } ---- diff --git a/docs/reference-indices-unfreeze.asciidoc b/docs/reference-indices-unfreeze.asciidoc index b046d7607..f7a210f7b 100644 --- a/docs/reference-indices-unfreeze.asciidoc +++ b/docs/reference-indices-unfreeze.asciidoc @@ -45,13 +45,13 @@ Unfreezes an index. [source,ts] ---- -interface IndicesUnfreezeRequest extends <> { - index: <> +interface IndicesUnfreezeRequest extends <> { + index: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_unavailable?: boolean - master_timeout?: <> - timeout?: <> + master_timeout?: <> + timeout?: <> wait_for_active_shards?: string } ---- diff --git a/docs/reference-indices-update_aliases.asciidoc b/docs/reference-indices-update_aliases.asciidoc index 39ef67f5b..d2df15f7c 100644 --- a/docs/reference-indices-update_aliases.asciidoc +++ b/docs/reference-indices-update_aliases.asciidoc @@ -45,9 +45,9 @@ Create or update an alias. Adds a data stream or index to an alias. [source,ts] ---- -interface IndicesUpdateAliasesRequest extends <> { - master_timeout?: <> - timeout?: <> +interface IndicesUpdateAliasesRequest extends <> { + master_timeout?: <> + timeout?: <> actions?: IndicesUpdateAliasesAction[] } ---- @@ -57,6 +57,6 @@ interface IndicesUpdateAliasesRequest extends <> +type IndicesUpdateAliasesResponse = <> ---- diff --git a/docs/reference-indices-validate_query.asciidoc b/docs/reference-indices-validate_query.asciidoc index c12320340..c9188c8ce 100644 --- a/docs/reference-indices-validate_query.asciidoc +++ b/docs/reference-indices-validate_query.asciidoc @@ -45,15 +45,15 @@ Validate a query. Validates a query without running it. [source,ts] ---- -interface IndicesValidateQueryRequest extends <> { - index?: <> +interface IndicesValidateQueryRequest extends <> { + index?: <> allow_no_indices?: boolean all_shards?: boolean analyzer?: string analyze_wildcard?: boolean default_operator?: QueryDslOperator df?: string - expand_wildcards?: <> + expand_wildcards?: <> explain?: boolean ignore_unavailable?: boolean lenient?: boolean @@ -70,7 +70,7 @@ interface IndicesValidateQueryRequest extends <> + _shards?: <> valid: boolean error?: string } diff --git a/docs/reference-inference-delete.asciidoc b/docs/reference-inference-delete.asciidoc index 27505ec59..d21954153 100644 --- a/docs/reference-inference-delete.asciidoc +++ b/docs/reference-inference-delete.asciidoc @@ -45,9 +45,9 @@ Delete an inference endpoint [source,ts] ---- -interface InferenceDeleteRequest extends <> { +interface InferenceDeleteRequest extends <> { task_type?: InferenceTaskType - inference_id: <> + inference_id: <> dry_run?: boolean force?: boolean } diff --git a/docs/reference-inference-get.asciidoc b/docs/reference-inference-get.asciidoc index 1c597151c..22febeae4 100644 --- a/docs/reference-inference-get.asciidoc +++ b/docs/reference-inference-get.asciidoc @@ -45,9 +45,9 @@ Get an inference endpoint [source,ts] ---- -interface InferenceGetRequest extends <> { +interface InferenceGetRequest extends <> { task_type?: InferenceTaskType - inference_id?: <> + inference_id?: <> } ---- diff --git a/docs/reference-inference-inference.asciidoc b/docs/reference-inference-inference.asciidoc index 775e01e79..bc19290ea 100644 --- a/docs/reference-inference-inference.asciidoc +++ b/docs/reference-inference-inference.asciidoc @@ -45,10 +45,10 @@ Perform inference on the service [source,ts] ---- -interface InferenceInferenceRequest extends <> { +interface InferenceInferenceRequest extends <> { task_type?: InferenceTaskType - inference_id: <> - timeout?: <> + inference_id: <> + timeout?: <> query?: string input: string | string[] task_settings?: InferenceTaskSettings diff --git a/docs/reference-inference-put.asciidoc b/docs/reference-inference-put.asciidoc index fb557926b..ba73f5a85 100644 --- a/docs/reference-inference-put.asciidoc +++ b/docs/reference-inference-put.asciidoc @@ -45,9 +45,9 @@ Create an inference endpoint [source,ts] ---- -interface InferencePutRequest extends <> { +interface InferencePutRequest extends <> { task_type?: InferenceTaskType - inference_id: <> + inference_id: <> inference_config?: InferenceInferenceEndpoint } ---- diff --git a/docs/reference-info.asciidoc b/docs/reference-info.asciidoc index b3df99b09..f263a3788 100644 --- a/docs/reference-info.asciidoc +++ b/docs/reference-info.asciidoc @@ -45,7 +45,7 @@ Get cluster info. Returns basic information about the cluster. [source,ts] ---- -interface InfoRequest extends <> { +interface InfoRequest extends <> { } ---- @@ -55,11 +55,11 @@ interface InfoRequest extends <> { [source,ts] ---- interface InfoResponse { - cluster_name: <> - cluster_uuid: <> - name: <> + cluster_name: <> + cluster_uuid: <> + name: <> tagline: string - version: <> + version: <> } ---- diff --git a/docs/reference-ingest-delete_geoip_database.asciidoc b/docs/reference-ingest-delete_geoip_database.asciidoc index 98885cec5..8953a983b 100644 --- a/docs/reference-ingest-delete_geoip_database.asciidoc +++ b/docs/reference-ingest-delete_geoip_database.asciidoc @@ -45,10 +45,10 @@ Deletes a geoip database configuration. [source,ts] ---- -interface IngestDeleteGeoipDatabaseRequest extends <> { - id: <> - master_timeout?: <> - timeout?: <> +interface IngestDeleteGeoipDatabaseRequest extends <> { + id: <> + master_timeout?: <> + timeout?: <> } ---- @@ -57,6 +57,6 @@ interface IngestDeleteGeoipDatabaseRequest extends <> +type IngestDeleteGeoipDatabaseResponse = <> ---- diff --git a/docs/reference-ingest-delete_pipeline.asciidoc b/docs/reference-ingest-delete_pipeline.asciidoc index 6d847e69f..9f70eb5d6 100644 --- a/docs/reference-ingest-delete_pipeline.asciidoc +++ b/docs/reference-ingest-delete_pipeline.asciidoc @@ -45,10 +45,10 @@ Deletes one or more existing ingest pipeline. [source,ts] ---- -interface IngestDeletePipelineRequest extends <> { - id: <> - master_timeout?: <> - timeout?: <> +interface IngestDeletePipelineRequest extends <> { + id: <> + master_timeout?: <> + timeout?: <> } ---- @@ -57,6 +57,6 @@ interface IngestDeletePipelineRequest extends <> +type IngestDeletePipelineResponse = <> ---- diff --git a/docs/reference-ingest-geo_ip_stats.asciidoc b/docs/reference-ingest-geo_ip_stats.asciidoc index af336c446..3288a67f6 100644 --- a/docs/reference-ingest-geo_ip_stats.asciidoc +++ b/docs/reference-ingest-geo_ip_stats.asciidoc @@ -45,7 +45,7 @@ Gets download statistics for GeoIP2 databases used with the geoip processor. [source,ts] ---- -interface IngestGeoIpStatsRequest extends <> { +interface IngestGeoIpStatsRequest extends <> { } ---- @@ -56,7 +56,7 @@ interface IngestGeoIpStatsRequest extends <>, IngestGeoIpStatsGeoIpNodeDatabases> + nodes: Record<<>, IngestGeoIpStatsGeoIpNodeDatabases> } ---- diff --git a/docs/reference-ingest-get_geoip_database.asciidoc b/docs/reference-ingest-get_geoip_database.asciidoc index 387ef7f3f..bbe581a36 100644 --- a/docs/reference-ingest-get_geoip_database.asciidoc +++ b/docs/reference-ingest-get_geoip_database.asciidoc @@ -45,9 +45,9 @@ Returns information about one or more geoip database configurations. [source,ts] ---- -interface IngestGetGeoipDatabaseRequest extends <> { - id?: <> - master_timeout?: <> +interface IngestGetGeoipDatabaseRequest extends <> { + id?: <> + master_timeout?: <> } ---- diff --git a/docs/reference-ingest-get_pipeline.asciidoc b/docs/reference-ingest-get_pipeline.asciidoc index 5173a9226..1e725e195 100644 --- a/docs/reference-ingest-get_pipeline.asciidoc +++ b/docs/reference-ingest-get_pipeline.asciidoc @@ -45,9 +45,9 @@ Returns information about one or more ingest pipelines. This API returns a local [source,ts] ---- -interface IngestGetPipelineRequest extends <> { - id?: <> - master_timeout?: <> +interface IngestGetPipelineRequest extends <> { + id?: <> + master_timeout?: <> summary?: boolean } ---- diff --git a/docs/reference-ingest-processor_grok.asciidoc b/docs/reference-ingest-processor_grok.asciidoc index dc69b7f05..d51ae5c3f 100644 --- a/docs/reference-ingest-processor_grok.asciidoc +++ b/docs/reference-ingest-processor_grok.asciidoc @@ -45,7 +45,7 @@ Extracts structured fields out of a single text field within a document. You cho [source,ts] ---- -interface IngestProcessorGrokRequest extends <> { +interface IngestProcessorGrokRequest extends <> { } ---- diff --git a/docs/reference-ingest-put_geoip_database.asciidoc b/docs/reference-ingest-put_geoip_database.asciidoc index dffb38cf2..54f71fa39 100644 --- a/docs/reference-ingest-put_geoip_database.asciidoc +++ b/docs/reference-ingest-put_geoip_database.asciidoc @@ -45,11 +45,11 @@ Returns information about one or more geoip database configurations. [source,ts] ---- -interface IngestPutGeoipDatabaseRequest extends <> { - id: <> - master_timeout?: <> - timeout?: <> - name: <> +interface IngestPutGeoipDatabaseRequest extends <> { + id: <> + master_timeout?: <> + timeout?: <> + name: <> maxmind: IngestMaxmind } ---- @@ -59,6 +59,6 @@ interface IngestPutGeoipDatabaseRequest extends <> +type IngestPutGeoipDatabaseResponse = <> ---- diff --git a/docs/reference-ingest-put_pipeline.asciidoc b/docs/reference-ingest-put_pipeline.asciidoc index f0a1c7e62..44aa2e00c 100644 --- a/docs/reference-ingest-put_pipeline.asciidoc +++ b/docs/reference-ingest-put_pipeline.asciidoc @@ -45,16 +45,16 @@ Creates or updates an ingest pipeline. Changes made using this API take effect i [source,ts] ---- -interface IngestPutPipelineRequest extends <> { - id: <> - master_timeout?: <> - timeout?: <> - if_version?: <> - _meta?: <> +interface IngestPutPipelineRequest extends <> { + id: <> + master_timeout?: <> + timeout?: <> + if_version?: <> + _meta?: <> description?: string on_failure?: IngestProcessorContainer[] processors?: IngestProcessorContainer[] - version?: <> + version?: <> deprecated?: boolean } ---- @@ -64,6 +64,6 @@ interface IngestPutPipelineRequest extends <> +type IngestPutPipelineResponse = <> ---- diff --git a/docs/reference-ingest-simulate.asciidoc b/docs/reference-ingest-simulate.asciidoc index 74a6cd0ef..a76a08f1d 100644 --- a/docs/reference-ingest-simulate.asciidoc +++ b/docs/reference-ingest-simulate.asciidoc @@ -45,8 +45,8 @@ Executes an ingest pipeline against a set of provided documents. [source,ts] ---- -interface IngestSimulateRequest extends <> { - id?: <> +interface IngestSimulateRequest extends <> { + id?: <> verbose?: boolean docs: IngestSimulateDocument[] pipeline?: IngestPipeline diff --git a/docs/reference-knn_search.asciidoc b/docs/reference-knn_search.asciidoc index a5217d330..89ef33f2a 100644 --- a/docs/reference-knn_search.asciidoc +++ b/docs/reference-knn_search.asciidoc @@ -45,13 +45,13 @@ Run a knn search. NOTE: The kNN search API has been replaced by the `knn` option [source,ts] ---- -interface KnnSearchRequest extends <> { - index: <> - routing?: <> +interface KnnSearchRequest extends <> { + index: <> + routing?: <> _source?: SearchSourceConfig - docvalue_fields?: (QueryDslFieldAndFormat | <>)[] - stored_fields?: <> - fields?: <> + docvalue_fields?: (QueryDslFieldAndFormat | <>)[] + stored_fields?: <> + fields?: <> filter?: QueryDslQueryContainer | QueryDslQueryContainer[] knn: KnnSearchQuery } @@ -63,12 +63,12 @@ interface KnnSearchRequest extends <> { [source,ts] ---- interface KnnSearchResponse { - took: <> + took: <> timed_out: boolean - _shards: <> + _shards: <> hits: SearchHitsMetadata fields?: Record - max_score?: <> + max_score?: <> } ---- diff --git a/docs/reference-license-delete.asciidoc b/docs/reference-license-delete.asciidoc index a554a92d5..514a10743 100644 --- a/docs/reference-license-delete.asciidoc +++ b/docs/reference-license-delete.asciidoc @@ -45,7 +45,7 @@ Deletes licensing information for the cluster [source,ts] ---- -interface LicenseDeleteRequest extends <> { +interface LicenseDeleteRequest extends <> { } ---- @@ -54,6 +54,6 @@ interface LicenseDeleteRequest extends <> [source,ts] ---- -type LicenseDeleteResponse = <> +type LicenseDeleteResponse = <> ---- diff --git a/docs/reference-license-get.asciidoc b/docs/reference-license-get.asciidoc index c8ec99e8c..9bc1eeef0 100644 --- a/docs/reference-license-get.asciidoc +++ b/docs/reference-license-get.asciidoc @@ -45,7 +45,7 @@ Get license information. Returns information about your Elastic license, includi [source,ts] ---- -interface LicenseGetRequest extends <> { +interface LicenseGetRequest extends <> { accept_enterprise?: boolean local?: boolean } diff --git a/docs/reference-license-get_basic_status.asciidoc b/docs/reference-license-get_basic_status.asciidoc index 8bcf35017..82286cbab 100644 --- a/docs/reference-license-get_basic_status.asciidoc +++ b/docs/reference-license-get_basic_status.asciidoc @@ -45,7 +45,7 @@ Retrieves information about the status of the basic license. [source,ts] ---- -interface LicenseGetBasicStatusRequest extends <> { +interface LicenseGetBasicStatusRequest extends <> { } ---- diff --git a/docs/reference-license-get_trial_status.asciidoc b/docs/reference-license-get_trial_status.asciidoc index d96178efb..f637fa144 100644 --- a/docs/reference-license-get_trial_status.asciidoc +++ b/docs/reference-license-get_trial_status.asciidoc @@ -45,7 +45,7 @@ Retrieves information about the status of the trial license. [source,ts] ---- -interface LicenseGetTrialStatusRequest extends <> { +interface LicenseGetTrialStatusRequest extends <> { } ---- diff --git a/docs/reference-license-post.asciidoc b/docs/reference-license-post.asciidoc index 0a3f779fb..240dfe544 100644 --- a/docs/reference-license-post.asciidoc +++ b/docs/reference-license-post.asciidoc @@ -45,7 +45,7 @@ Updates the license for the cluster. [source,ts] ---- -interface LicensePostRequest extends <> { +interface LicensePostRequest extends <> { acknowledge?: boolean license?: LicenseLicense licenses?: LicenseLicense[] diff --git a/docs/reference-license-post_start_basic.asciidoc b/docs/reference-license-post_start_basic.asciidoc index bc0a74a38..571e98b57 100644 --- a/docs/reference-license-post_start_basic.asciidoc +++ b/docs/reference-license-post_start_basic.asciidoc @@ -45,7 +45,7 @@ The start basic API enables you to initiate an indefinite basic license, which g [source,ts] ---- -interface LicensePostStartBasicRequest extends <> { +interface LicensePostStartBasicRequest extends <> { acknowledge?: boolean } ---- diff --git a/docs/reference-license-post_start_trial.asciidoc b/docs/reference-license-post_start_trial.asciidoc index 7e7b1d363..e86871eb5 100644 --- a/docs/reference-license-post_start_trial.asciidoc +++ b/docs/reference-license-post_start_trial.asciidoc @@ -45,7 +45,7 @@ The start trial API enables you to start a 30-day trial, which gives access to a [source,ts] ---- -interface LicensePostStartTrialRequest extends <> { +interface LicensePostStartTrialRequest extends <> { acknowledge?: boolean type_query_string?: string } diff --git a/docs/reference-logstash-delete_pipeline.asciidoc b/docs/reference-logstash-delete_pipeline.asciidoc index 320cc9769..700c74454 100644 --- a/docs/reference-logstash-delete_pipeline.asciidoc +++ b/docs/reference-logstash-delete_pipeline.asciidoc @@ -45,8 +45,8 @@ Deletes a pipeline used for Logstash Central Management. [source,ts] ---- -interface LogstashDeletePipelineRequest extends <> { - id: <> +interface LogstashDeletePipelineRequest extends <> { + id: <> } ---- diff --git a/docs/reference-logstash-get_pipeline.asciidoc b/docs/reference-logstash-get_pipeline.asciidoc index 2acbb3deb..70beea717 100644 --- a/docs/reference-logstash-get_pipeline.asciidoc +++ b/docs/reference-logstash-get_pipeline.asciidoc @@ -45,8 +45,8 @@ Retrieves pipelines used for Logstash Central Management. [source,ts] ---- -interface LogstashGetPipelineRequest extends <> { - id?: <> +interface LogstashGetPipelineRequest extends <> { + id?: <> } ---- @@ -55,6 +55,6 @@ interface LogstashGetPipelineRequest extends <>, LogstashPipeline> +type LogstashGetPipelineResponse = Record<<>, LogstashPipeline> ---- diff --git a/docs/reference-logstash-put_pipeline.asciidoc b/docs/reference-logstash-put_pipeline.asciidoc index d4f510249..0f60773d7 100644 --- a/docs/reference-logstash-put_pipeline.asciidoc +++ b/docs/reference-logstash-put_pipeline.asciidoc @@ -45,8 +45,8 @@ Creates or updates a pipeline used for Logstash Central Management. [source,ts] ---- -interface LogstashPutPipelineRequest extends <> { - id: <> +interface LogstashPutPipelineRequest extends <> { + id: <> pipeline?: LogstashPipeline } ---- diff --git a/docs/reference-mget.asciidoc b/docs/reference-mget.asciidoc index a60c7cfce..a13dbe74c 100644 --- a/docs/reference-mget.asciidoc +++ b/docs/reference-mget.asciidoc @@ -45,19 +45,19 @@ Get multiple documents. Get multiple JSON documents by ID from one or more indic [source,ts] ---- -interface MgetRequest extends <> { - index?: <> +interface MgetRequest extends <> { + index?: <> force_synthetic_source?: boolean preference?: string realtime?: boolean refresh?: boolean - routing?: <> + routing?: <> _source?: SearchSourceConfigParam - _source_excludes?: <> - _source_includes?: <> - stored_fields?: <> + _source_excludes?: <> + _source_includes?: <> + stored_fields?: <> docs?: MgetOperation[] - ids?: <> + ids?: <> } ---- diff --git a/docs/reference-migration-deprecations.asciidoc b/docs/reference-migration-deprecations.asciidoc index 106e34fed..87484c13f 100644 --- a/docs/reference-migration-deprecations.asciidoc +++ b/docs/reference-migration-deprecations.asciidoc @@ -45,8 +45,8 @@ Retrieves information about different cluster, node, and index level settings th [source,ts] ---- -interface MigrationDeprecationsRequest extends <> { - index?: <> +interface MigrationDeprecationsRequest extends <> { + index?: <> } ---- diff --git a/docs/reference-migration-get_feature_upgrade_status.asciidoc b/docs/reference-migration-get_feature_upgrade_status.asciidoc index ef53d79ea..0a65e594c 100644 --- a/docs/reference-migration-get_feature_upgrade_status.asciidoc +++ b/docs/reference-migration-get_feature_upgrade_status.asciidoc @@ -45,7 +45,7 @@ Find out whether system features need to be upgraded or not [source,ts] ---- -interface MigrationGetFeatureUpgradeStatusRequest extends <> { +interface MigrationGetFeatureUpgradeStatusRequest extends <> { } ---- diff --git a/docs/reference-migration-post_feature_upgrade.asciidoc b/docs/reference-migration-post_feature_upgrade.asciidoc index 3a2124f31..d87824965 100644 --- a/docs/reference-migration-post_feature_upgrade.asciidoc +++ b/docs/reference-migration-post_feature_upgrade.asciidoc @@ -45,7 +45,7 @@ Begin upgrades for system features [source,ts] ---- -interface MigrationPostFeatureUpgradeRequest extends <> { +interface MigrationPostFeatureUpgradeRequest extends <> { } ---- diff --git a/docs/reference-ml-clear_trained_model_deployment_cache.asciidoc b/docs/reference-ml-clear_trained_model_deployment_cache.asciidoc index 84926e56a..f7bd67dd0 100644 --- a/docs/reference-ml-clear_trained_model_deployment_cache.asciidoc +++ b/docs/reference-ml-clear_trained_model_deployment_cache.asciidoc @@ -45,8 +45,8 @@ Clear trained model deployment cache. Cache will be cleared on all nodes where t [source,ts] ---- -interface MlClearTrainedModelDeploymentCacheRequest extends <> { - model_id: <> +interface MlClearTrainedModelDeploymentCacheRequest extends <> { + model_id: <> } ---- diff --git a/docs/reference-ml-close_job.asciidoc b/docs/reference-ml-close_job.asciidoc index de16526f2..b76e076f4 100644 --- a/docs/reference-ml-close_job.asciidoc +++ b/docs/reference-ml-close_job.asciidoc @@ -45,11 +45,11 @@ Close anomaly detection jobs. A job can be opened and closed multiple times thro [source,ts] ---- -interface MlCloseJobRequest extends <> { - job_id: <> +interface MlCloseJobRequest extends <> { + job_id: <> allow_no_match?: boolean force?: boolean - timeout?: <> + timeout?: <> } ---- diff --git a/docs/reference-ml-delete_calendar.asciidoc b/docs/reference-ml-delete_calendar.asciidoc index d34bc3d20..3231d4339 100644 --- a/docs/reference-ml-delete_calendar.asciidoc +++ b/docs/reference-ml-delete_calendar.asciidoc @@ -45,8 +45,8 @@ Delete a calendar. Removes all scheduled events from a calendar, then deletes it [source,ts] ---- -interface MlDeleteCalendarRequest extends <> { - calendar_id: <> +interface MlDeleteCalendarRequest extends <> { + calendar_id: <> } ---- @@ -55,6 +55,6 @@ interface MlDeleteCalendarRequest extends <> +type MlDeleteCalendarResponse = <> ---- diff --git a/docs/reference-ml-delete_calendar_event.asciidoc b/docs/reference-ml-delete_calendar_event.asciidoc index f61df27fd..7bb2095e9 100644 --- a/docs/reference-ml-delete_calendar_event.asciidoc +++ b/docs/reference-ml-delete_calendar_event.asciidoc @@ -45,9 +45,9 @@ Delete events from a calendar. [source,ts] ---- -interface MlDeleteCalendarEventRequest extends <> { - calendar_id: <> - event_id: <> +interface MlDeleteCalendarEventRequest extends <> { + calendar_id: <> + event_id: <> } ---- @@ -56,6 +56,6 @@ interface MlDeleteCalendarEventRequest extends <> +type MlDeleteCalendarEventResponse = <> ---- diff --git a/docs/reference-ml-delete_calendar_job.asciidoc b/docs/reference-ml-delete_calendar_job.asciidoc index 5b8dba08d..fa20dcac6 100644 --- a/docs/reference-ml-delete_calendar_job.asciidoc +++ b/docs/reference-ml-delete_calendar_job.asciidoc @@ -45,9 +45,9 @@ Delete anomaly jobs from a calendar. [source,ts] ---- -interface MlDeleteCalendarJobRequest extends <> { - calendar_id: <> - job_id: <> +interface MlDeleteCalendarJobRequest extends <> { + calendar_id: <> + job_id: <> } ---- @@ -57,9 +57,9 @@ interface MlDeleteCalendarJobRequest extends <> + calendar_id: <> description?: string - job_ids: <> + job_ids: <> } ---- diff --git a/docs/reference-ml-delete_data_frame_analytics.asciidoc b/docs/reference-ml-delete_data_frame_analytics.asciidoc index 7d16b5eb5..5d99e98e7 100644 --- a/docs/reference-ml-delete_data_frame_analytics.asciidoc +++ b/docs/reference-ml-delete_data_frame_analytics.asciidoc @@ -45,10 +45,10 @@ Delete a data frame analytics job. [source,ts] ---- -interface MlDeleteDataFrameAnalyticsRequest extends <> { - id: <> +interface MlDeleteDataFrameAnalyticsRequest extends <> { + id: <> force?: boolean - timeout?: <> + timeout?: <> } ---- @@ -57,6 +57,6 @@ interface MlDeleteDataFrameAnalyticsRequest extends <> +type MlDeleteDataFrameAnalyticsResponse = <> ---- diff --git a/docs/reference-ml-delete_datafeed.asciidoc b/docs/reference-ml-delete_datafeed.asciidoc index afd67bf7a..5abbadb88 100644 --- a/docs/reference-ml-delete_datafeed.asciidoc +++ b/docs/reference-ml-delete_datafeed.asciidoc @@ -45,8 +45,8 @@ Delete a datafeed. [source,ts] ---- -interface MlDeleteDatafeedRequest extends <> { - datafeed_id: <> +interface MlDeleteDatafeedRequest extends <> { + datafeed_id: <> force?: boolean } ---- @@ -56,6 +56,6 @@ interface MlDeleteDatafeedRequest extends <> +type MlDeleteDatafeedResponse = <> ---- diff --git a/docs/reference-ml-delete_expired_data.asciidoc b/docs/reference-ml-delete_expired_data.asciidoc index c6c86799c..35d8dcb10 100644 --- a/docs/reference-ml-delete_expired_data.asciidoc +++ b/docs/reference-ml-delete_expired_data.asciidoc @@ -45,10 +45,10 @@ Delete expired ML data. Deletes all job results, model snapshots and forecast da [source,ts] ---- -interface MlDeleteExpiredDataRequest extends <> { - job_id?: <> - requests_per_second?: <> - timeout?: <> +interface MlDeleteExpiredDataRequest extends <> { + job_id?: <> + requests_per_second?: <> + timeout?: <> } ---- diff --git a/docs/reference-ml-delete_filter.asciidoc b/docs/reference-ml-delete_filter.asciidoc index 3feabc61b..f6039ad19 100644 --- a/docs/reference-ml-delete_filter.asciidoc +++ b/docs/reference-ml-delete_filter.asciidoc @@ -45,8 +45,8 @@ Delete a filter. If an anomaly detection job references the filter, you cannot d [source,ts] ---- -interface MlDeleteFilterRequest extends <> { - filter_id: <> +interface MlDeleteFilterRequest extends <> { + filter_id: <> } ---- @@ -55,6 +55,6 @@ interface MlDeleteFilterRequest extends < [source,ts] ---- -type MlDeleteFilterResponse = <> +type MlDeleteFilterResponse = <> ---- diff --git a/docs/reference-ml-delete_forecast.asciidoc b/docs/reference-ml-delete_forecast.asciidoc index 65ef02743..6fc36217b 100644 --- a/docs/reference-ml-delete_forecast.asciidoc +++ b/docs/reference-ml-delete_forecast.asciidoc @@ -45,11 +45,11 @@ Delete forecasts from a job. By default, forecasts are retained for 14 days. You [source,ts] ---- -interface MlDeleteForecastRequest extends <> { - job_id: <> - forecast_id?: <> +interface MlDeleteForecastRequest extends <> { + job_id: <> + forecast_id?: <> allow_no_forecasts?: boolean - timeout?: <> + timeout?: <> } ---- @@ -58,6 +58,6 @@ interface MlDeleteForecastRequest extends <> +type MlDeleteForecastResponse = <> ---- diff --git a/docs/reference-ml-delete_job.asciidoc b/docs/reference-ml-delete_job.asciidoc index 6d6305b7a..91d35f79e 100644 --- a/docs/reference-ml-delete_job.asciidoc +++ b/docs/reference-ml-delete_job.asciidoc @@ -45,8 +45,8 @@ Delete an anomaly detection job. All job configuration, model state and results [source,ts] ---- -interface MlDeleteJobRequest extends <> { - job_id: <> +interface MlDeleteJobRequest extends <> { + job_id: <> force?: boolean delete_user_annotations?: boolean wait_for_completion?: boolean @@ -58,6 +58,6 @@ interface MlDeleteJobRequest extends <> { [source,ts] ---- -type MlDeleteJobResponse = <> +type MlDeleteJobResponse = <> ---- diff --git a/docs/reference-ml-delete_model_snapshot.asciidoc b/docs/reference-ml-delete_model_snapshot.asciidoc index a24cda942..5dfe3c275 100644 --- a/docs/reference-ml-delete_model_snapshot.asciidoc +++ b/docs/reference-ml-delete_model_snapshot.asciidoc @@ -45,9 +45,9 @@ Delete a model snapshot. You cannot delete the active model snapshot. To delete [source,ts] ---- -interface MlDeleteModelSnapshotRequest extends <> { - job_id: <> - snapshot_id: <> +interface MlDeleteModelSnapshotRequest extends <> { + job_id: <> + snapshot_id: <> } ---- @@ -56,6 +56,6 @@ interface MlDeleteModelSnapshotRequest extends <> +type MlDeleteModelSnapshotResponse = <> ---- diff --git a/docs/reference-ml-delete_trained_model.asciidoc b/docs/reference-ml-delete_trained_model.asciidoc index 8608c6b75..f4f85448d 100644 --- a/docs/reference-ml-delete_trained_model.asciidoc +++ b/docs/reference-ml-delete_trained_model.asciidoc @@ -45,8 +45,8 @@ Delete an unreferenced trained model. The request deletes a trained inference mo [source,ts] ---- -interface MlDeleteTrainedModelRequest extends <> { - model_id: <> +interface MlDeleteTrainedModelRequest extends <> { + model_id: <> force?: boolean } ---- @@ -56,6 +56,6 @@ interface MlDeleteTrainedModelRequest extends <> +type MlDeleteTrainedModelResponse = <> ---- diff --git a/docs/reference-ml-delete_trained_model_alias.asciidoc b/docs/reference-ml-delete_trained_model_alias.asciidoc index 1256897e3..ff03cfd03 100644 --- a/docs/reference-ml-delete_trained_model_alias.asciidoc +++ b/docs/reference-ml-delete_trained_model_alias.asciidoc @@ -45,9 +45,9 @@ Delete a trained model alias. This API deletes an existing model alias that refe [source,ts] ---- -interface MlDeleteTrainedModelAliasRequest extends <> { - model_alias: <> - model_id: <> +interface MlDeleteTrainedModelAliasRequest extends <> { + model_alias: <> + model_id: <> } ---- @@ -56,6 +56,6 @@ interface MlDeleteTrainedModelAliasRequest extends <> +type MlDeleteTrainedModelAliasResponse = <> ---- diff --git a/docs/reference-ml-estimate_model_memory.asciidoc b/docs/reference-ml-estimate_model_memory.asciidoc index 6be238f1f..4421d3c10 100644 --- a/docs/reference-ml-estimate_model_memory.asciidoc +++ b/docs/reference-ml-estimate_model_memory.asciidoc @@ -45,10 +45,10 @@ Estimate job model memory usage. Makes an estimation of the memory usage for an [source,ts] ---- -interface MlEstimateModelMemoryRequest extends <> { +interface MlEstimateModelMemoryRequest extends <> { analysis_config?: MlAnalysisConfig - max_bucket_cardinality?: Record<<>, <>> - overall_cardinality?: Record<<>, <>> + max_bucket_cardinality?: Record<<>, <>> + overall_cardinality?: Record<<>, <>> } ---- diff --git a/docs/reference-ml-evaluate_data_frame.asciidoc b/docs/reference-ml-evaluate_data_frame.asciidoc index b53b2c0b6..52ceb0738 100644 --- a/docs/reference-ml-evaluate_data_frame.asciidoc +++ b/docs/reference-ml-evaluate_data_frame.asciidoc @@ -45,9 +45,9 @@ Evaluate data frame analytics. The API packages together commonly used evaluatio [source,ts] ---- -interface MlEvaluateDataFrameRequest extends <> { +interface MlEvaluateDataFrameRequest extends <> { evaluation: MlDataframeEvaluationContainer - index: <> + index: <> query?: QueryDslQueryContainer } ---- diff --git a/docs/reference-ml-explain_data_frame_analytics.asciidoc b/docs/reference-ml-explain_data_frame_analytics.asciidoc index 27e616595..2dc6a346c 100644 --- a/docs/reference-ml-explain_data_frame_analytics.asciidoc +++ b/docs/reference-ml-explain_data_frame_analytics.asciidoc @@ -45,14 +45,14 @@ Explain data frame analytics config. This API provides explanations for a data f [source,ts] ---- -interface MlExplainDataFrameAnalyticsRequest extends <> { - id?: <> +interface MlExplainDataFrameAnalyticsRequest extends <> { + id?: <> source?: MlDataframeAnalyticsSource dest?: MlDataframeAnalyticsDestination analysis?: MlDataframeAnalysisContainer description?: string model_memory_limit?: string - max_num_threads?: <> + max_num_threads?: <> analyzed_fields?: MlDataframeAnalysisAnalyzedFields | string[] allow_lazy_start?: boolean } diff --git a/docs/reference-ml-flush_job.asciidoc b/docs/reference-ml-flush_job.asciidoc index c4cda17fa..ae3d460ef 100644 --- a/docs/reference-ml-flush_job.asciidoc +++ b/docs/reference-ml-flush_job.asciidoc @@ -45,13 +45,13 @@ Force buffered data to be processed. The flush jobs API is only applicable when [source,ts] ---- -interface MlFlushJobRequest extends <> { - job_id: <> - advance_time?: <> +interface MlFlushJobRequest extends <> { + job_id: <> + advance_time?: <> calc_interim?: boolean - end?: <> - skip_time?: <> - start?: <> + end?: <> + skip_time?: <> + start?: <> } ---- @@ -62,7 +62,7 @@ interface MlFlushJobRequest extends <> { ---- interface MlFlushJobResponse { flushed: boolean - last_finalized_bucket_end?: <> + last_finalized_bucket_end?: <> } ---- diff --git a/docs/reference-ml-forecast.asciidoc b/docs/reference-ml-forecast.asciidoc index a225cabea..51ad314c5 100644 --- a/docs/reference-ml-forecast.asciidoc +++ b/docs/reference-ml-forecast.asciidoc @@ -45,10 +45,10 @@ Predict future behavior of a time series. Forecasts are not supported for jobs t [source,ts] ---- -interface MlForecastRequest extends <> { - job_id: <> - duration?: <> - expires_in?: <> +interface MlForecastRequest extends <> { + job_id: <> + duration?: <> + expires_in?: <> max_model_memory?: string } ---- @@ -60,7 +60,7 @@ interface MlForecastRequest extends <> { ---- interface MlForecastResponse { acknowledged: boolean - forecast_id: <> + forecast_id: <> } ---- diff --git a/docs/reference-ml-get_buckets.asciidoc b/docs/reference-ml-get_buckets.asciidoc index ad5203ee7..418d4a12f 100644 --- a/docs/reference-ml-get_buckets.asciidoc +++ b/docs/reference-ml-get_buckets.asciidoc @@ -45,19 +45,19 @@ Get anomaly detection job results for buckets. The API presents a chronological [source,ts] ---- -interface MlGetBucketsRequest extends <> { - job_id: <> - timestamp?: <> - from?: <> - size?: <> - anomaly_score?: <> +interface MlGetBucketsRequest extends <> { + job_id: <> + timestamp?: <> + from?: <> + size?: <> + anomaly_score?: <> desc?: boolean - end?: <> + end?: <> exclude_interim?: boolean expand?: boolean page?: MlPage - sort?: <> - start?: <> + sort?: <> + start?: <> } ---- @@ -68,7 +68,7 @@ interface MlGetBucketsRequest extends <> ---- interface MlGetBucketsResponse { buckets: MlBucketSummary[] - count: <> + count: <> } ---- diff --git a/docs/reference-ml-get_calendar_events.asciidoc b/docs/reference-ml-get_calendar_events.asciidoc index 6653c89cf..afec2b503 100644 --- a/docs/reference-ml-get_calendar_events.asciidoc +++ b/docs/reference-ml-get_calendar_events.asciidoc @@ -45,13 +45,13 @@ Get info about events in calendars. [source,ts] ---- -interface MlGetCalendarEventsRequest extends <> { - calendar_id: <> - end?: <> - from?: <> - job_id?: <> - size?: <> - start?: <> +interface MlGetCalendarEventsRequest extends <> { + calendar_id: <> + end?: <> + from?: <> + job_id?: <> + size?: <> + start?: <> } ---- @@ -61,7 +61,7 @@ interface MlGetCalendarEventsRequest extends <> + count: <> events: MlCalendarEvent[] } ---- diff --git a/docs/reference-ml-get_calendars.asciidoc b/docs/reference-ml-get_calendars.asciidoc index 3cbd709e3..e726b0fdd 100644 --- a/docs/reference-ml-get_calendars.asciidoc +++ b/docs/reference-ml-get_calendars.asciidoc @@ -45,10 +45,10 @@ Get calendar configuration info. [source,ts] ---- -interface MlGetCalendarsRequest extends <> { - calendar_id?: <> - from?: <> - size?: <> +interface MlGetCalendarsRequest extends <> { + calendar_id?: <> + from?: <> + size?: <> page?: MlPage } ---- @@ -60,7 +60,7 @@ interface MlGetCalendarsRequest extends < ---- interface MlGetCalendarsResponse { calendars: MlGetCalendarsCalendar[] - count: <> + count: <> } ---- diff --git a/docs/reference-ml-get_categories.asciidoc b/docs/reference-ml-get_categories.asciidoc index c73e98855..7bbc1a862 100644 --- a/docs/reference-ml-get_categories.asciidoc +++ b/docs/reference-ml-get_categories.asciidoc @@ -45,12 +45,12 @@ Get anomaly detection job results for categories. [source,ts] ---- -interface MlGetCategoriesRequest extends <> { - job_id: <> - category_id?: <> - from?: <> +interface MlGetCategoriesRequest extends <> { + job_id: <> + category_id?: <> + from?: <> partition_field_value?: string - size?: <> + size?: <> page?: MlPage } ---- @@ -62,7 +62,7 @@ interface MlGetCategoriesRequest extends <> + count: <> } ---- diff --git a/docs/reference-ml-get_data_frame_analytics.asciidoc b/docs/reference-ml-get_data_frame_analytics.asciidoc index 0d47532be..0a0be2f9d 100644 --- a/docs/reference-ml-get_data_frame_analytics.asciidoc +++ b/docs/reference-ml-get_data_frame_analytics.asciidoc @@ -45,11 +45,11 @@ Get data frame analytics job configuration info. You can get information for mul [source,ts] ---- -interface MlGetDataFrameAnalyticsRequest extends <> { - id?: <> +interface MlGetDataFrameAnalyticsRequest extends <> { + id?: <> allow_no_match?: boolean - from?: <> - size?: <> + from?: <> + size?: <> exclude_generated?: boolean } ---- @@ -60,7 +60,7 @@ interface MlGetDataFrameAnalyticsRequest extends <> + count: <> data_frame_analytics: MlDataframeAnalyticsSummary[] } ---- diff --git a/docs/reference-ml-get_data_frame_analytics_stats.asciidoc b/docs/reference-ml-get_data_frame_analytics_stats.asciidoc index 54770a6f8..e7c96cacf 100644 --- a/docs/reference-ml-get_data_frame_analytics_stats.asciidoc +++ b/docs/reference-ml-get_data_frame_analytics_stats.asciidoc @@ -45,11 +45,11 @@ Get data frame analytics jobs usage info. [source,ts] ---- -interface MlGetDataFrameAnalyticsStatsRequest extends <> { - id?: <> +interface MlGetDataFrameAnalyticsStatsRequest extends <> { + id?: <> allow_no_match?: boolean - from?: <> - size?: <> + from?: <> + size?: <> verbose?: boolean } ---- @@ -60,7 +60,7 @@ interface MlGetDataFrameAnalyticsStatsRequest extends <> + count: <> data_frame_analytics: MlDataframeAnalytics[] } ---- diff --git a/docs/reference-ml-get_datafeed_stats.asciidoc b/docs/reference-ml-get_datafeed_stats.asciidoc index 13725b348..9ca22ddd3 100644 --- a/docs/reference-ml-get_datafeed_stats.asciidoc +++ b/docs/reference-ml-get_datafeed_stats.asciidoc @@ -45,8 +45,8 @@ Get datafeeds usage info. You can get statistics for multiple datafeeds in a sin [source,ts] ---- -interface MlGetDatafeedStatsRequest extends <> { - datafeed_id?: <> +interface MlGetDatafeedStatsRequest extends <> { + datafeed_id?: <> allow_no_match?: boolean } ---- @@ -57,7 +57,7 @@ interface MlGetDatafeedStatsRequest extends <> + count: <> datafeeds: MlDatafeedStats[] } ---- diff --git a/docs/reference-ml-get_datafeeds.asciidoc b/docs/reference-ml-get_datafeeds.asciidoc index e9fb19ecc..8b3d7e397 100644 --- a/docs/reference-ml-get_datafeeds.asciidoc +++ b/docs/reference-ml-get_datafeeds.asciidoc @@ -45,8 +45,8 @@ Get datafeeds configuration info. You can get information for multiple datafeeds [source,ts] ---- -interface MlGetDatafeedsRequest extends <> { - datafeed_id?: <> +interface MlGetDatafeedsRequest extends <> { + datafeed_id?: <> allow_no_match?: boolean exclude_generated?: boolean } @@ -58,7 +58,7 @@ interface MlGetDatafeedsRequest extends < [source,ts] ---- interface MlGetDatafeedsResponse { - count: <> + count: <> datafeeds: MlDatafeed[] } ---- diff --git a/docs/reference-ml-get_filters.asciidoc b/docs/reference-ml-get_filters.asciidoc index 29ae571a5..405443ba3 100644 --- a/docs/reference-ml-get_filters.asciidoc +++ b/docs/reference-ml-get_filters.asciidoc @@ -45,10 +45,10 @@ Get filters. You can get a single filter or all filters. [source,ts] ---- -interface MlGetFiltersRequest extends <> { - filter_id?: <> - from?: <> - size?: <> +interface MlGetFiltersRequest extends <> { + filter_id?: <> + from?: <> + size?: <> } ---- @@ -58,7 +58,7 @@ interface MlGetFiltersRequest extends <> [source,ts] ---- interface MlGetFiltersResponse { - count: <> + count: <> filters: MlFilter[] } ---- diff --git a/docs/reference-ml-get_influencers.asciidoc b/docs/reference-ml-get_influencers.asciidoc index 5d131f19a..2f30abc7b 100644 --- a/docs/reference-ml-get_influencers.asciidoc +++ b/docs/reference-ml-get_influencers.asciidoc @@ -45,16 +45,16 @@ Get anomaly detection job results for influencers. Influencers are the entities [source,ts] ---- -interface MlGetInfluencersRequest extends <> { - job_id: <> +interface MlGetInfluencersRequest extends <> { + job_id: <> desc?: boolean - end?: <> + end?: <> exclude_interim?: boolean - influencer_score?: <> - from?: <> - size?: <> - sort?: <> - start?: <> + influencer_score?: <> + from?: <> + size?: <> + sort?: <> + start?: <> page?: MlPage } ---- @@ -65,7 +65,7 @@ interface MlGetInfluencersRequest extends <> + count: <> influencers: MlInfluencer[] } ---- diff --git a/docs/reference-ml-get_job_stats.asciidoc b/docs/reference-ml-get_job_stats.asciidoc index 8ab82d55e..a4b6e9f57 100644 --- a/docs/reference-ml-get_job_stats.asciidoc +++ b/docs/reference-ml-get_job_stats.asciidoc @@ -45,8 +45,8 @@ Get anomaly detection jobs usage info. [source,ts] ---- -interface MlGetJobStatsRequest extends <> { - job_id?: <> +interface MlGetJobStatsRequest extends <> { + job_id?: <> allow_no_match?: boolean } ---- @@ -57,7 +57,7 @@ interface MlGetJobStatsRequest extends <> [source,ts] ---- interface MlGetJobStatsResponse { - count: <> + count: <> jobs: MlJobStats[] } ---- diff --git a/docs/reference-ml-get_jobs.asciidoc b/docs/reference-ml-get_jobs.asciidoc index fab7b5654..92b273aca 100644 --- a/docs/reference-ml-get_jobs.asciidoc +++ b/docs/reference-ml-get_jobs.asciidoc @@ -45,8 +45,8 @@ Get anomaly detection jobs configuration info. You can get information for multi [source,ts] ---- -interface MlGetJobsRequest extends <> { - job_id?: <> +interface MlGetJobsRequest extends <> { + job_id?: <> allow_no_match?: boolean exclude_generated?: boolean } @@ -58,7 +58,7 @@ interface MlGetJobsRequest extends <> { [source,ts] ---- interface MlGetJobsResponse { - count: <> + count: <> jobs: MlJob[] } ---- diff --git a/docs/reference-ml-get_memory_stats.asciidoc b/docs/reference-ml-get_memory_stats.asciidoc index 68353dab1..07398464d 100644 --- a/docs/reference-ml-get_memory_stats.asciidoc +++ b/docs/reference-ml-get_memory_stats.asciidoc @@ -45,11 +45,11 @@ Get machine learning memory usage info. Get information about how machine learni [source,ts] ---- -interface MlGetMemoryStatsRequest extends <> { - node_id?: <> +interface MlGetMemoryStatsRequest extends <> { + node_id?: <> human?: boolean - master_timeout?: <> - timeout?: <> + master_timeout?: <> + timeout?: <> } ---- @@ -59,9 +59,9 @@ interface MlGetMemoryStatsRequest extends <> - cluster_name: <> - nodes: Record<<>, MlGetMemoryStatsMemory> + _nodes: <> + cluster_name: <> + nodes: Record<<>, MlGetMemoryStatsMemory> } ---- diff --git a/docs/reference-ml-get_model_snapshot_upgrade_stats.asciidoc b/docs/reference-ml-get_model_snapshot_upgrade_stats.asciidoc index 8aba7ef1a..44950c2db 100644 --- a/docs/reference-ml-get_model_snapshot_upgrade_stats.asciidoc +++ b/docs/reference-ml-get_model_snapshot_upgrade_stats.asciidoc @@ -45,9 +45,9 @@ Get anomaly detection job model snapshot upgrade usage info. [source,ts] ---- -interface MlGetModelSnapshotUpgradeStatsRequest extends <> { - job_id: <> - snapshot_id: <> +interface MlGetModelSnapshotUpgradeStatsRequest extends <> { + job_id: <> + snapshot_id: <> allow_no_match?: boolean } ---- @@ -58,7 +58,7 @@ interface MlGetModelSnapshotUpgradeStatsRequest extends <> + count: <> model_snapshot_upgrades: MlModelSnapshotUpgrade[] } ---- diff --git a/docs/reference-ml-get_model_snapshots.asciidoc b/docs/reference-ml-get_model_snapshots.asciidoc index 80ae35a49..fc12ce62b 100644 --- a/docs/reference-ml-get_model_snapshots.asciidoc +++ b/docs/reference-ml-get_model_snapshots.asciidoc @@ -45,16 +45,16 @@ Get model snapshots info. [source,ts] ---- -interface MlGetModelSnapshotsRequest extends <> { - job_id: <> - snapshot_id?: <> - from?: <> - size?: <> +interface MlGetModelSnapshotsRequest extends <> { + job_id: <> + snapshot_id?: <> + from?: <> + size?: <> desc?: boolean - end?: <> + end?: <> page?: MlPage - sort?: <> - start?: <> + sort?: <> + start?: <> } ---- @@ -64,7 +64,7 @@ interface MlGetModelSnapshotsRequest extends <> + count: <> model_snapshots: MlModelSnapshot[] } ---- diff --git a/docs/reference-ml-get_overall_buckets.asciidoc b/docs/reference-ml-get_overall_buckets.asciidoc index 81ac4f7dd..28772e3d0 100644 --- a/docs/reference-ml-get_overall_buckets.asciidoc +++ b/docs/reference-ml-get_overall_buckets.asciidoc @@ -45,15 +45,15 @@ Get overall bucket results. Retrievs overall bucket results that summarize the b [source,ts] ---- -interface MlGetOverallBucketsRequest extends <> { - job_id: <> +interface MlGetOverallBucketsRequest extends <> { + job_id: <> allow_no_match?: boolean - bucket_span?: <> - end?: <> + bucket_span?: <> + end?: <> exclude_interim?: boolean - overall_score?: <> | string - start?: <> - top_n?: <> + overall_score?: <> | string + start?: <> + top_n?: <> } ---- @@ -63,7 +63,7 @@ interface MlGetOverallBucketsRequest extends <> + count: <> overall_buckets: MlOverallBucket[] } ---- diff --git a/docs/reference-ml-get_records.asciidoc b/docs/reference-ml-get_records.asciidoc index 56a4351ff..34f562c89 100644 --- a/docs/reference-ml-get_records.asciidoc +++ b/docs/reference-ml-get_records.asciidoc @@ -45,17 +45,17 @@ Get anomaly records for an anomaly detection job. Records contain the detailed a [source,ts] ---- -interface MlGetRecordsRequest extends <> { - job_id: <> - from?: <> - size?: <> +interface MlGetRecordsRequest extends <> { + job_id: <> + from?: <> + size?: <> desc?: boolean - end?: <> + end?: <> exclude_interim?: boolean page?: MlPage - record_score?: <> - sort?: <> - start?: <> + record_score?: <> + sort?: <> + start?: <> } ---- @@ -65,7 +65,7 @@ interface MlGetRecordsRequest extends <> [source,ts] ---- interface MlGetRecordsResponse { - count: <> + count: <> records: MlAnomaly[] } ---- diff --git a/docs/reference-ml-get_trained_models.asciidoc b/docs/reference-ml-get_trained_models.asciidoc index f9751b925..5355996d9 100644 --- a/docs/reference-ml-get_trained_models.asciidoc +++ b/docs/reference-ml-get_trained_models.asciidoc @@ -45,14 +45,14 @@ Get trained model configuration info. [source,ts] ---- -interface MlGetTrainedModelsRequest extends <> { - model_id?: <> +interface MlGetTrainedModelsRequest extends <> { + model_id?: <> allow_no_match?: boolean decompress_definition?: boolean exclude_generated?: boolean - from?: <> + from?: <> include?: MlInclude - size?: <> + size?: <> tags?: string | string[] } ---- @@ -63,7 +63,7 @@ interface MlGetTrainedModelsRequest extends <> + count: <> trained_model_configs: MlTrainedModelConfig[] } ---- diff --git a/docs/reference-ml-get_trained_models_stats.asciidoc b/docs/reference-ml-get_trained_models_stats.asciidoc index 2fa3cb1cd..9a50bf1a6 100644 --- a/docs/reference-ml-get_trained_models_stats.asciidoc +++ b/docs/reference-ml-get_trained_models_stats.asciidoc @@ -45,11 +45,11 @@ Get trained models usage info. You can get usage information for multiple traine [source,ts] ---- -interface MlGetTrainedModelsStatsRequest extends <> { - model_id?: <> +interface MlGetTrainedModelsStatsRequest extends <> { + model_id?: <> allow_no_match?: boolean - from?: <> - size?: <> + from?: <> + size?: <> } ---- @@ -59,7 +59,7 @@ interface MlGetTrainedModelsStatsRequest extends <> + count: <> trained_model_stats: MlTrainedModelStats[] } ---- diff --git a/docs/reference-ml-infer_trained_model.asciidoc b/docs/reference-ml-infer_trained_model.asciidoc index d76a02095..cffd2526c 100644 --- a/docs/reference-ml-infer_trained_model.asciidoc +++ b/docs/reference-ml-infer_trained_model.asciidoc @@ -45,9 +45,9 @@ Evaluate a trained model. [source,ts] ---- -interface MlInferTrainedModelRequest extends <> { - model_id: <> - timeout?: <> +interface MlInferTrainedModelRequest extends <> { + model_id: <> + timeout?: <> docs: Record[] inference_config?: MlInferenceConfigUpdateContainer } diff --git a/docs/reference-ml-info.asciidoc b/docs/reference-ml-info.asciidoc index 320785add..e6a691023 100644 --- a/docs/reference-ml-info.asciidoc +++ b/docs/reference-ml-info.asciidoc @@ -45,7 +45,7 @@ Return ML defaults and limits. Returns defaults and limits used by machine learn [source,ts] ---- -interface MlInfoRequest extends <> { +interface MlInfoRequest extends <> { } ---- diff --git a/docs/reference-ml-open_job.asciidoc b/docs/reference-ml-open_job.asciidoc index 28a6b475e..d855a50d9 100644 --- a/docs/reference-ml-open_job.asciidoc +++ b/docs/reference-ml-open_job.asciidoc @@ -45,9 +45,9 @@ Open anomaly detection jobs. An anomaly detection job must be opened to be ready [source,ts] ---- -interface MlOpenJobRequest extends <> { - job_id: <> - timeout?: <> +interface MlOpenJobRequest extends <> { + job_id: <> + timeout?: <> } ---- @@ -58,7 +58,7 @@ interface MlOpenJobRequest extends <> { ---- interface MlOpenJobResponse { opened: boolean - node: <> + node: <> } ---- diff --git a/docs/reference-ml-post_calendar_events.asciidoc b/docs/reference-ml-post_calendar_events.asciidoc index 74852be25..28a1cb875 100644 --- a/docs/reference-ml-post_calendar_events.asciidoc +++ b/docs/reference-ml-post_calendar_events.asciidoc @@ -45,8 +45,8 @@ Add scheduled events to the calendar. [source,ts] ---- -interface MlPostCalendarEventsRequest extends <> { - calendar_id: <> +interface MlPostCalendarEventsRequest extends <> { + calendar_id: <> events: MlCalendarEvent[] } ---- diff --git a/docs/reference-ml-post_data.asciidoc b/docs/reference-ml-post_data.asciidoc index d76e2ce1c..4a63a2a98 100644 --- a/docs/reference-ml-post_data.asciidoc +++ b/docs/reference-ml-post_data.asciidoc @@ -45,10 +45,10 @@ Send data to an anomaly detection job for analysis. IMPORTANT: For each job, dat [source,ts] ---- -interface MlPostDataRequest extends <> { - job_id: <> - reset_end?: <> - reset_start?: <> +interface MlPostDataRequest extends <> { + job_id: <> + reset_end?: <> + reset_start?: <> data?: TData[] } ---- @@ -59,21 +59,21 @@ interface MlPostDataRequest extends <> - earliest_record_timestamp: <> - empty_bucket_count: <> - input_bytes: <> - input_field_count: <> - input_record_count: <> - invalid_date_count: <> - job_id: <> - last_data_time: <> - latest_record_timestamp: <> - missing_field_count: <> - out_of_order_timestamp_count: <> - processed_field_count: <> - processed_record_count: <> - sparse_bucket_count: <> + bucket_count: <> + earliest_record_timestamp: <> + empty_bucket_count: <> + input_bytes: <> + input_field_count: <> + input_record_count: <> + invalid_date_count: <> + job_id: <> + last_data_time: <> + latest_record_timestamp: <> + missing_field_count: <> + out_of_order_timestamp_count: <> + processed_field_count: <> + processed_record_count: <> + sparse_bucket_count: <> } ---- diff --git a/docs/reference-ml-preview_data_frame_analytics.asciidoc b/docs/reference-ml-preview_data_frame_analytics.asciidoc index 608f67f1a..749423ae8 100644 --- a/docs/reference-ml-preview_data_frame_analytics.asciidoc +++ b/docs/reference-ml-preview_data_frame_analytics.asciidoc @@ -45,8 +45,8 @@ Preview features used by data frame analytics. Previews the extracted features u [source,ts] ---- -interface MlPreviewDataFrameAnalyticsRequest extends <> { - id?: <> +interface MlPreviewDataFrameAnalyticsRequest extends <> { + id?: <> config?: MlPreviewDataFrameAnalyticsDataframePreviewConfig } ---- @@ -57,7 +57,7 @@ interface MlPreviewDataFrameAnalyticsRequest extends <>, string>[] + feature_values: Record<<>, string>[] } ---- diff --git a/docs/reference-ml-preview_datafeed.asciidoc b/docs/reference-ml-preview_datafeed.asciidoc index 8b8b16cf8..adb9b4351 100644 --- a/docs/reference-ml-preview_datafeed.asciidoc +++ b/docs/reference-ml-preview_datafeed.asciidoc @@ -45,10 +45,10 @@ Preview a datafeed. This API returns the first "page" of search results from a d [source,ts] ---- -interface MlPreviewDatafeedRequest extends <> { - datafeed_id?: <> - start?: <> - end?: <> +interface MlPreviewDatafeedRequest extends <> { + datafeed_id?: <> + start?: <> + end?: <> datafeed_config?: MlDatafeedConfig job_config?: MlJobConfig } diff --git a/docs/reference-ml-put_calendar.asciidoc b/docs/reference-ml-put_calendar.asciidoc index 7304b4edb..b2dd76abf 100644 --- a/docs/reference-ml-put_calendar.asciidoc +++ b/docs/reference-ml-put_calendar.asciidoc @@ -45,9 +45,9 @@ Create a calendar. [source,ts] ---- -interface MlPutCalendarRequest extends <> { - calendar_id: <> - job_ids?: <>[] +interface MlPutCalendarRequest extends <> { + calendar_id: <> + job_ids?: <>[] description?: string } ---- @@ -58,9 +58,9 @@ interface MlPutCalendarRequest extends <> [source,ts] ---- interface MlPutCalendarResponse { - calendar_id: <> + calendar_id: <> description?: string - job_ids: <> + job_ids: <> } ---- diff --git a/docs/reference-ml-put_calendar_job.asciidoc b/docs/reference-ml-put_calendar_job.asciidoc index 47fa104e8..8d7f1a53e 100644 --- a/docs/reference-ml-put_calendar_job.asciidoc +++ b/docs/reference-ml-put_calendar_job.asciidoc @@ -45,9 +45,9 @@ Add anomaly detection job to calendar. [source,ts] ---- -interface MlPutCalendarJobRequest extends <> { - calendar_id: <> - job_id: <> +interface MlPutCalendarJobRequest extends <> { + calendar_id: <> + job_id: <> } ---- @@ -57,9 +57,9 @@ interface MlPutCalendarJobRequest extends <> + calendar_id: <> description?: string - job_ids: <> + job_ids: <> } ---- diff --git a/docs/reference-ml-put_data_frame_analytics.asciidoc b/docs/reference-ml-put_data_frame_analytics.asciidoc index e860dacf3..7840618da 100644 --- a/docs/reference-ml-put_data_frame_analytics.asciidoc +++ b/docs/reference-ml-put_data_frame_analytics.asciidoc @@ -45,18 +45,18 @@ Create a data frame analytics job. This API creates a data frame analytics job t [source,ts] ---- -interface MlPutDataFrameAnalyticsRequest extends <> { - id: <> +interface MlPutDataFrameAnalyticsRequest extends <> { + id: <> allow_lazy_start?: boolean analysis: MlDataframeAnalysisContainer analyzed_fields?: MlDataframeAnalysisAnalyzedFields | string[] description?: string dest: MlDataframeAnalyticsDestination - max_num_threads?: <> + max_num_threads?: <> model_memory_limit?: string source: MlDataframeAnalyticsSource - headers?: <> - version?: <> + headers?: <> + version?: <> } ---- @@ -70,14 +70,14 @@ interface MlPutDataFrameAnalyticsResponse { allow_lazy_start: boolean analysis: MlDataframeAnalysisContainer analyzed_fields?: MlDataframeAnalysisAnalyzedFields | string[] - create_time: <><<>> + create_time: <><<>> description?: string dest: MlDataframeAnalyticsDestination - id: <> - max_num_threads: <> + id: <> + max_num_threads: <> model_memory_limit: string source: MlDataframeAnalyticsSource - version: <> + version: <> } ---- diff --git a/docs/reference-ml-put_datafeed.asciidoc b/docs/reference-ml-put_datafeed.asciidoc index acfe59bbe..b108420f3 100644 --- a/docs/reference-ml-put_datafeed.asciidoc +++ b/docs/reference-ml-put_datafeed.asciidoc @@ -45,28 +45,28 @@ Create a datafeed. Datafeeds retrieve data from Elasticsearch for analysis by an [source,ts] ---- -interface MlPutDatafeedRequest extends <> { - datafeed_id: <> +interface MlPutDatafeedRequest extends <> { + datafeed_id: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_throttled?: boolean ignore_unavailable?: boolean aggregations?: Record chunking_config?: MlChunkingConfig delayed_data_check_config?: MlDelayedDataCheckConfig - frequency?: <> - indices?: <> + frequency?: <> + indices?: <> /** @alias indices */ - indexes?: <> - indices_options?: <> - job_id?: <> - max_empty_searches?: <> + indexes?: <> + indices_options?: <> + job_id?: <> + max_empty_searches?: <> query?: QueryDslQueryContainer - query_delay?: <> + query_delay?: <> runtime_mappings?: MappingRuntimeFields - script_fields?: Record>> - scroll_size?: <> - headers?: <> + script_fields?: Record>> + scroll_size?: <> + headers?: <> } ---- @@ -80,17 +80,17 @@ interface MlPutDatafeedResponse { authorization?: MlDatafeedAuthorization chunking_config: MlChunkingConfig delayed_data_check_config?: MlDelayedDataCheckConfig - datafeed_id: <> - frequency?: <> + datafeed_id: <> + frequency?: <> indices: string[] - job_id: <> - indices_options?: <> - max_empty_searches?: <> + job_id: <> + indices_options?: <> + max_empty_searches?: <> query: QueryDslQueryContainer - query_delay: <> + query_delay: <> runtime_mappings?: MappingRuntimeFields - script_fields?: Record>> - scroll_size: <> + script_fields?: Record>> + scroll_size: <> } ---- diff --git a/docs/reference-ml-put_filter.asciidoc b/docs/reference-ml-put_filter.asciidoc index 5c0b3dbfa..0198d4726 100644 --- a/docs/reference-ml-put_filter.asciidoc +++ b/docs/reference-ml-put_filter.asciidoc @@ -45,8 +45,8 @@ Create a filter. A filter contains a list of strings. It can be used by one or m [source,ts] ---- -interface MlPutFilterRequest extends <> { - filter_id: <> +interface MlPutFilterRequest extends <> { + filter_id: <> description?: string items?: string[] } @@ -59,7 +59,7 @@ interface MlPutFilterRequest extends <> { ---- interface MlPutFilterResponse { description: string - filter_id: <> + filter_id: <> items: string[] } ---- diff --git a/docs/reference-ml-put_job.asciidoc b/docs/reference-ml-put_job.asciidoc index f80e42b19..caf04d47c 100644 --- a/docs/reference-ml-put_job.asciidoc +++ b/docs/reference-ml-put_job.asciidoc @@ -45,23 +45,23 @@ Create an anomaly detection job. If you include a `datafeed_config`, you must ha [source,ts] ---- -interface MlPutJobRequest extends <> { - job_id: <> +interface MlPutJobRequest extends <> { + job_id: <> allow_lazy_open?: boolean analysis_config: MlAnalysisConfig analysis_limits?: MlAnalysisLimits - background_persist_interval?: <> + background_persist_interval?: <> custom_settings?: MlCustomSettings - daily_model_snapshot_retention_after_days?: <> + daily_model_snapshot_retention_after_days?: <> data_description: MlDataDescription datafeed_config?: MlDatafeedConfig description?: string groups?: string[] model_plot_config?: MlModelPlotConfig - model_snapshot_retention_days?: <> - renormalization_window_days?: <> - results_index_name?: <> - results_retention_days?: <> + model_snapshot_retention_days?: <> + renormalization_window_days?: <> + results_index_name?: <> + results_retention_days?: <> } ---- @@ -74,23 +74,23 @@ interface MlPutJobResponse { allow_lazy_open: boolean analysis_config: MlAnalysisConfigRead analysis_limits: MlAnalysisLimits - background_persist_interval?: <> - create_time: <> + background_persist_interval?: <> + create_time: <> custom_settings?: MlCustomSettings - daily_model_snapshot_retention_after_days: <> + daily_model_snapshot_retention_after_days: <> data_description: MlDataDescription datafeed_config?: MlDatafeed description?: string groups?: string[] - job_id: <> + job_id: <> job_type: string job_version: string model_plot_config?: MlModelPlotConfig - model_snapshot_id?: <> - model_snapshot_retention_days: <> - renormalization_window_days?: <> + model_snapshot_id?: <> + model_snapshot_retention_days: <> + renormalization_window_days?: <> results_index_name: string - results_retention_days?: <> + results_retention_days?: <> } ---- diff --git a/docs/reference-ml-put_trained_model.asciidoc b/docs/reference-ml-put_trained_model.asciidoc index a6b75d56a..0a46ba12f 100644 --- a/docs/reference-ml-put_trained_model.asciidoc +++ b/docs/reference-ml-put_trained_model.asciidoc @@ -45,8 +45,8 @@ Create a trained model. Enable you to supply a trained model that is not created [source,ts] ---- -interface MlPutTrainedModelRequest extends <> { - model_id: <> +interface MlPutTrainedModelRequest extends <> { + model_id: <> defer_definition_decompression?: boolean wait_for_completion?: boolean compressed_definition?: string @@ -56,7 +56,7 @@ interface MlPutTrainedModelRequest extends <> + model_size_bytes?: <> platform_architecture?: string tags?: string[] prefix_strings?: MlTrainedModelPrefixStrings diff --git a/docs/reference-ml-put_trained_model_alias.asciidoc b/docs/reference-ml-put_trained_model_alias.asciidoc index c80e5a514..6a1c6c1d4 100644 --- a/docs/reference-ml-put_trained_model_alias.asciidoc +++ b/docs/reference-ml-put_trained_model_alias.asciidoc @@ -45,9 +45,9 @@ Create or update a trained model alias. A trained model alias is a logical name [source,ts] ---- -interface MlPutTrainedModelAliasRequest extends <> { - model_alias: <> - model_id: <> +interface MlPutTrainedModelAliasRequest extends <> { + model_alias: <> + model_id: <> reassign?: boolean } ---- @@ -57,6 +57,6 @@ interface MlPutTrainedModelAliasRequest extends <> +type MlPutTrainedModelAliasResponse = <> ---- diff --git a/docs/reference-ml-put_trained_model_definition_part.asciidoc b/docs/reference-ml-put_trained_model_definition_part.asciidoc index f8be8ae79..40c239f70 100644 --- a/docs/reference-ml-put_trained_model_definition_part.asciidoc +++ b/docs/reference-ml-put_trained_model_definition_part.asciidoc @@ -45,12 +45,12 @@ Create part of a trained model definition. [source,ts] ---- -interface MlPutTrainedModelDefinitionPartRequest extends <> { - model_id: <> - part: <> +interface MlPutTrainedModelDefinitionPartRequest extends <> { + model_id: <> + part: <> definition: string - total_definition_length: <> - total_parts: <> + total_definition_length: <> + total_parts: <> } ---- @@ -59,6 +59,6 @@ interface MlPutTrainedModelDefinitionPartRequest extends <> +type MlPutTrainedModelDefinitionPartResponse = <> ---- diff --git a/docs/reference-ml-put_trained_model_vocabulary.asciidoc b/docs/reference-ml-put_trained_model_vocabulary.asciidoc index 5329b54f2..b2cc75a41 100644 --- a/docs/reference-ml-put_trained_model_vocabulary.asciidoc +++ b/docs/reference-ml-put_trained_model_vocabulary.asciidoc @@ -45,11 +45,11 @@ Create a trained model vocabulary. This API is supported only for natural langua [source,ts] ---- -interface MlPutTrainedModelVocabularyRequest extends <> { - model_id: <> +interface MlPutTrainedModelVocabularyRequest extends <> { + model_id: <> vocabulary: string[] merges?: string[] - scores?: <>[] + scores?: <>[] } ---- @@ -58,6 +58,6 @@ interface MlPutTrainedModelVocabularyRequest extends <> +type MlPutTrainedModelVocabularyResponse = <> ---- diff --git a/docs/reference-ml-reset_job.asciidoc b/docs/reference-ml-reset_job.asciidoc index ac42867b0..f3749687e 100644 --- a/docs/reference-ml-reset_job.asciidoc +++ b/docs/reference-ml-reset_job.asciidoc @@ -45,8 +45,8 @@ Reset an anomaly detection job. All model state and results are deleted. The job [source,ts] ---- -interface MlResetJobRequest extends <> { - job_id: <> +interface MlResetJobRequest extends <> { + job_id: <> wait_for_completion?: boolean delete_user_annotations?: boolean } @@ -57,6 +57,6 @@ interface MlResetJobRequest extends <> { [source,ts] ---- -type MlResetJobResponse = <> +type MlResetJobResponse = <> ---- diff --git a/docs/reference-ml-revert_model_snapshot.asciidoc b/docs/reference-ml-revert_model_snapshot.asciidoc index 81b3db7be..9b7fbcd54 100644 --- a/docs/reference-ml-revert_model_snapshot.asciidoc +++ b/docs/reference-ml-revert_model_snapshot.asciidoc @@ -45,9 +45,9 @@ Revert to a snapshot. The machine learning features react quickly to anomalous i [source,ts] ---- -interface MlRevertModelSnapshotRequest extends <> { - job_id: <> - snapshot_id: <> +interface MlRevertModelSnapshotRequest extends <> { + job_id: <> + snapshot_id: <> delete_intervening_results?: boolean } ---- diff --git a/docs/reference-ml-set_upgrade_mode.asciidoc b/docs/reference-ml-set_upgrade_mode.asciidoc index 703f766a4..9a5cdc887 100644 --- a/docs/reference-ml-set_upgrade_mode.asciidoc +++ b/docs/reference-ml-set_upgrade_mode.asciidoc @@ -45,9 +45,9 @@ Set upgrade_mode for ML indices. Sets a cluster wide upgrade_mode setting that p [source,ts] ---- -interface MlSetUpgradeModeRequest extends <> { +interface MlSetUpgradeModeRequest extends <> { enabled?: boolean - timeout?: <> + timeout?: <> } ---- @@ -56,6 +56,6 @@ interface MlSetUpgradeModeRequest extends <> +type MlSetUpgradeModeResponse = <> ---- diff --git a/docs/reference-ml-start_data_frame_analytics.asciidoc b/docs/reference-ml-start_data_frame_analytics.asciidoc index 90cc02f0a..f418e4173 100644 --- a/docs/reference-ml-start_data_frame_analytics.asciidoc +++ b/docs/reference-ml-start_data_frame_analytics.asciidoc @@ -45,9 +45,9 @@ Start a data frame analytics job. A data frame analytics job can be started and [source,ts] ---- -interface MlStartDataFrameAnalyticsRequest extends <> { - id: <> - timeout?: <> +interface MlStartDataFrameAnalyticsRequest extends <> { + id: <> + timeout?: <> } ---- @@ -58,7 +58,7 @@ interface MlStartDataFrameAnalyticsRequest extends <> + node: <> } ---- diff --git a/docs/reference-ml-start_datafeed.asciidoc b/docs/reference-ml-start_datafeed.asciidoc index 5ac0a4d2b..a9276a479 100644 --- a/docs/reference-ml-start_datafeed.asciidoc +++ b/docs/reference-ml-start_datafeed.asciidoc @@ -45,11 +45,11 @@ Start datafeeds. A datafeed must be started in order to retrieve data from Elast [source,ts] ---- -interface MlStartDatafeedRequest extends <> { - datafeed_id: <> - end?: <> - start?: <> - timeout?: <> +interface MlStartDatafeedRequest extends <> { + datafeed_id: <> + end?: <> + start?: <> + timeout?: <> } ---- @@ -59,7 +59,7 @@ interface MlStartDatafeedRequest extends <> + node: <> started: boolean } ---- diff --git a/docs/reference-ml-start_trained_model_deployment.asciidoc b/docs/reference-ml-start_trained_model_deployment.asciidoc index cad79365f..b7abb99d4 100644 --- a/docs/reference-ml-start_trained_model_deployment.asciidoc +++ b/docs/reference-ml-start_trained_model_deployment.asciidoc @@ -45,15 +45,15 @@ Start a trained model deployment. It allocates the model to every machine learni [source,ts] ---- -interface MlStartTrainedModelDeploymentRequest extends <> { - model_id: <> - cache_size?: <> +interface MlStartTrainedModelDeploymentRequest extends <> { + model_id: <> + cache_size?: <> deployment_id?: string - number_of_allocations?: <> + number_of_allocations?: <> priority?: MlTrainingPriority - queue_capacity?: <> - threads_per_allocation?: <> - timeout?: <> + queue_capacity?: <> + threads_per_allocation?: <> + timeout?: <> wait_for?: MlDeploymentAllocationState } ---- diff --git a/docs/reference-ml-stop_data_frame_analytics.asciidoc b/docs/reference-ml-stop_data_frame_analytics.asciidoc index 63849165f..088d19342 100644 --- a/docs/reference-ml-stop_data_frame_analytics.asciidoc +++ b/docs/reference-ml-stop_data_frame_analytics.asciidoc @@ -45,11 +45,11 @@ Stop data frame analytics jobs. A data frame analytics job can be started and st [source,ts] ---- -interface MlStopDataFrameAnalyticsRequest extends <> { - id: <> +interface MlStopDataFrameAnalyticsRequest extends <> { + id: <> allow_no_match?: boolean force?: boolean - timeout?: <> + timeout?: <> } ---- diff --git a/docs/reference-ml-stop_datafeed.asciidoc b/docs/reference-ml-stop_datafeed.asciidoc index 3d609c3f7..f4000e1bf 100644 --- a/docs/reference-ml-stop_datafeed.asciidoc +++ b/docs/reference-ml-stop_datafeed.asciidoc @@ -45,11 +45,11 @@ Stop datafeeds. A datafeed that is stopped ceases to retrieve data from Elastics [source,ts] ---- -interface MlStopDatafeedRequest extends <> { - datafeed_id: <> +interface MlStopDatafeedRequest extends <> { + datafeed_id: <> allow_no_match?: boolean force?: boolean - timeout?: <> + timeout?: <> } ---- diff --git a/docs/reference-ml-stop_trained_model_deployment.asciidoc b/docs/reference-ml-stop_trained_model_deployment.asciidoc index 0e4741c66..2043fa50b 100644 --- a/docs/reference-ml-stop_trained_model_deployment.asciidoc +++ b/docs/reference-ml-stop_trained_model_deployment.asciidoc @@ -45,8 +45,8 @@ Stop a trained model deployment. [source,ts] ---- -interface MlStopTrainedModelDeploymentRequest extends <> { - model_id: <> +interface MlStopTrainedModelDeploymentRequest extends <> { + model_id: <> allow_no_match?: boolean force?: boolean } diff --git a/docs/reference-ml-update_data_frame_analytics.asciidoc b/docs/reference-ml-update_data_frame_analytics.asciidoc index 333700a67..4381c8610 100644 --- a/docs/reference-ml-update_data_frame_analytics.asciidoc +++ b/docs/reference-ml-update_data_frame_analytics.asciidoc @@ -45,11 +45,11 @@ Update a data frame analytics job. [source,ts] ---- -interface MlUpdateDataFrameAnalyticsRequest extends <> { - id: <> +interface MlUpdateDataFrameAnalyticsRequest extends <> { + id: <> description?: string model_memory_limit?: string - max_num_threads?: <> + max_num_threads?: <> allow_lazy_start?: boolean } ---- @@ -64,14 +64,14 @@ interface MlUpdateDataFrameAnalyticsResponse { allow_lazy_start: boolean analysis: MlDataframeAnalysisContainer analyzed_fields?: MlDataframeAnalysisAnalyzedFields | string[] - create_time: <> + create_time: <> description?: string dest: MlDataframeAnalyticsDestination - id: <> - max_num_threads: <> + id: <> + max_num_threads: <> model_memory_limit: string source: MlDataframeAnalyticsSource - version: <> + version: <> } ---- diff --git a/docs/reference-ml-update_datafeed.asciidoc b/docs/reference-ml-update_datafeed.asciidoc index 5c5491812..764aff65e 100644 --- a/docs/reference-ml-update_datafeed.asciidoc +++ b/docs/reference-ml-update_datafeed.asciidoc @@ -45,27 +45,27 @@ Update a datafeed. You must stop and start the datafeed for the changes to be ap [source,ts] ---- -interface MlUpdateDatafeedRequest extends <> { - datafeed_id: <> +interface MlUpdateDatafeedRequest extends <> { + datafeed_id: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_throttled?: boolean ignore_unavailable?: boolean aggregations?: Record chunking_config?: MlChunkingConfig delayed_data_check_config?: MlDelayedDataCheckConfig - frequency?: <> + frequency?: <> indices?: string[] /** @alias indices */ indexes?: string[] - indices_options?: <> - job_id?: <> - max_empty_searches?: <> + indices_options?: <> + job_id?: <> + max_empty_searches?: <> query?: QueryDslQueryContainer - query_delay?: <> + query_delay?: <> runtime_mappings?: MappingRuntimeFields - script_fields?: Record>> - scroll_size?: <> + script_fields?: Record>> + scroll_size?: <> } ---- @@ -79,17 +79,17 @@ interface MlUpdateDatafeedResponse { aggregations?: Record chunking_config: MlChunkingConfig delayed_data_check_config?: MlDelayedDataCheckConfig - datafeed_id: <> - frequency?: <> + datafeed_id: <> + frequency?: <> indices: string[] - indices_options?: <> - job_id: <> - max_empty_searches?: <> + indices_options?: <> + job_id: <> + max_empty_searches?: <> query: QueryDslQueryContainer - query_delay: <> + query_delay: <> runtime_mappings?: MappingRuntimeFields - script_fields?: Record>> - scroll_size: <> + script_fields?: Record>> + scroll_size: <> } ---- diff --git a/docs/reference-ml-update_filter.asciidoc b/docs/reference-ml-update_filter.asciidoc index 844720385..cb71024e7 100644 --- a/docs/reference-ml-update_filter.asciidoc +++ b/docs/reference-ml-update_filter.asciidoc @@ -45,8 +45,8 @@ Update a filter. Updates the description of a filter, adds items, or removes ite [source,ts] ---- -interface MlUpdateFilterRequest extends <> { - filter_id: <> +interface MlUpdateFilterRequest extends <> { + filter_id: <> add_items?: string[] description?: string remove_items?: string[] @@ -60,7 +60,7 @@ interface MlUpdateFilterRequest extends < ---- interface MlUpdateFilterResponse { description: string - filter_id: <> + filter_id: <> items: string[] } ---- diff --git a/docs/reference-ml-update_job.asciidoc b/docs/reference-ml-update_job.asciidoc index ce235cc6d..0ecce3234 100644 --- a/docs/reference-ml-update_job.asciidoc +++ b/docs/reference-ml-update_job.asciidoc @@ -45,20 +45,20 @@ Update an anomaly detection job. Updates certain properties of an anomaly detect [source,ts] ---- -interface MlUpdateJobRequest extends <> { - job_id: <> +interface MlUpdateJobRequest extends <> { + job_id: <> allow_lazy_open?: boolean analysis_limits?: MlAnalysisMemoryLimit - background_persist_interval?: <> + background_persist_interval?: <> custom_settings?: Record categorization_filters?: string[] description?: string model_plot_config?: MlModelPlotConfig - model_prune_window?: <> - daily_model_snapshot_retention_after_days?: <> - model_snapshot_retention_days?: <> - renormalization_window_days?: <> - results_retention_days?: <> + model_prune_window?: <> + daily_model_snapshot_retention_after_days?: <> + model_snapshot_retention_days?: <> + renormalization_window_days?: <> + results_retention_days?: <> groups?: string[] detectors?: MlDetector[] per_partition_categorization?: MlPerPartitionCategorization @@ -74,24 +74,24 @@ interface MlUpdateJobResponse { allow_lazy_open: boolean analysis_config: MlAnalysisConfigRead analysis_limits: MlAnalysisLimits - background_persist_interval?: <> - create_time: <><<>> - finished_time?: <><<>> + background_persist_interval?: <> + create_time: <><<>> + finished_time?: <><<>> custom_settings?: Record - daily_model_snapshot_retention_after_days: <> + daily_model_snapshot_retention_after_days: <> data_description: MlDataDescription datafeed_config?: MlDatafeed description?: string groups?: string[] - job_id: <> + job_id: <> job_type: string - job_version: <> + job_version: <> model_plot_config?: MlModelPlotConfig - model_snapshot_id?: <> - model_snapshot_retention_days: <> - renormalization_window_days?: <> - results_index_name: <> - results_retention_days?: <> + model_snapshot_id?: <> + model_snapshot_retention_days: <> + renormalization_window_days?: <> + results_index_name: <> + results_retention_days?: <> } ---- diff --git a/docs/reference-ml-update_model_snapshot.asciidoc b/docs/reference-ml-update_model_snapshot.asciidoc index b03c3d71f..ff237e236 100644 --- a/docs/reference-ml-update_model_snapshot.asciidoc +++ b/docs/reference-ml-update_model_snapshot.asciidoc @@ -45,9 +45,9 @@ Update a snapshot. Updates certain properties of a snapshot. [source,ts] ---- -interface MlUpdateModelSnapshotRequest extends <> { - job_id: <> - snapshot_id: <> +interface MlUpdateModelSnapshotRequest extends <> { + job_id: <> + snapshot_id: <> description?: string retain?: boolean } diff --git a/docs/reference-ml-update_trained_model_deployment.asciidoc b/docs/reference-ml-update_trained_model_deployment.asciidoc index ad9121193..dac9d7017 100644 --- a/docs/reference-ml-update_trained_model_deployment.asciidoc +++ b/docs/reference-ml-update_trained_model_deployment.asciidoc @@ -45,9 +45,9 @@ Update a trained model deployment. [source,ts] ---- -interface MlUpdateTrainedModelDeploymentRequest extends <> { - model_id: <> - number_of_allocations?: <> +interface MlUpdateTrainedModelDeploymentRequest extends <> { + model_id: <> + number_of_allocations?: <> } ---- diff --git a/docs/reference-ml-upgrade_job_snapshot.asciidoc b/docs/reference-ml-upgrade_job_snapshot.asciidoc index 7c8d0ae0c..4eb46b4d0 100644 --- a/docs/reference-ml-upgrade_job_snapshot.asciidoc +++ b/docs/reference-ml-upgrade_job_snapshot.asciidoc @@ -45,11 +45,11 @@ Upgrade a snapshot. Upgrades an anomaly detection model snapshot to the latest m [source,ts] ---- -interface MlUpgradeJobSnapshotRequest extends <> { - job_id: <> - snapshot_id: <> +interface MlUpgradeJobSnapshotRequest extends <> { + job_id: <> + snapshot_id: <> wait_for_completion?: boolean - timeout?: <> + timeout?: <> } ---- @@ -59,7 +59,7 @@ interface MlUpgradeJobSnapshotRequest extends <> + node: <> completed: boolean } ---- diff --git a/docs/reference-monitoring-bulk.asciidoc b/docs/reference-monitoring-bulk.asciidoc index 071ba92ba..e323983ea 100644 --- a/docs/reference-monitoring-bulk.asciidoc +++ b/docs/reference-monitoring-bulk.asciidoc @@ -45,11 +45,11 @@ Used by the monitoring features to send monitoring data. [source,ts] ---- -interface MonitoringBulkRequest extends <> { +interface MonitoringBulkRequest extends <> { type?: string system_id: string system_api_version: string - interval: <> + interval: <> operations?: (BulkOperationContainer | BulkUpdateAction | TDocument)[] } ---- @@ -60,10 +60,10 @@ interface MonitoringBulkRequest [source,ts] ---- interface MonitoringBulkResponse { - error?: <> + error?: <> errors: boolean ignored: boolean - took: <> + took: <> } ---- diff --git a/docs/reference-msearch.asciidoc b/docs/reference-msearch.asciidoc index e1f2a89ca..30ebb8126 100644 --- a/docs/reference-msearch.asciidoc +++ b/docs/reference-msearch.asciidoc @@ -45,20 +45,20 @@ Run multiple searches. The format of the request is similar to the bulk API form [source,ts] ---- -interface MsearchRequest extends <> { - index?: <> +interface MsearchRequest extends <> { + index?: <> allow_no_indices?: boolean ccs_minimize_roundtrips?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_throttled?: boolean ignore_unavailable?: boolean include_named_queries_score?: boolean - max_concurrent_searches?: <> - max_concurrent_shard_requests?: <> - pre_filter_shard_size?: <> + max_concurrent_searches?: <> + max_concurrent_shard_requests?: <> + pre_filter_shard_size?: <> rest_total_hits_as_int?: boolean - routing?: <> - search_type?: <> + routing?: <> + search_type?: <> typed_keys?: boolean searches?: MsearchRequestItem[] } @@ -69,6 +69,6 @@ interface MsearchRequest extends <> { [source,ts] ---- -type MsearchResponse>, AggregationsAggregate>> = MsearchMultiSearchResult +type MsearchResponse>, AggregationsAggregate>> = MsearchMultiSearchResult ---- diff --git a/docs/reference-msearch_template.asciidoc b/docs/reference-msearch_template.asciidoc index ae866f2cf..21ff5ce8f 100644 --- a/docs/reference-msearch_template.asciidoc +++ b/docs/reference-msearch_template.asciidoc @@ -45,11 +45,11 @@ Run multiple templated searches. [source,ts] ---- -interface MsearchTemplateRequest extends <> { - index?: <> +interface MsearchTemplateRequest extends <> { + index?: <> ccs_minimize_roundtrips?: boolean - max_concurrent_searches?: <> - search_type?: <> + max_concurrent_searches?: <> + search_type?: <> rest_total_hits_as_int?: boolean typed_keys?: boolean search_templates?: MsearchTemplateRequestItem[] @@ -61,6 +61,6 @@ interface MsearchTemplateRequest extends <>, AggregationsAggregate>> = MsearchMultiSearchResult +type MsearchTemplateResponse>, AggregationsAggregate>> = MsearchMultiSearchResult ---- diff --git a/docs/reference-mtermvectors.asciidoc b/docs/reference-mtermvectors.asciidoc index 9485d37a0..d16d81fbc 100644 --- a/docs/reference-mtermvectors.asciidoc +++ b/docs/reference-mtermvectors.asciidoc @@ -45,21 +45,21 @@ Get multiple term vectors. You can specify existing documents by index and ID or [source,ts] ---- -interface MtermvectorsRequest extends <> { - index?: <> - fields?: <> +interface MtermvectorsRequest extends <> { + index?: <> + fields?: <> field_statistics?: boolean offsets?: boolean payloads?: boolean positions?: boolean preference?: string realtime?: boolean - routing?: <> + routing?: <> term_statistics?: boolean - version?: <> - version_type?: <> + version?: <> + version_type?: <> docs?: MtermvectorsOperation[] - ids?: <>[] + ids?: <>[] } ---- diff --git a/docs/reference-nodes-clear_repositories_metering_archive.asciidoc b/docs/reference-nodes-clear_repositories_metering_archive.asciidoc index 43d8f0b8d..e90e8e81b 100644 --- a/docs/reference-nodes-clear_repositories_metering_archive.asciidoc +++ b/docs/reference-nodes-clear_repositories_metering_archive.asciidoc @@ -45,9 +45,9 @@ You can use this API to clear the archived repositories metering information in [source,ts] ---- -interface NodesClearRepositoriesMeteringArchiveRequest extends <> { - node_id: <> - max_archive_version: <> +interface NodesClearRepositoriesMeteringArchiveRequest extends <> { + node_id: <> + max_archive_version: <> } ---- diff --git a/docs/reference-nodes-get_repositories_metering_info.asciidoc b/docs/reference-nodes-get_repositories_metering_info.asciidoc index 9aead8537..f72fba76d 100644 --- a/docs/reference-nodes-get_repositories_metering_info.asciidoc +++ b/docs/reference-nodes-get_repositories_metering_info.asciidoc @@ -45,8 +45,8 @@ You can use the cluster repositories metering API to retrieve repositories meter [source,ts] ---- -interface NodesGetRepositoriesMeteringInfoRequest extends <> { - node_id: <> +interface NodesGetRepositoriesMeteringInfoRequest extends <> { + node_id: <> } ---- diff --git a/docs/reference-nodes-hot_threads.asciidoc b/docs/reference-nodes-hot_threads.asciidoc index 8e4460b14..e2cb71538 100644 --- a/docs/reference-nodes-hot_threads.asciidoc +++ b/docs/reference-nodes-hot_threads.asciidoc @@ -45,16 +45,16 @@ This API yields a breakdown of the hot threads on each selected node in the clus [source,ts] ---- -interface NodesHotThreadsRequest extends <> { - node_id?: <> +interface NodesHotThreadsRequest extends <> { + node_id?: <> ignore_idle_threads?: boolean - interval?: <> - snapshots?: <> - master_timeout?: <> - threads?: <> - timeout?: <> - type?: <> - sort?: <> + interval?: <> + snapshots?: <> + master_timeout?: <> + threads?: <> + timeout?: <> + type?: <> + sort?: <> } ---- diff --git a/docs/reference-nodes-info.asciidoc b/docs/reference-nodes-info.asciidoc index 3aa5ec737..303b5904d 100644 --- a/docs/reference-nodes-info.asciidoc +++ b/docs/reference-nodes-info.asciidoc @@ -45,12 +45,12 @@ Returns cluster nodes information. [source,ts] ---- -interface NodesInfoRequest extends <> { - node_id?: <> - metric?: <> +interface NodesInfoRequest extends <> { + node_id?: <> + metric?: <> flat_settings?: boolean - master_timeout?: <> - timeout?: <> + master_timeout?: <> + timeout?: <> } ---- diff --git a/docs/reference-nodes-reload_secure_settings.asciidoc b/docs/reference-nodes-reload_secure_settings.asciidoc index 5f8575c89..73a50430f 100644 --- a/docs/reference-nodes-reload_secure_settings.asciidoc +++ b/docs/reference-nodes-reload_secure_settings.asciidoc @@ -45,10 +45,10 @@ Reloads the keystore on nodes in the cluster. [source,ts] ---- -interface NodesReloadSecureSettingsRequest extends <> { - node_id?: <> - timeout?: <> - secure_settings_password?: <> +interface NodesReloadSecureSettingsRequest extends <> { + node_id?: <> + timeout?: <> + secure_settings_password?: <> } ---- diff --git a/docs/reference-nodes-stats.asciidoc b/docs/reference-nodes-stats.asciidoc index 93fe3f660..ec45cc45b 100644 --- a/docs/reference-nodes-stats.asciidoc +++ b/docs/reference-nodes-stats.asciidoc @@ -45,18 +45,18 @@ Returns cluster nodes statistics. [source,ts] ---- -interface NodesStatsRequest extends <> { - node_id?: <> - metric?: <> - index_metric?: <> - completion_fields?: <> - fielddata_fields?: <> - fields?: <> +interface NodesStatsRequest extends <> { + node_id?: <> + metric?: <> + index_metric?: <> + completion_fields?: <> + fielddata_fields?: <> + fields?: <> groups?: boolean include_segment_file_sizes?: boolean - level?: <> - master_timeout?: <> - timeout?: <> + level?: <> + master_timeout?: <> + timeout?: <> types?: string[] include_unloaded_segments?: boolean } diff --git a/docs/reference-nodes-usage.asciidoc b/docs/reference-nodes-usage.asciidoc index 33bb7ae2c..0d62e2fdb 100644 --- a/docs/reference-nodes-usage.asciidoc +++ b/docs/reference-nodes-usage.asciidoc @@ -45,10 +45,10 @@ Returns information on the usage of features. [source,ts] ---- -interface NodesUsageRequest extends <> { - node_id?: <> - metric?: <> - timeout?: <> +interface NodesUsageRequest extends <> { + node_id?: <> + metric?: <> + timeout?: <> } ---- diff --git a/docs/reference-open_point_in_time.asciidoc b/docs/reference-open_point_in_time.asciidoc index 34810c53a..223b8d079 100644 --- a/docs/reference-open_point_in_time.asciidoc +++ b/docs/reference-open_point_in_time.asciidoc @@ -45,13 +45,13 @@ Open a point in time. A search request by default runs against the most recent v [source,ts] ---- -interface OpenPointInTimeRequest extends <> { - index: <> - keep_alive: <> +interface OpenPointInTimeRequest extends <> { + index: <> + keep_alive: <> ignore_unavailable?: boolean preference?: string - routing?: <> - expand_wildcards?: <> + routing?: <> + expand_wildcards?: <> index_filter?: QueryDslQueryContainer } ---- @@ -62,8 +62,8 @@ interface OpenPointInTimeRequest extends <> - id: <> + _shards: <> + id: <> } ---- diff --git a/docs/reference-ping.asciidoc b/docs/reference-ping.asciidoc index f61278558..eb9f4070d 100644 --- a/docs/reference-ping.asciidoc +++ b/docs/reference-ping.asciidoc @@ -45,7 +45,7 @@ Ping the cluster. Returns whether the cluster is running. [source,ts] ---- -interface PingRequest extends <> { +interface PingRequest extends <> { } ---- diff --git a/docs/reference-put_script.asciidoc b/docs/reference-put_script.asciidoc index c84d0e5c9..6a62ac436 100644 --- a/docs/reference-put_script.asciidoc +++ b/docs/reference-put_script.asciidoc @@ -45,12 +45,12 @@ Create or update a script or search template. Creates or updates a stored script [source,ts] ---- -interface PutScriptRequest extends <> { - id: <> - context?: <> - master_timeout?: <> - timeout?: <> - script: <> +interface PutScriptRequest extends <> { + id: <> + context?: <> + master_timeout?: <> + timeout?: <> + script: <> } ---- @@ -59,6 +59,6 @@ interface PutScriptRequest extends <> { [source,ts] ---- -type PutScriptResponse = <> +type PutScriptResponse = <> ---- diff --git a/docs/reference-query_rules-delete_rule.asciidoc b/docs/reference-query_rules-delete_rule.asciidoc index 0aa7ea40c..66ee560de 100644 --- a/docs/reference-query_rules-delete_rule.asciidoc +++ b/docs/reference-query_rules-delete_rule.asciidoc @@ -45,9 +45,9 @@ Deletes a query rule within a query ruleset. [source,ts] ---- -interface QueryRulesDeleteRuleRequest extends <> { - ruleset_id: <> - rule_id: <> +interface QueryRulesDeleteRuleRequest extends <> { + ruleset_id: <> + rule_id: <> } ---- @@ -56,6 +56,6 @@ interface QueryRulesDeleteRuleRequest extends <> +type QueryRulesDeleteRuleResponse = <> ---- diff --git a/docs/reference-query_rules-delete_ruleset.asciidoc b/docs/reference-query_rules-delete_ruleset.asciidoc index 79b7accfd..34f3b03a2 100644 --- a/docs/reference-query_rules-delete_ruleset.asciidoc +++ b/docs/reference-query_rules-delete_ruleset.asciidoc @@ -45,8 +45,8 @@ Deletes a query ruleset. [source,ts] ---- -interface QueryRulesDeleteRulesetRequest extends <> { - ruleset_id: <> +interface QueryRulesDeleteRulesetRequest extends <> { + ruleset_id: <> } ---- @@ -55,6 +55,6 @@ interface QueryRulesDeleteRulesetRequest extends <> +type QueryRulesDeleteRulesetResponse = <> ---- diff --git a/docs/reference-query_rules-get_rule.asciidoc b/docs/reference-query_rules-get_rule.asciidoc index 3bfae550c..02b9a9f1e 100644 --- a/docs/reference-query_rules-get_rule.asciidoc +++ b/docs/reference-query_rules-get_rule.asciidoc @@ -45,9 +45,9 @@ Returns the details about a query rule within a query ruleset [source,ts] ---- -interface QueryRulesGetRuleRequest extends <> { - ruleset_id: <> - rule_id: <> +interface QueryRulesGetRuleRequest extends <> { + ruleset_id: <> + rule_id: <> } ---- diff --git a/docs/reference-query_rules-get_ruleset.asciidoc b/docs/reference-query_rules-get_ruleset.asciidoc index 406426fb5..498f9bdd2 100644 --- a/docs/reference-query_rules-get_ruleset.asciidoc +++ b/docs/reference-query_rules-get_ruleset.asciidoc @@ -45,8 +45,8 @@ Returns the details about a query ruleset [source,ts] ---- -interface QueryRulesGetRulesetRequest extends <> { - ruleset_id: <> +interface QueryRulesGetRulesetRequest extends <> { + ruleset_id: <> } ---- diff --git a/docs/reference-query_rules-list_rulesets.asciidoc b/docs/reference-query_rules-list_rulesets.asciidoc index aea990d15..0952cbd3b 100644 --- a/docs/reference-query_rules-list_rulesets.asciidoc +++ b/docs/reference-query_rules-list_rulesets.asciidoc @@ -45,9 +45,9 @@ Returns summarized information about existing query rulesets. [source,ts] ---- -interface QueryRulesListRulesetsRequest extends <> { - from?: <> - size?: <> +interface QueryRulesListRulesetsRequest extends <> { + from?: <> + size?: <> } ---- @@ -57,7 +57,7 @@ interface QueryRulesListRulesetsRequest extends <> + count: <> results: QueryRulesListRulesetsQueryRulesetListItem[] } ---- diff --git a/docs/reference-query_rules-put_rule.asciidoc b/docs/reference-query_rules-put_rule.asciidoc index d029012e6..8fa094e17 100644 --- a/docs/reference-query_rules-put_rule.asciidoc +++ b/docs/reference-query_rules-put_rule.asciidoc @@ -45,13 +45,13 @@ Creates or updates a query rule within a query ruleset. [source,ts] ---- -interface QueryRulesPutRuleRequest extends <> { - ruleset_id: <> - rule_id: <> +interface QueryRulesPutRuleRequest extends <> { + ruleset_id: <> + rule_id: <> type: QueryRulesQueryRuleType criteria: QueryRulesQueryRuleCriteria | QueryRulesQueryRuleCriteria[] actions: QueryRulesQueryRuleActions - priority?: <> + priority?: <> } ---- @@ -61,7 +61,7 @@ interface QueryRulesPutRuleRequest extends <> + result: <> } ---- diff --git a/docs/reference-query_rules-put_ruleset.asciidoc b/docs/reference-query_rules-put_ruleset.asciidoc index ad658c0f5..74f0f16cb 100644 --- a/docs/reference-query_rules-put_ruleset.asciidoc +++ b/docs/reference-query_rules-put_ruleset.asciidoc @@ -45,8 +45,8 @@ Creates or updates a query ruleset. [source,ts] ---- -interface QueryRulesPutRulesetRequest extends <> { - ruleset_id: <> +interface QueryRulesPutRulesetRequest extends <> { + ruleset_id: <> rules: QueryRulesQueryRule | QueryRulesQueryRule[] } ---- @@ -57,7 +57,7 @@ interface QueryRulesPutRulesetRequest extends <> + result: <> } ---- diff --git a/docs/reference-query_rules-test.asciidoc b/docs/reference-query_rules-test.asciidoc index 7c9e19a48..21a51b28d 100644 --- a/docs/reference-query_rules-test.asciidoc +++ b/docs/reference-query_rules-test.asciidoc @@ -45,8 +45,8 @@ Creates or updates a query ruleset. [source,ts] ---- -interface QueryRulesTestRequest extends <> { - ruleset_id: <> +interface QueryRulesTestRequest extends <> { + ruleset_id: <> match_criteria: Record } ---- @@ -57,7 +57,7 @@ interface QueryRulesTestRequest extends < [source,ts] ---- interface QueryRulesTestResponse { - total_matched_rules: <> + total_matched_rules: <> matched_rules: QueryRulesTestQueryRulesetMatchedRule[] } ---- diff --git a/docs/reference-rank_eval.asciidoc b/docs/reference-rank_eval.asciidoc index 7c058b90f..e5642685f 100644 --- a/docs/reference-rank_eval.asciidoc +++ b/docs/reference-rank_eval.asciidoc @@ -45,10 +45,10 @@ Evaluate ranked search results. Evaluate the quality of ranked search results ov [source,ts] ---- -interface RankEvalRequest extends <> { - index?: <> +interface RankEvalRequest extends <> { + index?: <> allow_no_indices?: boolean - expand_wildcards?: <> + expand_wildcards?: <> ignore_unavailable?: boolean search_type?: string requests: RankEvalRankEvalRequestItem[] @@ -62,8 +62,8 @@ interface RankEvalRequest extends <> { [source,ts] ---- interface RankEvalResponse { - metric_score: <> - details: Record<<>, RankEvalRankEvalMetricDetail> + metric_score: <> + details: Record<<>, RankEvalRankEvalMetricDetail> failures: Record } ---- diff --git a/docs/reference-reindex.asciidoc b/docs/reference-reindex.asciidoc index ff4ac3374..f0bac428c 100644 --- a/docs/reference-reindex.asciidoc +++ b/docs/reference-reindex.asciidoc @@ -45,20 +45,20 @@ Reindex documents. Copies documents from a source to a destination. The source c [source,ts] ---- -interface ReindexRequest extends <> { +interface ReindexRequest extends <> { refresh?: boolean - requests_per_second?: <> - scroll?: <> - slices?: <> - timeout?: <> - wait_for_active_shards?: <> + requests_per_second?: <> + scroll?: <> + slices?: <> + timeout?: <> + wait_for_active_shards?: <> wait_for_completion?: boolean require_alias?: boolean - conflicts?: <> + conflicts?: <> dest: ReindexDestination - max_docs?: <> - script?: <> | string - size?: <> + max_docs?: <> + script?: <