Use section headers for shared types

This commit is contained in:
Josh Mock
2024-11-19 12:23:01 -06:00
parent 6151aab208
commit ab21735b57
469 changed files with 2639 additions and 2850 deletions

View File

@ -45,8 +45,8 @@ Delete an async search. If the asynchronous search is still running, it is cance
[source,ts]
----
interface AsyncSearchDeleteRequest extends <<shared-type-request-base, RequestBase>> {
id: <<shared-type-id, Id>>
interface AsyncSearchDeleteRequest extends <<RequestBase>> {
id: <<Id>>
}
----
@ -55,6 +55,6 @@ interface AsyncSearchDeleteRequest extends <<shared-type-request-base, RequestBa
[source,ts]
----
type AsyncSearchDeleteResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
type AsyncSearchDeleteResponse = <<AcknowledgedResponseBase>>
----

View File

@ -45,11 +45,11 @@ Get async search results. Retrieve the results of a previously submitted asynchr
[source,ts]
----
interface AsyncSearchGetRequest extends <<shared-type-request-base, RequestBase>> {
id: <<shared-type-id, Id>>
keep_alive?: <<shared-type-duration, Duration>>
interface AsyncSearchGetRequest extends <<RequestBase>> {
id: <<Id>>
keep_alive?: <<Duration>>
typed_keys?: boolean
wait_for_completion_timeout?: <<shared-type-duration, Duration>>
wait_for_completion_timeout?: <<Duration>>
}
----
@ -58,6 +58,6 @@ interface AsyncSearchGetRequest extends <<shared-type-request-base, RequestBase>
[source,ts]
----
type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<<<shared-type-aggregate-name, AggregateName>>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
----

View File

@ -45,8 +45,8 @@ Get the async search status. Get the status of a previously submitted async sear
[source,ts]
----
interface AsyncSearchStatusRequest extends <<shared-type-request-base, RequestBase>> {
id: <<shared-type-id, Id>>
interface AsyncSearchStatusRequest extends <<RequestBase>> {
id: <<Id>>
}
----

View File

@ -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 <<shared-type-request-base, RequestBase>> {
index?: <<shared-type-indices, Indices>>
wait_for_completion_timeout?: <<shared-type-duration, Duration>>
interface AsyncSearchSubmitRequest extends <<RequestBase>> {
index?: <<Indices>>
wait_for_completion_timeout?: <<Duration>>
keep_on_completion?: boolean
keep_alive?: <<shared-type-duration, Duration>>
keep_alive?: <<Duration>>
allow_no_indices?: boolean
allow_partial_search_results?: boolean
analyzer?: string
analyze_wildcard?: boolean
batched_reduce_size?: <<shared-type-long, long>>
batched_reduce_size?: <<long>>
ccs_minimize_roundtrips?: boolean
default_operator?: QueryDslOperator
df?: string
expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
expand_wildcards?: <<ExpandWildcards>>
ignore_throttled?: boolean
ignore_unavailable?: boolean
lenient?: boolean
max_concurrent_shard_requests?: <<shared-type-long, long>>
min_compatible_shard_node?: <<shared-type-version-string, VersionString>>
max_concurrent_shard_requests?: <<long>>
min_compatible_shard_node?: <<VersionString>>
preference?: string
pre_filter_shard_size?: <<shared-type-long, long>>
pre_filter_shard_size?: <<long>>
request_cache?: boolean
routing?: <<shared-type-routing, Routing>>
scroll?: <<shared-type-duration, Duration>>
search_type?: <<shared-type-search-type, SearchType>>
suggest_field?: <<shared-type-field, Field>>
suggest_mode?: <<shared-type-suggest-mode, SuggestMode>>
suggest_size?: <<shared-type-long, long>>
routing?: <<Routing>>
scroll?: <<Duration>>
search_type?: <<SearchType>>
suggest_field?: <<Field>>
suggest_mode?: <<SuggestMode>>
suggest_size?: <<long>>
suggest_text?: string
typed_keys?: boolean
rest_total_hits_as_int?: boolean
_source_excludes?: <<shared-type-fields, Fields>>
_source_includes?: <<shared-type-fields, Fields>>
_source_excludes?: <<Fields>>
_source_includes?: <<Fields>>
q?: string
aggregations?: Record<string, AggregationsAggregationContainer>
/** @alias aggregations */
@ -85,31 +85,31 @@ interface AsyncSearchSubmitRequest extends <<shared-type-request-base, RequestBa
collapse?: SearchFieldCollapse
explain?: boolean
ext?: Record<string, any>
from?: <<shared-type-integer, integer>>
from?: <<integer>>
highlight?: SearchHighlight
track_total_hits?: SearchTrackHits
indices_boost?: Record<<<shared-type-index-name, IndexName>>, <<shared-type-double, double>>>[]
docvalue_fields?: (QueryDslFieldAndFormat | <<shared-type-field, Field>>)[]
knn?: <<shared-type-knn-search, KnnSearch>> | <<shared-type-knn-search, KnnSearch>>[]
min_score?: <<shared-type-double, double>>
indices_boost?: Record<<<IndexName>>, <<double>>>[]
docvalue_fields?: (QueryDslFieldAndFormat | <<Field>>)[]
knn?: <<KnnSearch>> | <<KnnSearch>>[]
min_score?: <<double>>
post_filter?: QueryDslQueryContainer
profile?: boolean
query?: QueryDslQueryContainer
rescore?: SearchRescore | SearchRescore[]
script_fields?: Record<string, <<shared-type-script-field, ScriptField>>>
search_after?: <<shared-type-sort-results, SortResults>>
size?: <<shared-type-integer, integer>>
slice?: <<shared-type-sliced-scroll, SlicedScroll>>
sort?: <<shared-type-sort, Sort>>
script_fields?: Record<string, <<ScriptField>>>
search_after?: <<SortResults>>
size?: <<integer>>
slice?: <<SlicedScroll>>
sort?: <<Sort>>
_source?: SearchSourceConfig
fields?: (QueryDslFieldAndFormat | <<shared-type-field, Field>>)[]
fields?: (QueryDslFieldAndFormat | <<Field>>)[]
suggest?: SearchSuggester
terminate_after?: <<shared-type-long, long>>
terminate_after?: <<long>>
timeout?: string
track_scores?: boolean
version?: boolean
seq_no_primary_term?: boolean
stored_fields?: <<shared-type-fields, Fields>>
stored_fields?: <<Fields>>
pit?: SearchPointInTimeReference
runtime_mappings?: MappingRuntimeFields
stats?: string[]
@ -121,6 +121,6 @@ interface AsyncSearchSubmitRequest extends <<shared-type-request-base, RequestBa
[source,ts]
----
type AsyncSearchSubmitResponse<TDocument = unknown, TAggregations = Record<<<shared-type-aggregate-name, AggregateName>>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
type AsyncSearchSubmitResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
----

View File

@ -45,8 +45,8 @@ Delete an autoscaling policy. NOTE: This feature is designed for indirect use by
[source,ts]
----
interface AutoscalingDeleteAutoscalingPolicyRequest extends <<shared-type-request-base, RequestBase>> {
name: <<shared-type-name, Name>>
interface AutoscalingDeleteAutoscalingPolicyRequest extends <<RequestBase>> {
name: <<Name>>
}
----
@ -55,6 +55,6 @@ interface AutoscalingDeleteAutoscalingPolicyRequest extends <<shared-type-reques
[source,ts]
----
type AutoscalingDeleteAutoscalingPolicyResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
type AutoscalingDeleteAutoscalingPolicyResponse = <<AcknowledgedResponseBase>>
----

View File

@ -45,7 +45,7 @@ Get the autoscaling capacity. NOTE: This feature is designed for indirect use by
[source,ts]
----
interface AutoscalingGetAutoscalingCapacityRequest extends <<shared-type-request-base, RequestBase>> {
interface AutoscalingGetAutoscalingCapacityRequest extends <<RequestBase>> {
}
----

View File

@ -45,8 +45,8 @@ Get an autoscaling policy. NOTE: This feature is designed for indirect use by El
[source,ts]
----
interface AutoscalingGetAutoscalingPolicyRequest extends <<shared-type-request-base, RequestBase>> {
name: <<shared-type-name, Name>>
interface AutoscalingGetAutoscalingPolicyRequest extends <<RequestBase>> {
name: <<Name>>
}
----

View File

@ -45,8 +45,8 @@ Create or update an autoscaling policy. NOTE: This feature is designed for indir
[source,ts]
----
interface AutoscalingPutAutoscalingPolicyRequest extends <<shared-type-request-base, RequestBase>> {
name: <<shared-type-name, Name>>
interface AutoscalingPutAutoscalingPolicyRequest extends <<RequestBase>> {
name: <<Name>>
policy?: AutoscalingAutoscalingPolicy
}
----
@ -56,6 +56,6 @@ interface AutoscalingPutAutoscalingPolicyRequest extends <<shared-type-request-b
[source,ts]
----
type AutoscalingPutAutoscalingPolicyResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
type AutoscalingPutAutoscalingPolicyResponse = <<AcknowledgedResponseBase>>
----

View File

@ -45,16 +45,16 @@ Bulk index or delete documents. Performs multiple indexing or delete operations
[source,ts]
----
interface BulkRequest<TDocument = unknown, TPartialDocument = unknown> extends <<shared-type-request-base, RequestBase>> {
index?: <<shared-type-index-name, IndexName>>
interface BulkRequest<TDocument = unknown, TPartialDocument = unknown> extends <<RequestBase>> {
index?: <<IndexName>>
pipeline?: string
refresh?: <<shared-type-refresh, Refresh>>
routing?: <<shared-type-routing, Routing>>
refresh?: <<Refresh>>
routing?: <<Routing>>
_source?: SearchSourceConfigParam
_source_excludes?: <<shared-type-fields, Fields>>
_source_includes?: <<shared-type-fields, Fields>>
timeout?: <<shared-type-duration, Duration>>
wait_for_active_shards?: <<shared-type-wait-for-active-shards, WaitForActiveShards>>
_source_excludes?: <<Fields>>
_source_includes?: <<Fields>>
timeout?: <<Duration>>
wait_for_active_shards?: <<WaitForActiveShards>>
require_alias?: boolean
operations?: (BulkOperationContainer | BulkUpdateAction<TDocument, TPartialDocument> | TDocument)[]
}
@ -68,8 +68,8 @@ interface BulkRequest<TDocument = unknown, TPartialDocument = unknown> extends <
interface BulkResponse {
errors: boolean
items: Partial<Record<BulkOperationType, BulkResponseItem>>[]
took: <<shared-type-long, long>>
ingest_took?: <<shared-type-long, long>>
took: <<long>>
ingest_took?: <<long>>
}
----

View File

@ -46,8 +46,8 @@ Get aliases. Retrieves the clusters index aliases, including filter and routi
[source,ts]
----
interface CatAliasesRequest extends CatCatRequestBase {
name?: <<shared-type-names, Names>>
expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
name?: <<Names>>
expand_wildcards?: <<ExpandWildcards>>
}
----

View File

@ -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?: <<shared-type-node-ids, NodeIds>>
bytes?: <<shared-type-bytes, Bytes>>
node_id?: <<NodeIds>>
bytes?: <<Bytes>>
}
----

View File

@ -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?: <<shared-type-indices, Indices>>
index?: <<Indices>>
}
----

View File

@ -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?: <<shared-type-fields, Fields>>
bytes?: <<shared-type-bytes, Bytes>>
fields?: <<Fields>>
bytes?: <<Bytes>>
}
----

View File

@ -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?: <<shared-type-time-unit, TimeUnit>>
time?: <<TimeUnit>>
ts?: boolean
}
----

View File

@ -46,13 +46,13 @@ Get index information. Returns high-level information about indices in a cluster
[source,ts]
----
interface CatIndicesRequest extends CatCatRequestBase {
index?: <<shared-type-indices, Indices>>
bytes?: <<shared-type-bytes, Bytes>>
expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
health?: <<shared-type-health-status, HealthStatus>>
index?: <<Indices>>
bytes?: <<Bytes>>
expand_wildcards?: <<ExpandWildcards>>
health?: <<HealthStatus>>
include_unloaded_segments?: boolean
pri?: boolean
time?: <<shared-type-time-unit, TimeUnit>>
time?: <<TimeUnit>>
}
----

View File

@ -46,12 +46,12 @@ Get data frame analytics jobs. Returns configuration and usage information about
[source,ts]
----
interface CatMlDataFrameAnalyticsRequest extends CatCatRequestBase {
id?: <<shared-type-id, Id>>
id?: <<Id>>
allow_no_match?: boolean
bytes?: <<shared-type-bytes, Bytes>>
bytes?: <<Bytes>>
h?: CatCatDfaColumns
s?: CatCatDfaColumns
time?: <<shared-type-duration, Duration>>
time?: <<Duration>>
}
----

View File

@ -46,11 +46,11 @@ Get datafeeds. Returns configuration and usage information about datafeeds. This
[source,ts]
----
interface CatMlDatafeedsRequest extends CatCatRequestBase {
datafeed_id?: <<shared-type-id, Id>>
datafeed_id?: <<Id>>
allow_no_match?: boolean
h?: CatCatDatafeedColumns
s?: CatCatDatafeedColumns
time?: <<shared-type-time-unit, TimeUnit>>
time?: <<TimeUnit>>
}
----

View File

@ -46,12 +46,12 @@ Get anomaly detection jobs. Returns configuration and usage information for anom
[source,ts]
----
interface CatMlJobsRequest extends CatCatRequestBase {
job_id?: <<shared-type-id, Id>>
job_id?: <<Id>>
allow_no_match?: boolean
bytes?: <<shared-type-bytes, Bytes>>
bytes?: <<Bytes>>
h?: CatCatAnonalyDetectorColumns
s?: CatCatAnonalyDetectorColumns
time?: <<shared-type-time-unit, TimeUnit>>
time?: <<TimeUnit>>
}
----

View File

@ -46,13 +46,13 @@ Get trained models. Returns configuration and usage information about inference
[source,ts]
----
interface CatMlTrainedModelsRequest extends CatCatRequestBase {
model_id?: <<shared-type-id, Id>>
model_id?: <<Id>>
allow_no_match?: boolean
bytes?: <<shared-type-bytes, Bytes>>
bytes?: <<Bytes>>
h?: CatCatTrainedModelsColumns
s?: CatCatTrainedModelsColumns
from?: <<shared-type-integer, integer>>
size?: <<shared-type-integer, integer>>
from?: <<integer>>
size?: <<integer>>
}
----

View File

@ -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?: <<shared-type-bytes, Bytes>>
bytes?: <<Bytes>>
full_id?: boolean | string
include_unloaded_segments?: boolean
}

View File

@ -46,9 +46,9 @@ Returns information about ongoing and completed shard recoveries. Shard recovery
[source,ts]
----
interface CatRecoveryRequest extends CatCatRequestBase {
index?: <<shared-type-indices, Indices>>
index?: <<Indices>>
active_only?: boolean
bytes?: <<shared-type-bytes, Bytes>>
bytes?: <<Bytes>>
detailed?: boolean
}
----

View File

@ -46,8 +46,8 @@ Returns low-level information about the Lucene segments in index shards. For dat
[source,ts]
----
interface CatSegmentsRequest extends CatCatRequestBase {
index?: <<shared-type-indices, Indices>>
bytes?: <<shared-type-bytes, Bytes>>
index?: <<Indices>>
bytes?: <<Bytes>>
}
----

View File

@ -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?: <<shared-type-indices, Indices>>
bytes?: <<shared-type-bytes, Bytes>>
index?: <<Indices>>
bytes?: <<Bytes>>
}
----

View File

@ -46,7 +46,7 @@ Returns information about the snapshots stored in one or more repositories. A sn
[source,ts]
----
interface CatSnapshotsRequest extends CatCatRequestBase {
repository?: <<shared-type-names, Names>>
repository?: <<Names>>
ignore_unavailable?: boolean
}
----

View File

@ -46,7 +46,7 @@ Returns information about index templates in a cluster. You can use index templa
[source,ts]
----
interface CatTemplatesRequest extends CatCatRequestBase {
name?: <<shared-type-name, Name>>
name?: <<Name>>
}
----

View File

@ -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?: <<shared-type-names, Names>>
time?: <<shared-type-time-unit, TimeUnit>>
thread_pool_patterns?: <<Names>>
time?: <<TimeUnit>>
}
----

View File

@ -46,13 +46,13 @@ Get transforms. Returns configuration and usage information about transforms. CA
[source,ts]
----
interface CatTransformsRequest extends CatCatRequestBase {
transform_id?: <<shared-type-id, Id>>
transform_id?: <<Id>>
allow_no_match?: boolean
from?: <<shared-type-integer, integer>>
from?: <<integer>>
h?: CatCatTransformColumns
s?: CatCatTransformColumns
time?: <<shared-type-time-unit, TimeUnit>>
size?: <<shared-type-integer, integer>>
time?: <<TimeUnit>>
size?: <<integer>>
}
----

View File

@ -45,8 +45,8 @@ Deletes auto-follow patterns.
[source,ts]
----
interface CcrDeleteAutoFollowPatternRequest extends <<shared-type-request-base, RequestBase>> {
name: <<shared-type-name, Name>>
interface CcrDeleteAutoFollowPatternRequest extends <<RequestBase>> {
name: <<Name>>
}
----
@ -55,6 +55,6 @@ interface CcrDeleteAutoFollowPatternRequest extends <<shared-type-request-base,
[source,ts]
----
type CcrDeleteAutoFollowPatternResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
type CcrDeleteAutoFollowPatternResponse = <<AcknowledgedResponseBase>>
----

View File

@ -45,20 +45,20 @@ Creates a new follower index configured to follow the referenced leader index.
[source,ts]
----
interface CcrFollowRequest extends <<shared-type-request-base, RequestBase>> {
index: <<shared-type-index-name, IndexName>>
wait_for_active_shards?: <<shared-type-wait-for-active-shards, WaitForActiveShards>>
leader_index?: <<shared-type-index-name, IndexName>>
max_outstanding_read_requests?: <<shared-type-long, long>>
max_outstanding_write_requests?: <<shared-type-long, long>>
max_read_request_operation_count?: <<shared-type-long, long>>
interface CcrFollowRequest extends <<RequestBase>> {
index: <<IndexName>>
wait_for_active_shards?: <<WaitForActiveShards>>
leader_index?: <<IndexName>>
max_outstanding_read_requests?: <<long>>
max_outstanding_write_requests?: <<long>>
max_read_request_operation_count?: <<long>>
max_read_request_size?: string
max_retry_delay?: <<shared-type-duration, Duration>>
max_write_buffer_count?: <<shared-type-long, long>>
max_retry_delay?: <<Duration>>
max_write_buffer_count?: <<long>>
max_write_buffer_size?: string
max_write_request_operation_count?: <<shared-type-long, long>>
max_write_request_operation_count?: <<long>>
max_write_request_size?: string
read_poll_timeout?: <<shared-type-duration, Duration>>
read_poll_timeout?: <<Duration>>
remote_cluster?: string
}
----

View File

@ -45,8 +45,8 @@ Retrieves information about all follower indices, including parameters and statu
[source,ts]
----
interface CcrFollowInfoRequest extends <<shared-type-request-base, RequestBase>> {
index: <<shared-type-indices, Indices>>
interface CcrFollowInfoRequest extends <<RequestBase>> {
index: <<Indices>>
}
----

View File

@ -45,8 +45,8 @@ Retrieves follower stats. return shard-level stats about the following tasks ass
[source,ts]
----
interface CcrFollowStatsRequest extends <<shared-type-request-base, RequestBase>> {
index: <<shared-type-indices, Indices>>
interface CcrFollowStatsRequest extends <<RequestBase>> {
index: <<Indices>>
}
----

View File

@ -45,11 +45,11 @@ Removes the follower retention leases from the leader.
[source,ts]
----
interface CcrForgetFollowerRequest extends <<shared-type-request-base, RequestBase>> {
index: <<shared-type-index-name, IndexName>>
interface CcrForgetFollowerRequest extends <<RequestBase>> {
index: <<IndexName>>
follower_cluster?: string
follower_index?: <<shared-type-index-name, IndexName>>
follower_index_uuid?: <<shared-type-uuid, Uuid>>
follower_index?: <<IndexName>>
follower_index_uuid?: <<Uuid>>
leader_remote_cluster?: string
}
----
@ -60,7 +60,7 @@ interface CcrForgetFollowerRequest extends <<shared-type-request-base, RequestBa
[source,ts]
----
interface CcrForgetFollowerResponse {
_shards: <<shared-type-shard-statistics, ShardStatistics>>
_shards: <<ShardStatistics>>
}
----

View File

@ -45,8 +45,8 @@ Gets configured auto-follow patterns. Returns the specified auto-follow pattern
[source,ts]
----
interface CcrGetAutoFollowPatternRequest extends <<shared-type-request-base, RequestBase>> {
name?: <<shared-type-name, Name>>
interface CcrGetAutoFollowPatternRequest extends <<RequestBase>> {
name?: <<Name>>
}
----

View File

@ -45,8 +45,8 @@ Pauses an auto-follow pattern
[source,ts]
----
interface CcrPauseAutoFollowPatternRequest extends <<shared-type-request-base, RequestBase>> {
name: <<shared-type-name, Name>>
interface CcrPauseAutoFollowPatternRequest extends <<RequestBase>> {
name: <<Name>>
}
----
@ -55,6 +55,6 @@ interface CcrPauseAutoFollowPatternRequest extends <<shared-type-request-base, R
[source,ts]
----
type CcrPauseAutoFollowPatternResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
type CcrPauseAutoFollowPatternResponse = <<AcknowledgedResponseBase>>
----

View File

@ -45,8 +45,8 @@ Pauses a follower index. The follower index will not fetch any additional operat
[source,ts]
----
interface CcrPauseFollowRequest extends <<shared-type-request-base, RequestBase>> {
index: <<shared-type-index-name, IndexName>>
interface CcrPauseFollowRequest extends <<RequestBase>> {
index: <<IndexName>>
}
----
@ -55,6 +55,6 @@ interface CcrPauseFollowRequest extends <<shared-type-request-base, RequestBase>
[source,ts]
----
type CcrPauseFollowResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
type CcrPauseFollowResponse = <<AcknowledgedResponseBase>>
----

View File

@ -45,23 +45,23 @@ Creates a new named collection of auto-follow patterns against a specified remot
[source,ts]
----
interface CcrPutAutoFollowPatternRequest extends <<shared-type-request-base, RequestBase>> {
name: <<shared-type-name, Name>>
interface CcrPutAutoFollowPatternRequest extends <<RequestBase>> {
name: <<Name>>
remote_cluster: string
follow_index_pattern?: <<shared-type-index-pattern, IndexPattern>>
leader_index_patterns?: <<shared-type-index-patterns, IndexPatterns>>
leader_index_exclusion_patterns?: <<shared-type-index-patterns, IndexPatterns>>
max_outstanding_read_requests?: <<shared-type-integer, integer>>
follow_index_pattern?: <<IndexPattern>>
leader_index_patterns?: <<IndexPatterns>>
leader_index_exclusion_patterns?: <<IndexPatterns>>
max_outstanding_read_requests?: <<integer>>
settings?: Record<string, any>
max_outstanding_write_requests?: <<shared-type-integer, integer>>
read_poll_timeout?: <<shared-type-duration, Duration>>
max_read_request_operation_count?: <<shared-type-integer, integer>>
max_read_request_size?: <<shared-type-byte-size, ByteSize>>
max_retry_delay?: <<shared-type-duration, Duration>>
max_write_buffer_count?: <<shared-type-integer, integer>>
max_write_buffer_size?: <<shared-type-byte-size, ByteSize>>
max_write_request_operation_count?: <<shared-type-integer, integer>>
max_write_request_size?: <<shared-type-byte-size, ByteSize>>
max_outstanding_write_requests?: <<integer>>
read_poll_timeout?: <<Duration>>
max_read_request_operation_count?: <<integer>>
max_read_request_size?: <<ByteSize>>
max_retry_delay?: <<Duration>>
max_write_buffer_count?: <<integer>>
max_write_buffer_size?: <<ByteSize>>
max_write_request_operation_count?: <<integer>>
max_write_request_size?: <<ByteSize>>
}
----
@ -70,6 +70,6 @@ interface CcrPutAutoFollowPatternRequest extends <<shared-type-request-base, Req
[source,ts]
----
type CcrPutAutoFollowPatternResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
type CcrPutAutoFollowPatternResponse = <<AcknowledgedResponseBase>>
----

View File

@ -45,8 +45,8 @@ Resumes an auto-follow pattern that has been paused
[source,ts]
----
interface CcrResumeAutoFollowPatternRequest extends <<shared-type-request-base, RequestBase>> {
name: <<shared-type-name, Name>>
interface CcrResumeAutoFollowPatternRequest extends <<RequestBase>> {
name: <<Name>>
}
----
@ -55,6 +55,6 @@ interface CcrResumeAutoFollowPatternRequest extends <<shared-type-request-base,
[source,ts]
----
type CcrResumeAutoFollowPatternResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
type CcrResumeAutoFollowPatternResponse = <<AcknowledgedResponseBase>>
----

View File

@ -45,18 +45,18 @@ Resumes a follower index that has been paused
[source,ts]
----
interface CcrResumeFollowRequest extends <<shared-type-request-base, RequestBase>> {
index: <<shared-type-index-name, IndexName>>
max_outstanding_read_requests?: <<shared-type-long, long>>
max_outstanding_write_requests?: <<shared-type-long, long>>
max_read_request_operation_count?: <<shared-type-long, long>>
interface CcrResumeFollowRequest extends <<RequestBase>> {
index: <<IndexName>>
max_outstanding_read_requests?: <<long>>
max_outstanding_write_requests?: <<long>>
max_read_request_operation_count?: <<long>>
max_read_request_size?: string
max_retry_delay?: <<shared-type-duration, Duration>>
max_write_buffer_count?: <<shared-type-long, long>>
max_retry_delay?: <<Duration>>
max_write_buffer_count?: <<long>>
max_write_buffer_size?: string
max_write_request_operation_count?: <<shared-type-long, long>>
max_write_request_operation_count?: <<long>>
max_write_request_size?: string
read_poll_timeout?: <<shared-type-duration, Duration>>
read_poll_timeout?: <<Duration>>
}
----
@ -65,6 +65,6 @@ interface CcrResumeFollowRequest extends <<shared-type-request-base, RequestBase
[source,ts]
----
type CcrResumeFollowResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
type CcrResumeFollowResponse = <<AcknowledgedResponseBase>>
----

View File

@ -45,7 +45,7 @@ Gets all stats related to cross-cluster replication.
[source,ts]
----
interface CcrStatsRequest extends <<shared-type-request-base, RequestBase>> {
interface CcrStatsRequest extends <<RequestBase>> {
}
----

View File

@ -45,8 +45,8 @@ Stops the following task associated with a follower index and removes index meta
[source,ts]
----
interface CcrUnfollowRequest extends <<shared-type-request-base, RequestBase>> {
index: <<shared-type-index-name, IndexName>>
interface CcrUnfollowRequest extends <<RequestBase>> {
index: <<IndexName>>
}
----
@ -55,6 +55,6 @@ interface CcrUnfollowRequest extends <<shared-type-request-base, RequestBase>> {
[source,ts]
----
type CcrUnfollowResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
type CcrUnfollowResponse = <<AcknowledgedResponseBase>>
----

View File

@ -45,8 +45,8 @@ Clear a scrolling search. Clear the search context and results for a scrolling s
[source,ts]
----
interface ClearScrollRequest extends <<shared-type-request-base, RequestBase>> {
scroll_id?: <<shared-type-scroll-ids, ScrollIds>>
interface ClearScrollRequest extends <<RequestBase>> {
scroll_id?: <<ScrollIds>>
}
----
@ -57,7 +57,7 @@ interface ClearScrollRequest extends <<shared-type-request-base, RequestBase>> {
----
interface ClearScrollResponse {
succeeded: boolean
num_freed: <<shared-type-integer, integer>>
num_freed: <<integer>>
}
----

View File

@ -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 <<shared-type-request-base, RequestBase>> {
id: <<shared-type-id, Id>>
interface ClosePointInTimeRequest extends <<RequestBase>> {
id: <<Id>>
}
----
@ -57,7 +57,7 @@ interface ClosePointInTimeRequest extends <<shared-type-request-base, RequestBas
----
interface ClosePointInTimeResponse {
succeeded: boolean
num_freed: <<shared-type-integer, integer>>
num_freed: <<integer>>
}
----

View File

@ -45,13 +45,13 @@ Provides explanations for shard allocations in the cluster.
[source,ts]
----
interface ClusterAllocationExplainRequest extends <<shared-type-request-base, RequestBase>> {
interface ClusterAllocationExplainRequest extends <<RequestBase>> {
include_disk_info?: boolean
include_yes_decisions?: boolean
current_node?: string
index?: <<shared-type-index-name, IndexName>>
index?: <<IndexName>>
primary?: boolean
shard?: <<shared-type-integer, integer>>
shard?: <<integer>>
}
----
@ -62,8 +62,8 @@ interface ClusterAllocationExplainRequest extends <<shared-type-request-base, Re
----
interface ClusterAllocationExplainResponse {
allocate_explanation?: string
allocation_delay?: <<shared-type-duration, Duration>>
allocation_delay_in_millis?: <<shared-type-duration-value, DurationValue>><<<shared-type-unit-millis, UnitMillis>>>
allocation_delay?: <<Duration>>
allocation_delay_in_millis?: <<DurationValue>><<<UnitMillis>>>
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?: <<shared-type-duration, Duration>>
configured_delay_in_millis?: <<shared-type-duration-value, DurationValue>><<<shared-type-unit-millis, UnitMillis>>>
configured_delay?: <<Duration>>
configured_delay_in_millis?: <<DurationValue>><<<UnitMillis>>>
current_node?: ClusterAllocationExplainCurrentNode
current_state: string
index: <<shared-type-index-name, IndexName>>
index: <<IndexName>>
move_explanation?: string
node_allocation_decisions?: ClusterAllocationExplainNodeAllocationExplanation[]
primary: boolean
rebalance_explanation?: string
remaining_delay?: <<shared-type-duration, Duration>>
remaining_delay_in_millis?: <<shared-type-duration-value, DurationValue>><<<shared-type-unit-millis, UnitMillis>>>
shard: <<shared-type-integer, integer>>
remaining_delay?: <<Duration>>
remaining_delay_in_millis?: <<DurationValue>><<<UnitMillis>>>
shard: <<integer>>
unassigned_info?: ClusterAllocationExplainUnassignedInformation
note?: string
}

View File

@ -45,10 +45,10 @@ Delete component templates. Deletes component templates. Component templates are
[source,ts]
----
interface ClusterDeleteComponentTemplateRequest extends <<shared-type-request-base, RequestBase>> {
name: <<shared-type-names, Names>>
master_timeout?: <<shared-type-duration, Duration>>
timeout?: <<shared-type-duration, Duration>>
interface ClusterDeleteComponentTemplateRequest extends <<RequestBase>> {
name: <<Names>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
@ -57,6 +57,6 @@ interface ClusterDeleteComponentTemplateRequest extends <<shared-type-request-ba
[source,ts]
----
type ClusterDeleteComponentTemplateResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
type ClusterDeleteComponentTemplateResponse = <<AcknowledgedResponseBase>>
----

View File

@ -45,7 +45,7 @@ Clears cluster voting config exclusions.
[source,ts]
----
interface ClusterDeleteVotingConfigExclusionsRequest extends <<shared-type-request-base, RequestBase>> {
interface ClusterDeleteVotingConfigExclusionsRequest extends <<RequestBase>> {
wait_for_removal?: boolean
}
----

View File

@ -45,9 +45,9 @@ Check component templates. Returns information about whether a particular compon
[source,ts]
----
interface ClusterExistsComponentTemplateRequest extends <<shared-type-request-base, RequestBase>> {
name: <<shared-type-names, Names>>
master_timeout?: <<shared-type-duration, Duration>>
interface ClusterExistsComponentTemplateRequest extends <<RequestBase>> {
name: <<Names>>
master_timeout?: <<Duration>>
local?: boolean
}
----

View File

@ -45,12 +45,12 @@ Get component templates. Retrieves information about component templates.
[source,ts]
----
interface ClusterGetComponentTemplateRequest extends <<shared-type-request-base, RequestBase>> {
name?: <<shared-type-name, Name>>
interface ClusterGetComponentTemplateRequest extends <<RequestBase>> {
name?: <<Name>>
flat_settings?: boolean
include_defaults?: boolean
local?: boolean
master_timeout?: <<shared-type-duration, Duration>>
master_timeout?: <<Duration>>
}
----

View File

@ -45,11 +45,11 @@ Returns cluster-wide settings. By default, it returns only settings that have be
[source,ts]
----
interface ClusterGetSettingsRequest extends <<shared-type-request-base, RequestBase>> {
interface ClusterGetSettingsRequest extends <<RequestBase>> {
flat_settings?: boolean
include_defaults?: boolean
master_timeout?: <<shared-type-duration, Duration>>
timeout?: <<shared-type-duration, Duration>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----

View File

@ -45,19 +45,19 @@ The cluster health API returns a simple status on the health of the cluster. You
[source,ts]
----
interface ClusterHealthRequest extends <<shared-type-request-base, RequestBase>> {
index?: <<shared-type-indices, Indices>>
expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
level?: <<shared-type-level, Level>>
interface ClusterHealthRequest extends <<RequestBase>> {
index?: <<Indices>>
expand_wildcards?: <<ExpandWildcards>>
level?: <<Level>>
local?: boolean
master_timeout?: <<shared-type-duration, Duration>>
timeout?: <<shared-type-duration, Duration>>
wait_for_active_shards?: <<shared-type-wait-for-active-shards, WaitForActiveShards>>
wait_for_events?: <<shared-type-wait-for-events, WaitForEvents>>
wait_for_nodes?: string | <<shared-type-integer, integer>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
wait_for_active_shards?: <<WaitForActiveShards>>
wait_for_events?: <<WaitForEvents>>
wait_for_nodes?: string | <<integer>>
wait_for_no_initializing_shards?: boolean
wait_for_no_relocating_shards?: boolean
wait_for_status?: <<shared-type-health-status, HealthStatus>>
wait_for_status?: <<HealthStatus>>
}
----

View File

@ -45,8 +45,8 @@ Get cluster info. Returns basic information about the cluster.
[source,ts]
----
interface ClusterInfoRequest extends <<shared-type-request-base, RequestBase>> {
target: <<shared-type-cluster-info-targets, ClusterInfoTargets>>
interface ClusterInfoRequest extends <<RequestBase>> {
target: <<ClusterInfoTargets>>
}
----
@ -56,7 +56,7 @@ interface ClusterInfoRequest extends <<shared-type-request-base, RequestBase>> {
[source,ts]
----
interface ClusterInfoResponse {
cluster_name: <<shared-type-name, Name>>
cluster_name: <<Name>>
http?: NodesHttp
ingest?: NodesIngest
thread_pool?: Record<string, NodesThreadCount>

View File

@ -45,9 +45,9 @@ Returns cluster-level changes (such as create index, update mapping, allocate or
[source,ts]
----
interface ClusterPendingTasksRequest extends <<shared-type-request-base, RequestBase>> {
interface ClusterPendingTasksRequest extends <<RequestBase>> {
local?: boolean
master_timeout?: <<shared-type-duration, Duration>>
master_timeout?: <<Duration>>
}
----

View File

@ -45,10 +45,10 @@ Updates the cluster voting config exclusions by node ids or node names.
[source,ts]
----
interface ClusterPostVotingConfigExclusionsRequest extends <<shared-type-request-base, RequestBase>> {
node_names?: <<shared-type-names, Names>>
node_ids?: <<shared-type-ids, Ids>>
timeout?: <<shared-type-duration, Duration>>
interface ClusterPostVotingConfigExclusionsRequest extends <<RequestBase>> {
node_names?: <<Names>>
node_ids?: <<Ids>>
timeout?: <<Duration>>
}
----

View File

@ -45,13 +45,13 @@ Create or update a component template. Creates or updates a component template.
[source,ts]
----
interface ClusterPutComponentTemplateRequest extends <<shared-type-request-base, RequestBase>> {
name: <<shared-type-name, Name>>
interface ClusterPutComponentTemplateRequest extends <<RequestBase>> {
name: <<Name>>
create?: boolean
master_timeout?: <<shared-type-duration, Duration>>
master_timeout?: <<Duration>>
template: IndicesIndexState
version?: <<shared-type-version-number, VersionNumber>>
_meta?: <<shared-type-metadata, Metadata>>
version?: <<VersionNumber>>
_meta?: <<Metadata>>
deprecated?: boolean
}
----
@ -61,6 +61,6 @@ interface ClusterPutComponentTemplateRequest extends <<shared-type-request-base,
[source,ts]
----
type ClusterPutComponentTemplateResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
type ClusterPutComponentTemplateResponse = <<AcknowledgedResponseBase>>
----

View File

@ -45,10 +45,10 @@ Updates the cluster settings.
[source,ts]
----
interface ClusterPutSettingsRequest extends <<shared-type-request-base, RequestBase>> {
interface ClusterPutSettingsRequest extends <<RequestBase>> {
flat_settings?: boolean
master_timeout?: <<shared-type-duration, Duration>>
timeout?: <<shared-type-duration, Duration>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
persistent?: Record<string, any>
transient?: Record<string, any>
}

View File

@ -45,7 +45,7 @@ The cluster remote info API allows you to retrieve all of the configured remote
[source,ts]
----
interface ClusterRemoteInfoRequest extends <<shared-type-request-base, RequestBase>> {
interface ClusterRemoteInfoRequest extends <<RequestBase>> {
}
----

View File

@ -45,13 +45,13 @@ Allows to manually change the allocation of individual shards in the cluster.
[source,ts]
----
interface ClusterRerouteRequest extends <<shared-type-request-base, RequestBase>> {
interface ClusterRerouteRequest extends <<RequestBase>> {
dry_run?: boolean
explain?: boolean
metric?: <<shared-type-metrics, Metrics>>
metric?: <<Metrics>>
retry_failed?: boolean
master_timeout?: <<shared-type-duration, Duration>>
timeout?: <<shared-type-duration, Duration>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
commands?: ClusterRerouteCommand[]
}
----

View File

@ -45,17 +45,17 @@ Returns a comprehensive information about the state of the cluster.
[source,ts]
----
interface ClusterStateRequest extends <<shared-type-request-base, RequestBase>> {
metric?: <<shared-type-metrics, Metrics>>
index?: <<shared-type-indices, Indices>>
interface ClusterStateRequest extends <<RequestBase>> {
metric?: <<Metrics>>
index?: <<Indices>>
allow_no_indices?: boolean
expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
expand_wildcards?: <<ExpandWildcards>>
flat_settings?: boolean
ignore_unavailable?: boolean
local?: boolean
master_timeout?: <<shared-type-duration, Duration>>
wait_for_metadata_version?: <<shared-type-version-number, VersionNumber>>
wait_for_timeout?: <<shared-type-duration, Duration>>
master_timeout?: <<Duration>>
wait_for_metadata_version?: <<VersionNumber>>
wait_for_timeout?: <<Duration>>
}
----

View File

@ -45,10 +45,10 @@ Returns cluster statistics. It returns basic index metrics (shard numbers, store
[source,ts]
----
interface ClusterStatsRequest extends <<shared-type-request-base, RequestBase>> {
node_id?: <<shared-type-node-ids, NodeIds>>
interface ClusterStatsRequest extends <<RequestBase>> {
node_id?: <<NodeIds>>
include_remotes?: boolean
timeout?: <<shared-type-duration, Duration>>
timeout?: <<Duration>>
}
----

View File

@ -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 <<shared-type-request-base, RequestBase>> {
connector_id: <<shared-type-id, Id>>
interface ConnectorCheckInRequest extends <<RequestBase>> {
connector_id: <<Id>>
}
----
@ -56,7 +56,7 @@ interface ConnectorCheckInRequest extends <<shared-type-request-base, RequestBas
[source,ts]
----
interface ConnectorCheckInResponse {
result: <<shared-type-result, Result>>
result: <<Result>>
}
----

View File

@ -45,8 +45,8 @@ Delete a connector. Removes a connector and associated sync jobs. This is a dest
[source,ts]
----
interface ConnectorDeleteRequest extends <<shared-type-request-base, RequestBase>> {
connector_id: <<shared-type-id, Id>>
interface ConnectorDeleteRequest extends <<RequestBase>> {
connector_id: <<Id>>
delete_sync_jobs?: boolean
}
----
@ -56,6 +56,6 @@ interface ConnectorDeleteRequest extends <<shared-type-request-base, RequestBase
[source,ts]
----
type ConnectorDeleteResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
type ConnectorDeleteResponse = <<AcknowledgedResponseBase>>
----

View File

@ -45,8 +45,8 @@ Get a connector. Get the details about a connector.
[source,ts]
----
interface ConnectorGetRequest extends <<shared-type-request-base, RequestBase>> {
connector_id: <<shared-type-id, Id>>
interface ConnectorGetRequest extends <<RequestBase>> {
connector_id: <<Id>>
}
----

View File

@ -45,12 +45,12 @@ Get all connectors. Get information about all connectors.
[source,ts]
----
interface ConnectorListRequest extends <<shared-type-request-base, RequestBase>> {
from?: <<shared-type-integer, integer>>
size?: <<shared-type-integer, integer>>
index_name?: <<shared-type-indices, Indices>>
connector_name?: <<shared-type-names, Names>>
service_type?: <<shared-type-names, Names>>
interface ConnectorListRequest extends <<RequestBase>> {
from?: <<integer>>
size?: <<integer>>
index_name?: <<Indices>>
connector_name?: <<Names>>
service_type?: <<Names>>
query?: string
}
----
@ -61,7 +61,7 @@ interface ConnectorListRequest extends <<shared-type-request-base, RequestBase>>
[source,ts]
----
interface ConnectorListResponse {
count: <<shared-type-long, long>>
count: <<long>>
results: ConnectorConnector[]
}
----

View File

@ -45,9 +45,9 @@ Create a connector. Connectors are Elasticsearch integrations that bring content
[source,ts]
----
interface ConnectorPostRequest extends <<shared-type-request-base, RequestBase>> {
interface ConnectorPostRequest extends <<RequestBase>> {
description?: string
index_name?: <<shared-type-index-name, IndexName>>
index_name?: <<IndexName>>
is_native?: boolean
language?: string
name?: string
@ -61,8 +61,8 @@ interface ConnectorPostRequest extends <<shared-type-request-base, RequestBase>>
[source,ts]
----
interface ConnectorPostResponse {
result: <<shared-type-result, Result>>
id: <<shared-type-id, Id>>
result: <<Result>>
id: <<Id>>
}
----

View File

@ -45,10 +45,10 @@ Create or update a connector.
[source,ts]
----
interface ConnectorPutRequest extends <<shared-type-request-base, RequestBase>> {
connector_id?: <<shared-type-id, Id>>
interface ConnectorPutRequest extends <<RequestBase>> {
connector_id?: <<Id>>
description?: string
index_name?: <<shared-type-index-name, IndexName>>
index_name?: <<IndexName>>
is_native?: boolean
language?: string
name?: string
@ -62,8 +62,8 @@ interface ConnectorPutRequest extends <<shared-type-request-base, RequestBase>>
[source,ts]
----
interface ConnectorPutResponse {
result: <<shared-type-result, Result>>
id: <<shared-type-id, Id>>
result: <<Result>>
id: <<Id>>
}
----

View File

@ -45,8 +45,8 @@ Cancel a connector sync job. Cancel a connector sync job, which sets the status
[source,ts]
----
interface ConnectorSyncJobCancelRequest extends <<shared-type-request-base, RequestBase>> {
connector_sync_job_id: <<shared-type-id, Id>>
interface ConnectorSyncJobCancelRequest extends <<RequestBase>> {
connector_sync_job_id: <<Id>>
}
----
@ -56,7 +56,7 @@ interface ConnectorSyncJobCancelRequest extends <<shared-type-request-base, Requ
[source,ts]
----
interface ConnectorSyncJobCancelResponse {
result: <<shared-type-result, Result>>
result: <<Result>>
}
----

View File

@ -45,8 +45,8 @@ Delete a connector sync job. Remove a connector sync job and its associated data
[source,ts]
----
interface ConnectorSyncJobDeleteRequest extends <<shared-type-request-base, RequestBase>> {
connector_sync_job_id: <<shared-type-id, Id>>
interface ConnectorSyncJobDeleteRequest extends <<RequestBase>> {
connector_sync_job_id: <<Id>>
}
----
@ -55,6 +55,6 @@ interface ConnectorSyncJobDeleteRequest extends <<shared-type-request-base, Requ
[source,ts]
----
type ConnectorSyncJobDeleteResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
type ConnectorSyncJobDeleteResponse = <<AcknowledgedResponseBase>>
----

View File

@ -45,8 +45,8 @@ Get a connector sync job.
[source,ts]
----
interface ConnectorSyncJobGetRequest extends <<shared-type-request-base, RequestBase>> {
connector_sync_job_id: <<shared-type-id, Id>>
interface ConnectorSyncJobGetRequest extends <<RequestBase>> {
connector_sync_job_id: <<Id>>
}
----

View File

@ -45,11 +45,11 @@ Get all connector sync jobs. Get information about all stored connector sync job
[source,ts]
----
interface ConnectorSyncJobListRequest extends <<shared-type-request-base, RequestBase>> {
from?: <<shared-type-integer, integer>>
size?: <<shared-type-integer, integer>>
interface ConnectorSyncJobListRequest extends <<RequestBase>> {
from?: <<integer>>
size?: <<integer>>
status?: ConnectorSyncStatus
connector_id?: <<shared-type-id, Id>>
connector_id?: <<Id>>
job_type?: ConnectorSyncJobType | ConnectorSyncJobType[]
}
----
@ -60,7 +60,7 @@ interface ConnectorSyncJobListRequest extends <<shared-type-request-base, Reques
[source,ts]
----
interface ConnectorSyncJobListResponse {
count: <<shared-type-long, long>>
count: <<long>>
results: ConnectorConnectorSyncJob[]
}
----

View File

@ -45,8 +45,8 @@ Create a connector sync job. Create a connector sync job document in the interna
[source,ts]
----
interface ConnectorSyncJobPostRequest extends <<shared-type-request-base, RequestBase>> {
id: <<shared-type-id, Id>>
interface ConnectorSyncJobPostRequest extends <<RequestBase>> {
id: <<Id>>
job_type?: ConnectorSyncJobType
trigger_method?: ConnectorSyncJobTriggerMethod
}
@ -58,7 +58,7 @@ interface ConnectorSyncJobPostRequest extends <<shared-type-request-base, Reques
[source,ts]
----
interface ConnectorSyncJobPostResponse {
id: <<shared-type-id, Id>>
id: <<Id>>
}
----

View File

@ -45,8 +45,8 @@ Activate the connector draft filter. Activates the valid draft filtering for a c
[source,ts]
----
interface ConnectorUpdateActiveFilteringRequest extends <<shared-type-request-base, RequestBase>> {
connector_id: <<shared-type-id, Id>>
interface ConnectorUpdateActiveFilteringRequest extends <<RequestBase>> {
connector_id: <<Id>>
}
----
@ -56,7 +56,7 @@ interface ConnectorUpdateActiveFilteringRequest extends <<shared-type-request-ba
[source,ts]
----
interface ConnectorUpdateActiveFilteringResponse {
result: <<shared-type-result, Result>>
result: <<Result>>
}
----

View File

@ -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 <<shared-type-request-base, RequestBase>> {
connector_id: <<shared-type-id, Id>>
interface ConnectorUpdateApiKeyIdRequest extends <<RequestBase>> {
connector_id: <<Id>>
api_key_id?: string
api_key_secret_id?: string
}
@ -58,7 +58,7 @@ interface ConnectorUpdateApiKeyIdRequest extends <<shared-type-request-base, Req
[source,ts]
----
interface ConnectorUpdateApiKeyIdResponse {
result: <<shared-type-result, Result>>
result: <<Result>>
}
----

View File

@ -45,8 +45,8 @@ Update the connector configuration. Update the configuration field in the connec
[source,ts]
----
interface ConnectorUpdateConfigurationRequest extends <<shared-type-request-base, RequestBase>> {
connector_id: <<shared-type-id, Id>>
interface ConnectorUpdateConfigurationRequest extends <<RequestBase>> {
connector_id: <<Id>>
configuration?: ConnectorConnectorConfiguration
values?: Record<string, any>
}
@ -58,7 +58,7 @@ interface ConnectorUpdateConfigurationRequest extends <<shared-type-request-base
[source,ts]
----
interface ConnectorUpdateConfigurationResponse {
result: <<shared-type-result, Result>>
result: <<Result>>
}
----

View File

@ -45,8 +45,8 @@ Update the connector error field. Set the error field for the connector. If the
[source,ts]
----
interface ConnectorUpdateErrorRequest extends <<shared-type-request-base, RequestBase>> {
connector_id: <<shared-type-id, Id>>
interface ConnectorUpdateErrorRequest extends <<RequestBase>> {
connector_id: <<Id>>
error: SpecUtilsWithNullValue<string>
}
----
@ -57,7 +57,7 @@ interface ConnectorUpdateErrorRequest extends <<shared-type-request-base, Reques
[source,ts]
----
interface ConnectorUpdateErrorResponse {
result: <<shared-type-result, Result>>
result: <<Result>>
}
----

View File

@ -45,8 +45,8 @@ Update the connector filtering. Update the draft filtering configuration of a co
[source,ts]
----
interface ConnectorUpdateFilteringRequest extends <<shared-type-request-base, RequestBase>> {
connector_id: <<shared-type-id, Id>>
interface ConnectorUpdateFilteringRequest extends <<RequestBase>> {
connector_id: <<Id>>
filtering?: ConnectorFilteringConfig[]
rules?: ConnectorFilteringRule[]
advanced_snippet?: ConnectorFilteringAdvancedSnippet
@ -59,7 +59,7 @@ interface ConnectorUpdateFilteringRequest extends <<shared-type-request-base, Re
[source,ts]
----
interface ConnectorUpdateFilteringResponse {
result: <<shared-type-result, Result>>
result: <<Result>>
}
----

View File

@ -43,8 +43,8 @@ Update the connector draft filtering validation. Update the draft filtering vali
[source,ts]
----
interface ConnectorUpdateFilteringValidationRequest extends <<shared-type-request-base, RequestBase>> {
connector_id: <<shared-type-id, Id>>
interface ConnectorUpdateFilteringValidationRequest extends <<RequestBase>> {
connector_id: <<Id>>
validation: ConnectorFilteringRulesValidation
}
----
@ -55,7 +55,7 @@ interface ConnectorUpdateFilteringValidationRequest extends <<shared-type-reques
[source,ts]
----
interface ConnectorUpdateFilteringValidationResponse {
result: <<shared-type-result, Result>>
result: <<Result>>
}
----

View File

@ -45,9 +45,9 @@ Update the connector index name. Update the `index_name` field of a connector, s
[source,ts]
----
interface ConnectorUpdateIndexNameRequest extends <<shared-type-request-base, RequestBase>> {
connector_id: <<shared-type-id, Id>>
index_name: SpecUtilsWithNullValue<<<shared-type-index-name, IndexName>>>
interface ConnectorUpdateIndexNameRequest extends <<RequestBase>> {
connector_id: <<Id>>
index_name: SpecUtilsWithNullValue<<<IndexName>>>
}
----
@ -57,7 +57,7 @@ interface ConnectorUpdateIndexNameRequest extends <<shared-type-request-base, Re
[source,ts]
----
interface ConnectorUpdateIndexNameResponse {
result: <<shared-type-result, Result>>
result: <<Result>>
}
----

View File

@ -45,8 +45,8 @@ Update the connector name and description.
[source,ts]
----
interface ConnectorUpdateNameRequest extends <<shared-type-request-base, RequestBase>> {
connector_id: <<shared-type-id, Id>>
interface ConnectorUpdateNameRequest extends <<RequestBase>> {
connector_id: <<Id>>
name?: string
description?: string
}
@ -58,7 +58,7 @@ interface ConnectorUpdateNameRequest extends <<shared-type-request-base, Request
[source,ts]
----
interface ConnectorUpdateNameResponse {
result: <<shared-type-result, Result>>
result: <<Result>>
}
----

View File

@ -43,8 +43,8 @@ Update the connector is_native flag.
[source,ts]
----
interface ConnectorUpdateNativeRequest extends <<shared-type-request-base, RequestBase>> {
connector_id: <<shared-type-id, Id>>
interface ConnectorUpdateNativeRequest extends <<RequestBase>> {
connector_id: <<Id>>
is_native: boolean
}
----
@ -55,7 +55,7 @@ interface ConnectorUpdateNativeRequest extends <<shared-type-request-base, Reque
[source,ts]
----
interface ConnectorUpdateNativeResponse {
result: <<shared-type-result, Result>>
result: <<Result>>
}
----

View File

@ -45,8 +45,8 @@ Update the connector pipeline. When you create a new connector, the configuratio
[source,ts]
----
interface ConnectorUpdatePipelineRequest extends <<shared-type-request-base, RequestBase>> {
connector_id: <<shared-type-id, Id>>
interface ConnectorUpdatePipelineRequest extends <<RequestBase>> {
connector_id: <<Id>>
pipeline: ConnectorIngestPipelineParams
}
----
@ -57,7 +57,7 @@ interface ConnectorUpdatePipelineRequest extends <<shared-type-request-base, Req
[source,ts]
----
interface ConnectorUpdatePipelineResponse {
result: <<shared-type-result, Result>>
result: <<Result>>
}
----

View File

@ -45,8 +45,8 @@ Update the connector scheduling.
[source,ts]
----
interface ConnectorUpdateSchedulingRequest extends <<shared-type-request-base, RequestBase>> {
connector_id: <<shared-type-id, Id>>
interface ConnectorUpdateSchedulingRequest extends <<RequestBase>> {
connector_id: <<Id>>
scheduling: ConnectorSchedulingConfiguration
}
----
@ -57,7 +57,7 @@ interface ConnectorUpdateSchedulingRequest extends <<shared-type-request-base, R
[source,ts]
----
interface ConnectorUpdateSchedulingResponse {
result: <<shared-type-result, Result>>
result: <<Result>>
}
----

View File

@ -45,8 +45,8 @@ Update the connector service type.
[source,ts]
----
interface ConnectorUpdateServiceTypeRequest extends <<shared-type-request-base, RequestBase>> {
connector_id: <<shared-type-id, Id>>
interface ConnectorUpdateServiceTypeRequest extends <<RequestBase>> {
connector_id: <<Id>>
service_type: string
}
----
@ -57,7 +57,7 @@ interface ConnectorUpdateServiceTypeRequest extends <<shared-type-request-base,
[source,ts]
----
interface ConnectorUpdateServiceTypeResponse {
result: <<shared-type-result, Result>>
result: <<Result>>
}
----

View File

@ -45,8 +45,8 @@ Update the connector status.
[source,ts]
----
interface ConnectorUpdateStatusRequest extends <<shared-type-request-base, RequestBase>> {
connector_id: <<shared-type-id, Id>>
interface ConnectorUpdateStatusRequest extends <<RequestBase>> {
connector_id: <<Id>>
status: ConnectorConnectorStatus
}
----
@ -57,7 +57,7 @@ interface ConnectorUpdateStatusRequest extends <<shared-type-request-base, Reque
[source,ts]
----
interface ConnectorUpdateStatusResponse {
result: <<shared-type-result, Result>>
result: <<Result>>
}
----

View File

@ -45,21 +45,21 @@ Returns number of documents matching a query.
[source,ts]
----
interface CountRequest extends <<shared-type-request-base, RequestBase>> {
index?: <<shared-type-indices, Indices>>
interface CountRequest extends <<RequestBase>> {
index?: <<Indices>>
allow_no_indices?: boolean
analyzer?: string
analyze_wildcard?: boolean
default_operator?: QueryDslOperator
df?: string
expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
expand_wildcards?: <<ExpandWildcards>>
ignore_throttled?: boolean
ignore_unavailable?: boolean
lenient?: boolean
min_score?: <<shared-type-double, double>>
min_score?: <<double>>
preference?: string
routing?: <<shared-type-routing, Routing>>
terminate_after?: <<shared-type-long, long>>
routing?: <<Routing>>
terminate_after?: <<long>>
q?: string
query?: QueryDslQueryContainer
}
@ -71,8 +71,8 @@ interface CountRequest extends <<shared-type-request-base, RequestBase>> {
[source,ts]
----
interface CountResponse {
count: <<shared-type-long, long>>
_shards: <<shared-type-shard-statistics, ShardStatistics>>
count: <<long>>
_shards: <<ShardStatistics>>
}
----

View File

@ -45,16 +45,16 @@ Index a document. Adds a JSON document to the specified data stream or index and
[source,ts]
----
interface CreateRequest<TDocument = unknown> extends <<shared-type-request-base, RequestBase>> {
id: <<shared-type-id, Id>>
index: <<shared-type-index-name, IndexName>>
interface CreateRequest<TDocument = unknown> extends <<RequestBase>> {
id: <<Id>>
index: <<IndexName>>
pipeline?: string
refresh?: <<shared-type-refresh, Refresh>>
routing?: <<shared-type-routing, Routing>>
timeout?: <<shared-type-duration, Duration>>
version?: <<shared-type-version-number, VersionNumber>>
version_type?: <<shared-type-version-type, VersionType>>
wait_for_active_shards?: <<shared-type-wait-for-active-shards, WaitForActiveShards>>
refresh?: <<Refresh>>
routing?: <<Routing>>
timeout?: <<Duration>>
version?: <<VersionNumber>>
version_type?: <<VersionType>>
wait_for_active_shards?: <<WaitForActiveShards>>
document?: TDocument
}
----
@ -64,6 +64,6 @@ interface CreateRequest<TDocument = unknown> extends <<shared-type-request-base,
[source,ts]
----
type CreateResponse = <<shared-type-write-response-base, WriteResponseBase>>
type CreateResponse = <<WriteResponseBase>>
----

View File

@ -45,11 +45,11 @@ Delete a dangling index. If Elasticsearch encounters index data that is absent f
[source,ts]
----
interface DanglingIndicesDeleteDanglingIndexRequest extends <<shared-type-request-base, RequestBase>> {
index_uuid: <<shared-type-uuid, Uuid>>
interface DanglingIndicesDeleteDanglingIndexRequest extends <<RequestBase>> {
index_uuid: <<Uuid>>
accept_data_loss: boolean
master_timeout?: <<shared-type-duration, Duration>>
timeout?: <<shared-type-duration, Duration>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
@ -58,6 +58,6 @@ interface DanglingIndicesDeleteDanglingIndexRequest extends <<shared-type-reques
[source,ts]
----
type DanglingIndicesDeleteDanglingIndexResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
type DanglingIndicesDeleteDanglingIndexResponse = <<AcknowledgedResponseBase>>
----

View File

@ -45,11 +45,11 @@ Import a dangling index. If Elasticsearch encounters index data that is absent f
[source,ts]
----
interface DanglingIndicesImportDanglingIndexRequest extends <<shared-type-request-base, RequestBase>> {
index_uuid: <<shared-type-uuid, Uuid>>
interface DanglingIndicesImportDanglingIndexRequest extends <<RequestBase>> {
index_uuid: <<Uuid>>
accept_data_loss: boolean
master_timeout?: <<shared-type-duration, Duration>>
timeout?: <<shared-type-duration, Duration>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
@ -58,6 +58,6 @@ interface DanglingIndicesImportDanglingIndexRequest extends <<shared-type-reques
[source,ts]
----
type DanglingIndicesImportDanglingIndexResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
type DanglingIndicesImportDanglingIndexResponse = <<AcknowledgedResponseBase>>
----

View File

@ -45,7 +45,7 @@ Get the dangling indices. If Elasticsearch encounters index data that is absent
[source,ts]
----
interface DanglingIndicesListDanglingIndicesRequest extends <<shared-type-request-base, RequestBase>> {
interface DanglingIndicesListDanglingIndicesRequest extends <<RequestBase>> {
}
----

View File

@ -45,17 +45,17 @@ Delete a document. Removes a JSON document from the specified index.
[source,ts]
----
interface DeleteRequest extends <<shared-type-request-base, RequestBase>> {
id: <<shared-type-id, Id>>
index: <<shared-type-index-name, IndexName>>
if_primary_term?: <<shared-type-long, long>>
if_seq_no?: <<shared-type-sequence-number, SequenceNumber>>
refresh?: <<shared-type-refresh, Refresh>>
routing?: <<shared-type-routing, Routing>>
timeout?: <<shared-type-duration, Duration>>
version?: <<shared-type-version-number, VersionNumber>>
version_type?: <<shared-type-version-type, VersionType>>
wait_for_active_shards?: <<shared-type-wait-for-active-shards, WaitForActiveShards>>
interface DeleteRequest extends <<RequestBase>> {
id: <<Id>>
index: <<IndexName>>
if_primary_term?: <<long>>
if_seq_no?: <<SequenceNumber>>
refresh?: <<Refresh>>
routing?: <<Routing>>
timeout?: <<Duration>>
version?: <<VersionNumber>>
version_type?: <<VersionType>>
wait_for_active_shards?: <<WaitForActiveShards>>
}
----
@ -64,6 +64,6 @@ interface DeleteRequest extends <<shared-type-request-base, RequestBase>> {
[source,ts]
----
type DeleteResponse = <<shared-type-write-response-base, WriteResponseBase>>
type DeleteResponse = <<WriteResponseBase>>
----

View File

@ -45,39 +45,39 @@ Delete documents. Deletes documents that match the specified query.
[source,ts]
----
interface DeleteByQueryRequest extends <<shared-type-request-base, RequestBase>> {
index: <<shared-type-indices, Indices>>
interface DeleteByQueryRequest extends <<RequestBase>> {
index: <<Indices>>
allow_no_indices?: boolean
analyzer?: string
analyze_wildcard?: boolean
conflicts?: <<shared-type-conflicts, Conflicts>>
conflicts?: <<Conflicts>>
default_operator?: QueryDslOperator
df?: string
expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
from?: <<shared-type-long, long>>
expand_wildcards?: <<ExpandWildcards>>
from?: <<long>>
ignore_unavailable?: boolean
lenient?: boolean
preference?: string
refresh?: boolean
request_cache?: boolean
requests_per_second?: <<shared-type-float, float>>
routing?: <<shared-type-routing, Routing>>
requests_per_second?: <<float>>
routing?: <<Routing>>
q?: string
scroll?: <<shared-type-duration, Duration>>
scroll_size?: <<shared-type-long, long>>
search_timeout?: <<shared-type-duration, Duration>>
search_type?: <<shared-type-search-type, SearchType>>
slices?: <<shared-type-slices, Slices>>
scroll?: <<Duration>>
scroll_size?: <<long>>
search_timeout?: <<Duration>>
search_type?: <<SearchType>>
slices?: <<Slices>>
sort?: string[]
stats?: string[]
terminate_after?: <<shared-type-long, long>>
timeout?: <<shared-type-duration, Duration>>
terminate_after?: <<long>>
timeout?: <<Duration>>
version?: boolean
wait_for_active_shards?: <<shared-type-wait-for-active-shards, WaitForActiveShards>>
wait_for_active_shards?: <<WaitForActiveShards>>
wait_for_completion?: boolean
max_docs?: <<shared-type-long, long>>
max_docs?: <<long>>
query?: QueryDslQueryContainer
slice?: <<shared-type-sliced-scroll, SlicedScroll>>
slice?: <<SlicedScroll>>
}
----
@ -87,22 +87,22 @@ interface DeleteByQueryRequest extends <<shared-type-request-base, RequestBase>>
[source,ts]
----
interface DeleteByQueryResponse {
batches?: <<shared-type-long, long>>
deleted?: <<shared-type-long, long>>
failures?: <<shared-type-bulk-index-by-scroll-failure, BulkIndexByScrollFailure>>[]
noops?: <<shared-type-long, long>>
requests_per_second?: <<shared-type-float, float>>
retries?: <<shared-type-retries, Retries>>
slice_id?: <<shared-type-integer, integer>>
task?: <<shared-type-task-id, TaskId>>
throttled?: <<shared-type-duration, Duration>>
throttled_millis?: <<shared-type-duration-value, DurationValue>><<<shared-type-unit-millis, UnitMillis>>>
throttled_until?: <<shared-type-duration, Duration>>
throttled_until_millis?: <<shared-type-duration-value, DurationValue>><<<shared-type-unit-millis, UnitMillis>>>
batches?: <<long>>
deleted?: <<long>>
failures?: <<BulkIndexByScrollFailure>>[]
noops?: <<long>>
requests_per_second?: <<float>>
retries?: <<Retries>>
slice_id?: <<integer>>
task?: <<TaskId>>
throttled?: <<Duration>>
throttled_millis?: <<DurationValue>><<<UnitMillis>>>
throttled_until?: <<Duration>>
throttled_until_millis?: <<DurationValue>><<<UnitMillis>>>
timed_out?: boolean
took?: <<shared-type-duration-value, DurationValue>><<<shared-type-unit-millis, UnitMillis>>>
total?: <<shared-type-long, long>>
version_conflicts?: <<shared-type-long, long>>
took?: <<DurationValue>><<<UnitMillis>>>
total?: <<long>>
version_conflicts?: <<long>>
}
----

View File

@ -45,9 +45,9 @@ Throttle a delete by query operation. Change the number of requests per second f
[source,ts]
----
interface DeleteByQueryRethrottleRequest extends <<shared-type-request-base, RequestBase>> {
task_id: <<shared-type-task-id, TaskId>>
requests_per_second?: <<shared-type-float, float>>
interface DeleteByQueryRethrottleRequest extends <<RequestBase>> {
task_id: <<TaskId>>
requests_per_second?: <<float>>
}
----

View File

@ -45,10 +45,10 @@ Delete a script or search template. Deletes a stored script or search template.
[source,ts]
----
interface DeleteScriptRequest extends <<shared-type-request-base, RequestBase>> {
id: <<shared-type-id, Id>>
master_timeout?: <<shared-type-duration, Duration>>
timeout?: <<shared-type-duration, Duration>>
interface DeleteScriptRequest extends <<RequestBase>> {
id: <<Id>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
@ -57,6 +57,6 @@ interface DeleteScriptRequest extends <<shared-type-request-base, RequestBase>>
[source,ts]
----
type DeleteScriptResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
type DeleteScriptResponse = <<AcknowledgedResponseBase>>
----

View File

@ -45,8 +45,8 @@ Delete an enrich policy. Deletes an existing enrich policy and its enrich index.
[source,ts]
----
interface EnrichDeletePolicyRequest extends <<shared-type-request-base, RequestBase>> {
name: <<shared-type-name, Name>>
interface EnrichDeletePolicyRequest extends <<RequestBase>> {
name: <<Name>>
}
----
@ -55,6 +55,6 @@ interface EnrichDeletePolicyRequest extends <<shared-type-request-base, RequestB
[source,ts]
----
type EnrichDeletePolicyResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
type EnrichDeletePolicyResponse = <<AcknowledgedResponseBase>>
----

View File

@ -45,8 +45,8 @@ Creates the enrich index for an existing enrich policy.
[source,ts]
----
interface EnrichExecutePolicyRequest extends <<shared-type-request-base, RequestBase>> {
name: <<shared-type-name, Name>>
interface EnrichExecutePolicyRequest extends <<RequestBase>> {
name: <<Name>>
wait_for_completion?: boolean
}
----
@ -58,7 +58,7 @@ interface EnrichExecutePolicyRequest extends <<shared-type-request-base, Request
----
interface EnrichExecutePolicyResponse {
status?: EnrichExecutePolicyExecuteEnrichPolicyStatus
task_id?: <<shared-type-task-id, TaskId>>
task_id?: <<TaskId>>
}
----

View File

@ -45,8 +45,8 @@ Get an enrich policy. Returns information about an enrich policy.
[source,ts]
----
interface EnrichGetPolicyRequest extends <<shared-type-request-base, RequestBase>> {
name?: <<shared-type-names, Names>>
interface EnrichGetPolicyRequest extends <<RequestBase>> {
name?: <<Names>>
}
----

View File

@ -45,8 +45,8 @@ Create an enrich policy. Creates an enrich policy.
[source,ts]
----
interface EnrichPutPolicyRequest extends <<shared-type-request-base, RequestBase>> {
name: <<shared-type-name, Name>>
interface EnrichPutPolicyRequest extends <<RequestBase>> {
name: <<Name>>
geo_match?: EnrichPolicy
match?: EnrichPolicy
range?: EnrichPolicy
@ -58,6 +58,6 @@ interface EnrichPutPolicyRequest extends <<shared-type-request-base, RequestBase
[source,ts]
----
type EnrichPutPolicyResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
type EnrichPutPolicyResponse = <<AcknowledgedResponseBase>>
----

View File

@ -45,7 +45,7 @@ Get enrich stats. Returns enrich coordinator statistics and information about en
[source,ts]
----
interface EnrichStatsRequest extends <<shared-type-request-base, RequestBase>> {
interface EnrichStatsRequest extends <<RequestBase>> {
}
----

View File

@ -45,8 +45,8 @@ Deletes an async EQL search or a stored synchronous EQL search. The API also del
[source,ts]
----
interface EqlDeleteRequest extends <<shared-type-request-base, RequestBase>> {
id: <<shared-type-id, Id>>
interface EqlDeleteRequest extends <<RequestBase>> {
id: <<Id>>
}
----
@ -55,6 +55,6 @@ interface EqlDeleteRequest extends <<shared-type-request-base, RequestBase>> {
[source,ts]
----
type EqlDeleteResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
type EqlDeleteResponse = <<AcknowledgedResponseBase>>
----

View File

@ -45,10 +45,10 @@ Returns the current status and available results for an async EQL search or a st
[source,ts]
----
interface EqlGetRequest extends <<shared-type-request-base, RequestBase>> {
id: <<shared-type-id, Id>>
keep_alive?: <<shared-type-duration, Duration>>
wait_for_completion_timeout?: <<shared-type-duration, Duration>>
interface EqlGetRequest extends <<RequestBase>> {
id: <<Id>>
keep_alive?: <<Duration>>
wait_for_completion_timeout?: <<Duration>>
}
----

View File

@ -45,8 +45,8 @@ Returns the current status for an async EQL search or a stored synchronous EQL s
[source,ts]
----
interface EqlGetStatusRequest extends <<shared-type-request-base, RequestBase>> {
id: <<shared-type-id, Id>>
interface EqlGetStatusRequest extends <<RequestBase>> {
id: <<Id>>
}
----
@ -56,12 +56,12 @@ interface EqlGetStatusRequest extends <<shared-type-request-base, RequestBase>>
[source,ts]
----
interface EqlGetStatusResponse {
id: <<shared-type-id, Id>>
id: <<Id>>
is_partial: boolean
is_running: boolean
start_time_in_millis?: <<shared-type-epoch-time, EpochTime>><<<shared-type-unit-millis, UnitMillis>>>
expiration_time_in_millis?: <<shared-type-epoch-time, EpochTime>><<<shared-type-unit-millis, UnitMillis>>>
completion_status?: <<shared-type-integer, integer>>
start_time_in_millis?: <<EpochTime>><<<UnitMillis>>>
expiration_time_in_millis?: <<EpochTime>><<<UnitMillis>>>
completion_status?: <<integer>>
}
----

View File

@ -45,23 +45,23 @@ Returns results matching a query expressed in Event Query Language (EQL)
[source,ts]
----
interface EqlSearchRequest extends <<shared-type-request-base, RequestBase>> {
index: <<shared-type-indices, Indices>>
interface EqlSearchRequest extends <<RequestBase>> {
index: <<Indices>>
allow_no_indices?: boolean
expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
expand_wildcards?: <<ExpandWildcards>>
ignore_unavailable?: boolean
query: string
case_sensitive?: boolean
event_category_field?: <<shared-type-field, Field>>
tiebreaker_field?: <<shared-type-field, Field>>
timestamp_field?: <<shared-type-field, Field>>
fetch_size?: <<shared-type-uint, uint>>
event_category_field?: <<Field>>
tiebreaker_field?: <<Field>>
timestamp_field?: <<Field>>
fetch_size?: <<uint>>
filter?: QueryDslQueryContainer | QueryDslQueryContainer[]
keep_alive?: <<shared-type-duration, Duration>>
keep_alive?: <<Duration>>
keep_on_completion?: boolean
wait_for_completion_timeout?: <<shared-type-duration, Duration>>
size?: <<shared-type-uint, uint>>
fields?: QueryDslFieldAndFormat | <<shared-type-field, Field>> | (QueryDslFieldAndFormat | <<shared-type-field, Field>>)[]
wait_for_completion_timeout?: <<Duration>>
size?: <<uint>>
fields?: QueryDslFieldAndFormat | <<Field>> | (QueryDslFieldAndFormat | <<Field>>)[]
result_position?: EqlSearchResultPosition
runtime_mappings?: MappingRuntimeFields
}

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