More type definitions, with fixed links (hopefully)

This commit is contained in:
Josh Mock
2024-11-20 13:47:14 -06:00
parent 7a997b3405
commit 70a3ef44bb
296 changed files with 23864 additions and 474 deletions

View File

@ -66,7 +66,7 @@ interface AsyncSearchGetRequest extends <<RequestBase>> {
++++ ++++
<pre> <pre>
++++ ++++
type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations> type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = <<AsyncSearchAsyncSearchDocumentResponseBase>><TDocument, TAggregations>
[pass] [pass]
++++ ++++

View File

@ -85,12 +85,12 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
aggregations?: Record<string, <<AggregationsAggregationContainer>>> aggregations?: Record<string, <<AggregationsAggregationContainer>>>
pass:[/**] @alias aggregations */ pass:[/**] @alias aggregations */
aggs?: Record<string, <<AggregationsAggregationContainer>>> aggs?: Record<string, <<AggregationsAggregationContainer>>>
collapse?: SearchFieldCollapse collapse?: <<SearchFieldCollapse>>
explain?: boolean explain?: boolean
ext?: Record<string, any> ext?: Record<string, any>
from?: <<integer>> from?: <<integer>>
highlight?: SearchHighlight highlight?: <<SearchHighlight>>
track_total_hits?: SearchTrackHits track_total_hits?: <<SearchTrackHits>>
indices_boost?: Record<<<IndexName>>, <<double>>>[] indices_boost?: Record<<<IndexName>>, <<double>>>[]
docvalue_fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[] docvalue_fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[]
knn?: <<KnnSearch>> | <<KnnSearch>>[] knn?: <<KnnSearch>> | <<KnnSearch>>[]
@ -98,22 +98,22 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
post_filter?: <<QueryDslQueryContainer>> post_filter?: <<QueryDslQueryContainer>>
profile?: boolean profile?: boolean
query?: <<QueryDslQueryContainer>> query?: <<QueryDslQueryContainer>>
rescore?: SearchRescore | SearchRescore[] rescore?: <<SearchRescore>> | <<SearchRescore>>[]
script_fields?: Record<string, <<ScriptField>>> script_fields?: Record<string, <<ScriptField>>>
search_after?: <<SortResults>> search_after?: <<SortResults>>
size?: <<integer>> size?: <<integer>>
slice?: <<SlicedScroll>> slice?: <<SlicedScroll>>
sort?: <<Sort>> sort?: <<Sort>>
_source?: SearchSourceConfig _source?: <<SearchSourceConfig>>
fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[] fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[]
suggest?: SearchSuggester suggest?: <<SearchSuggester>>
terminate_after?: <<long>> terminate_after?: <<long>>
timeout?: string timeout?: string
track_scores?: boolean track_scores?: boolean
version?: boolean version?: boolean
seq_no_primary_term?: boolean seq_no_primary_term?: boolean
stored_fields?: <<Fields>> stored_fields?: <<Fields>>
pit?: SearchPointInTimeReference pit?: <<SearchPointInTimeReference>>
runtime_mappings?: <<MappingRuntimeFields>> runtime_mappings?: <<MappingRuntimeFields>>
stats?: string[] stats?: string[]
} }
@ -129,7 +129,7 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
++++ ++++
<pre> <pre>
++++ ++++
type AsyncSearchSubmitResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations> type AsyncSearchSubmitResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = <<AsyncSearchAsyncSearchDocumentResponseBase>><TDocument, TAggregations>
[pass] [pass]
++++ ++++

View File

@ -63,7 +63,7 @@ interface AutoscalingGetAutoscalingPolicyRequest extends <<RequestBase>> {
++++ ++++
<pre> <pre>
++++ ++++
type AutoscalingGetAutoscalingPolicyResponse = AutoscalingAutoscalingPolicy type AutoscalingGetAutoscalingPolicyResponse = <<AutoscalingAutoscalingPolicy>>
[pass] [pass]
++++ ++++

View File

@ -50,7 +50,7 @@ Create or update an autoscaling policy. NOTE: This feature is designed for indir
++++ ++++
interface AutoscalingPutAutoscalingPolicyRequest extends <<RequestBase>> { interface AutoscalingPutAutoscalingPolicyRequest extends <<RequestBase>> {
name: <<Name>> name: <<Name>>
policy?: AutoscalingAutoscalingPolicy policy?: <<AutoscalingAutoscalingPolicy>>
} }
[pass] [pass]

View File

@ -53,13 +53,13 @@ interface BulkRequest<TDocument = unknown, TPartialDocument = unknown> extends <
pipeline?: string pipeline?: string
refresh?: <<Refresh>> refresh?: <<Refresh>>
routing?: <<Routing>> routing?: <<Routing>>
_source?: SearchSourceConfigParam _source?: <<SearchSourceConfigParam>>
_source_excludes?: <<Fields>> _source_excludes?: <<Fields>>
_source_includes?: <<Fields>> _source_includes?: <<Fields>>
timeout?: <<Duration>> timeout?: <<Duration>>
wait_for_active_shards?: <<WaitForActiveShards>> wait_for_active_shards?: <<WaitForActiveShards>>
require_alias?: boolean require_alias?: boolean
operations?: (BulkOperationContainer | BulkUpdateAction<TDocument, TPartialDocument> | TDocument)[] operations?: (<<BulkOperationContainer>> | <<BulkUpdateAction>><TDocument, TPartialDocument> | TDocument)[]
} }
[pass] [pass]
@ -75,7 +75,7 @@ interface BulkRequest<TDocument = unknown, TPartialDocument = unknown> extends <
++++ ++++
interface BulkResponse { interface BulkResponse {
errors: boolean errors: boolean
items: Partial<Record<BulkOperationType, BulkResponseItem>>[] items: Partial<Record<<<BulkOperationType>>, <<BulkResponseItem>>>>[]
took: <<long>> took: <<long>>
ingest_took?: <<long>> ingest_took?: <<long>>
} }

View File

@ -48,7 +48,7 @@ Get aliases. Retrieves the clusters index aliases, including filter and routi
++++ ++++
<pre> <pre>
++++ ++++
interface CatAliasesRequest extends CatCatRequestBase { interface CatAliasesRequest extends <<CatCatRequestBase>> {
name?: <<Names>> name?: <<Names>>
expand_wildcards?: <<ExpandWildcards>> expand_wildcards?: <<ExpandWildcards>>
} }

View File

@ -48,7 +48,7 @@ Provides a snapshot of the number of shards allocated to each data node and thei
++++ ++++
<pre> <pre>
++++ ++++
interface CatAllocationRequest extends CatCatRequestBase { interface CatAllocationRequest extends <<CatCatRequestBase>> {
node_id?: <<NodeIds>> node_id?: <<NodeIds>>
bytes?: <<Bytes>> bytes?: <<Bytes>>
} }

View File

@ -48,7 +48,7 @@ Get component templates. Returns information about component templates in a clus
++++ ++++
<pre> <pre>
++++ ++++
interface CatComponentTemplatesRequest extends CatCatRequestBase { interface CatComponentTemplatesRequest extends <<CatCatRequestBase>> {
name?: string name?: string
} }

View File

@ -48,7 +48,7 @@ Get a document count. Provides quick access to a document count for a data strea
++++ ++++
<pre> <pre>
++++ ++++
interface CatCountRequest extends CatCatRequestBase { interface CatCountRequest extends <<CatCatRequestBase>> {
index?: <<Indices>> index?: <<Indices>>
} }

View File

@ -48,7 +48,7 @@ Returns the amount of heap memory currently used by the field data cache on ever
++++ ++++
<pre> <pre>
++++ ++++
interface CatFielddataRequest extends CatCatRequestBase { interface CatFielddataRequest extends <<CatCatRequestBase>> {
fields?: <<Fields>> fields?: <<Fields>>
bytes?: <<Bytes>> bytes?: <<Bytes>>
} }

View File

@ -48,7 +48,7 @@ Returns the health status of a cluster, similar to the cluster health API. IMPOR
++++ ++++
<pre> <pre>
++++ ++++
interface CatHealthRequest extends CatCatRequestBase { interface CatHealthRequest extends <<CatCatRequestBase>> {
time?: <<TimeUnit>> time?: <<TimeUnit>>
ts?: boolean ts?: boolean
} }

View File

@ -48,7 +48,7 @@ Get CAT help. Returns help for the CAT APIs.
++++ ++++
<pre> <pre>
++++ ++++
interface CatHelpRequest extends CatCatRequestBase { interface CatHelpRequest extends <<CatCatRequestBase>> {
} }
[pass] [pass]

View File

@ -48,7 +48,7 @@ Get index information. Returns high-level information about indices in a cluster
++++ ++++
<pre> <pre>
++++ ++++
interface CatIndicesRequest extends CatCatRequestBase { interface CatIndicesRequest extends <<CatCatRequestBase>> {
index?: <<Indices>> index?: <<Indices>>
bytes?: <<Bytes>> bytes?: <<Bytes>>
expand_wildcards?: <<ExpandWildcards>> expand_wildcards?: <<ExpandWildcards>>

View File

@ -48,7 +48,7 @@ Returns information about the master node, including the ID, bound IP address, a
++++ ++++
<pre> <pre>
++++ ++++
interface CatMasterRequest extends CatCatRequestBase { interface CatMasterRequest extends <<CatCatRequestBase>> {
} }
[pass] [pass]

View File

@ -48,12 +48,12 @@ Get data frame analytics jobs. Returns configuration and usage information about
++++ ++++
<pre> <pre>
++++ ++++
interface CatMlDataFrameAnalyticsRequest extends CatCatRequestBase { interface CatMlDataFrameAnalyticsRequest extends <<CatCatRequestBase>> {
id?: <<Id>> id?: <<Id>>
allow_no_match?: boolean allow_no_match?: boolean
bytes?: <<Bytes>> bytes?: <<Bytes>>
h?: CatCatDfaColumns h?: <<CatCatDfaColumns>>
s?: CatCatDfaColumns s?: <<CatCatDfaColumns>>
time?: <<Duration>> time?: <<Duration>>
} }

View File

@ -48,11 +48,11 @@ Get datafeeds. Returns configuration and usage information about datafeeds. This
++++ ++++
<pre> <pre>
++++ ++++
interface CatMlDatafeedsRequest extends CatCatRequestBase { interface CatMlDatafeedsRequest extends <<CatCatRequestBase>> {
datafeed_id?: <<Id>> datafeed_id?: <<Id>>
allow_no_match?: boolean allow_no_match?: boolean
h?: CatCatDatafeedColumns h?: <<CatCatDatafeedColumns>>
s?: CatCatDatafeedColumns s?: <<CatCatDatafeedColumns>>
time?: <<TimeUnit>> time?: <<TimeUnit>>
} }

View File

@ -48,12 +48,12 @@ Get anomaly detection jobs. Returns configuration and usage information for anom
++++ ++++
<pre> <pre>
++++ ++++
interface CatMlJobsRequest extends CatCatRequestBase { interface CatMlJobsRequest extends <<CatCatRequestBase>> {
job_id?: <<Id>> job_id?: <<Id>>
allow_no_match?: boolean allow_no_match?: boolean
bytes?: <<Bytes>> bytes?: <<Bytes>>
h?: CatCatAnonalyDetectorColumns h?: <<CatCatAnonalyDetectorColumns>>
s?: CatCatAnonalyDetectorColumns s?: <<CatCatAnonalyDetectorColumns>>
time?: <<TimeUnit>> time?: <<TimeUnit>>
} }

View File

@ -48,12 +48,12 @@ Get trained models. Returns configuration and usage information about inference
++++ ++++
<pre> <pre>
++++ ++++
interface CatMlTrainedModelsRequest extends CatCatRequestBase { interface CatMlTrainedModelsRequest extends <<CatCatRequestBase>> {
model_id?: <<Id>> model_id?: <<Id>>
allow_no_match?: boolean allow_no_match?: boolean
bytes?: <<Bytes>> bytes?: <<Bytes>>
h?: CatCatTrainedModelsColumns h?: <<CatCatTrainedModelsColumns>>
s?: CatCatTrainedModelsColumns s?: <<CatCatTrainedModelsColumns>>
from?: <<integer>> from?: <<integer>>
size?: <<integer>> size?: <<integer>>
} }

View File

@ -48,7 +48,7 @@ Returns information about custom node attributes. IMPORTANT: cat APIs are only i
++++ ++++
<pre> <pre>
++++ ++++
interface CatNodeattrsRequest extends CatCatRequestBase { interface CatNodeattrsRequest extends <<CatCatRequestBase>> {
} }
[pass] [pass]

View File

@ -48,7 +48,7 @@ Returns information about the nodes in a cluster. IMPORTANT: cat APIs are only i
++++ ++++
<pre> <pre>
++++ ++++
interface CatNodesRequest extends CatCatRequestBase { interface CatNodesRequest extends <<CatCatRequestBase>> {
bytes?: <<Bytes>> bytes?: <<Bytes>>
full_id?: boolean | string full_id?: boolean | string
include_unloaded_segments?: boolean include_unloaded_segments?: boolean

View File

@ -48,7 +48,7 @@ Returns cluster-level changes that have not yet been executed. IMPORTANT: cat AP
++++ ++++
<pre> <pre>
++++ ++++
interface CatPendingTasksRequest extends CatCatRequestBase { interface CatPendingTasksRequest extends <<CatCatRequestBase>> {
} }
[pass] [pass]

View File

@ -48,7 +48,7 @@ Returns a list of plugins running on each node of a cluster. IMPORTANT: cat APIs
++++ ++++
<pre> <pre>
++++ ++++
interface CatPluginsRequest extends CatCatRequestBase { interface CatPluginsRequest extends <<CatCatRequestBase>> {
} }
[pass] [pass]

View File

@ -48,7 +48,7 @@ Returns information about ongoing and completed shard recoveries. Shard recovery
++++ ++++
<pre> <pre>
++++ ++++
interface CatRecoveryRequest extends CatCatRequestBase { interface CatRecoveryRequest extends <<CatCatRequestBase>> {
index?: <<Indices>> index?: <<Indices>>
active_only?: boolean active_only?: boolean
bytes?: <<Bytes>> bytes?: <<Bytes>>

View File

@ -48,7 +48,7 @@ Returns the snapshot repositories for a cluster. IMPORTANT: cat APIs are only in
++++ ++++
<pre> <pre>
++++ ++++
interface CatRepositoriesRequest extends CatCatRequestBase { interface CatRepositoriesRequest extends <<CatCatRequestBase>> {
} }
[pass] [pass]

View File

@ -48,7 +48,7 @@ Returns low-level information about the Lucene segments in index shards. For dat
++++ ++++
<pre> <pre>
++++ ++++
interface CatSegmentsRequest extends CatCatRequestBase { interface CatSegmentsRequest extends <<CatCatRequestBase>> {
index?: <<Indices>> index?: <<Indices>>
bytes?: <<Bytes>> bytes?: <<Bytes>>
} }

View File

@ -48,7 +48,7 @@ Returns information about the shards in a cluster. For data streams, the API ret
++++ ++++
<pre> <pre>
++++ ++++
interface CatShardsRequest extends CatCatRequestBase { interface CatShardsRequest extends <<CatCatRequestBase>> {
index?: <<Indices>> index?: <<Indices>>
bytes?: <<Bytes>> bytes?: <<Bytes>>
} }

View File

@ -48,7 +48,7 @@ Returns information about the snapshots stored in one or more repositories. A sn
++++ ++++
<pre> <pre>
++++ ++++
interface CatSnapshotsRequest extends CatCatRequestBase { interface CatSnapshotsRequest extends <<CatCatRequestBase>> {
repository?: <<Names>> repository?: <<Names>>
ignore_unavailable?: boolean ignore_unavailable?: boolean
} }

View File

@ -48,7 +48,7 @@ Returns information about tasks currently executing in the cluster. IMPORTANT: c
++++ ++++
<pre> <pre>
++++ ++++
interface CatTasksRequest extends CatCatRequestBase { interface CatTasksRequest extends <<CatCatRequestBase>> {
actions?: string[] actions?: string[]
detailed?: boolean detailed?: boolean
node_id?: string[] node_id?: string[]

View File

@ -48,7 +48,7 @@ Returns information about index templates in a cluster. You can use index templa
++++ ++++
<pre> <pre>
++++ ++++
interface CatTemplatesRequest extends CatCatRequestBase { interface CatTemplatesRequest extends <<CatCatRequestBase>> {
name?: <<Name>> name?: <<Name>>
} }

View File

@ -48,7 +48,7 @@ Returns thread pool statistics for each node in a cluster. Returned information
++++ ++++
<pre> <pre>
++++ ++++
interface CatThreadPoolRequest extends CatCatRequestBase { interface CatThreadPoolRequest extends <<CatCatRequestBase>> {
thread_pool_patterns?: <<Names>> thread_pool_patterns?: <<Names>>
time?: <<TimeUnit>> time?: <<TimeUnit>>
} }

View File

@ -48,12 +48,12 @@ Get transforms. Returns configuration and usage information about transforms. CA
++++ ++++
<pre> <pre>
++++ ++++
interface CatTransformsRequest extends CatCatRequestBase { interface CatTransformsRequest extends <<CatCatRequestBase>> {
transform_id?: <<Id>> transform_id?: <<Id>>
allow_no_match?: boolean allow_no_match?: boolean
from?: <<integer>> from?: <<integer>>
h?: CatCatTransformColumns h?: <<CatCatTransformColumns>>
s?: CatCatTransformColumns s?: <<CatCatTransformColumns>>
time?: <<TimeUnit>> time?: <<TimeUnit>>
size?: <<integer>> size?: <<integer>>
} }

View File

@ -64,7 +64,7 @@ interface CcrFollowStatsRequest extends <<RequestBase>> {
<pre> <pre>
++++ ++++
interface CcrFollowStatsResponse { interface CcrFollowStatsResponse {
indices: CcrFollowIndexStats[] indices: <<CcrFollowIndexStats>>[]
} }
[pass] [pass]

View File

@ -68,7 +68,7 @@ interface ClusterGetComponentTemplateRequest extends <<RequestBase>> {
<pre> <pre>
++++ ++++
interface ClusterGetComponentTemplateResponse { interface ClusterGetComponentTemplateResponse {
component_templates: ClusterComponentTemplate[] component_templates: <<ClusterComponentTemplate>>[]
} }
[pass] [pass]

View File

@ -65,10 +65,10 @@ interface ClusterInfoRequest extends <<RequestBase>> {
++++ ++++
interface ClusterInfoResponse { interface ClusterInfoResponse {
cluster_name: <<Name>> cluster_name: <<Name>>
http?: NodesHttp http?: <<NodesHttp>>
ingest?: NodesIngest ingest?: <<NodesIngest>>
thread_pool?: Record<string, NodesThreadCount> thread_pool?: Record<string, <<NodesThreadCount>>>
script?: NodesScripting script?: <<NodesScripting>>
} }
[pass] [pass]

View File

@ -52,7 +52,7 @@ interface ClusterPutComponentTemplateRequest extends <<RequestBase>> {
name: <<Name>> name: <<Name>>
create?: boolean create?: boolean
master_timeout?: <<Duration>> master_timeout?: <<Duration>>
template: IndicesIndexState template: <<IndicesIndexState>>
version?: <<VersionNumber>> version?: <<VersionNumber>>
_meta?: <<Metadata>> _meta?: <<Metadata>>
deprecated?: boolean deprecated?: boolean

View File

@ -63,7 +63,7 @@ interface ConnectorGetRequest extends <<RequestBase>> {
++++ ++++
<pre> <pre>
++++ ++++
type ConnectorGetResponse = ConnectorConnector type ConnectorGetResponse = <<ConnectorConnector>>
[pass] [pass]
++++ ++++

View File

@ -70,7 +70,7 @@ interface ConnectorListRequest extends <<RequestBase>> {
++++ ++++
interface ConnectorListResponse { interface ConnectorListResponse {
count: <<long>> count: <<long>>
results: ConnectorConnector[] results: <<ConnectorConnector>>[]
} }
[pass] [pass]

View File

@ -63,7 +63,7 @@ interface ConnectorSyncJobGetRequest extends <<RequestBase>> {
++++ ++++
<pre> <pre>
++++ ++++
type ConnectorSyncJobGetResponse = ConnectorConnectorSyncJob type ConnectorSyncJobGetResponse = <<ConnectorConnectorSyncJob>>
[pass] [pass]
++++ ++++

View File

@ -51,9 +51,9 @@ Get all connector sync jobs. Get information about all stored connector sync job
interface ConnectorSyncJobListRequest extends <<RequestBase>> { interface ConnectorSyncJobListRequest extends <<RequestBase>> {
from?: <<integer>> from?: <<integer>>
size?: <<integer>> size?: <<integer>>
status?: ConnectorSyncStatus status?: <<ConnectorSyncStatus>>
connector_id?: <<Id>> connector_id?: <<Id>>
job_type?: ConnectorSyncJobType | ConnectorSyncJobType[] job_type?: <<ConnectorSyncJobType>> | <<ConnectorSyncJobType>>[]
} }
[pass] [pass]
@ -69,7 +69,7 @@ interface ConnectorSyncJobListRequest extends <<RequestBase>> {
++++ ++++
interface ConnectorSyncJobListResponse { interface ConnectorSyncJobListResponse {
count: <<long>> count: <<long>>
results: ConnectorConnectorSyncJob[] results: <<ConnectorConnectorSyncJob>>[]
} }
[pass] [pass]

View File

@ -50,8 +50,8 @@ Create a connector sync job. Create a connector sync job document in the interna
++++ ++++
interface ConnectorSyncJobPostRequest extends <<RequestBase>> { interface ConnectorSyncJobPostRequest extends <<RequestBase>> {
id: <<Id>> id: <<Id>>
job_type?: ConnectorSyncJobType job_type?: <<ConnectorSyncJobType>>
trigger_method?: ConnectorSyncJobTriggerMethod trigger_method?: <<ConnectorSyncJobTriggerMethod>>
} }
[pass] [pass]

View File

@ -50,7 +50,7 @@ Update the connector configuration. Update the configuration field in the connec
++++ ++++
interface ConnectorUpdateConfigurationRequest extends <<RequestBase>> { interface ConnectorUpdateConfigurationRequest extends <<RequestBase>> {
connector_id: <<Id>> connector_id: <<Id>>
configuration?: ConnectorConnectorConfiguration configuration?: <<ConnectorConnectorConfiguration>>
values?: Record<string, any> values?: Record<string, any>
} }

View File

@ -50,9 +50,9 @@ Update the connector filtering. Update the draft filtering configuration of a co
++++ ++++
interface ConnectorUpdateFilteringRequest extends <<RequestBase>> { interface ConnectorUpdateFilteringRequest extends <<RequestBase>> {
connector_id: <<Id>> connector_id: <<Id>>
filtering?: ConnectorFilteringConfig[] filtering?: <<ConnectorFilteringConfig>>[]
rules?: ConnectorFilteringRule[] rules?: <<ConnectorFilteringRule>>[]
advanced_snippet?: ConnectorFilteringAdvancedSnippet advanced_snippet?: <<ConnectorFilteringAdvancedSnippet>>
} }
[pass] [pass]

View File

@ -48,7 +48,7 @@ Update the connector draft filtering validation. Update the draft filtering vali
++++ ++++
interface ConnectorUpdateFilteringValidationRequest extends <<RequestBase>> { interface ConnectorUpdateFilteringValidationRequest extends <<RequestBase>> {
connector_id: <<Id>> connector_id: <<Id>>
validation: ConnectorFilteringRulesValidation validation: <<ConnectorFilteringRulesValidation>>
} }
[pass] [pass]

View File

@ -50,7 +50,7 @@ Update the connector pipeline. When you create a new connector, the configuratio
++++ ++++
interface ConnectorUpdatePipelineRequest extends <<RequestBase>> { interface ConnectorUpdatePipelineRequest extends <<RequestBase>> {
connector_id: <<Id>> connector_id: <<Id>>
pipeline: ConnectorIngestPipelineParams pipeline: <<ConnectorIngestPipelineParams>>
} }
[pass] [pass]

View File

@ -50,7 +50,7 @@ Update the connector scheduling.
++++ ++++
interface ConnectorUpdateSchedulingRequest extends <<RequestBase>> { interface ConnectorUpdateSchedulingRequest extends <<RequestBase>> {
connector_id: <<Id>> connector_id: <<Id>>
scheduling: ConnectorSchedulingConfiguration scheduling: <<ConnectorSchedulingConfiguration>>
} }
[pass] [pass]

View File

@ -50,7 +50,7 @@ Update the connector status.
++++ ++++
interface ConnectorUpdateStatusRequest extends <<RequestBase>> { interface ConnectorUpdateStatusRequest extends <<RequestBase>> {
connector_id: <<Id>> connector_id: <<Id>>
status: ConnectorConnectorStatus status: <<ConnectorConnectorStatus>>
} }
[pass] [pass]

View File

@ -64,7 +64,7 @@ interface DeleteByQueryRethrottleRequest extends <<RequestBase>> {
++++ ++++
<pre> <pre>
++++ ++++
type DeleteByQueryRethrottleResponse = TasksTaskListResponseBase type DeleteByQueryRethrottleResponse = <<TasksTaskListResponseBase>>
[pass] [pass]
++++ ++++

View File

@ -64,7 +64,7 @@ interface EnrichGetPolicyRequest extends <<RequestBase>> {
<pre> <pre>
++++ ++++
interface EnrichGetPolicyResponse { interface EnrichGetPolicyResponse {
policies: EnrichSummary[] policies: <<EnrichSummary>>[]
} }
[pass] [pass]

View File

@ -50,9 +50,9 @@ Create an enrich policy. Creates an enrich policy.
++++ ++++
interface EnrichPutPolicyRequest extends <<RequestBase>> { interface EnrichPutPolicyRequest extends <<RequestBase>> {
name: <<Name>> name: <<Name>>
geo_match?: EnrichPolicy geo_match?: <<EnrichPolicy>>
match?: EnrichPolicy match?: <<EnrichPolicy>>
range?: EnrichPolicy range?: <<EnrichPolicy>>
} }
[pass] [pass]

View File

@ -65,7 +65,7 @@ interface EqlGetRequest extends <<RequestBase>> {
++++ ++++
<pre> <pre>
++++ ++++
type EqlGetResponse<TEvent = unknown> = EqlEqlSearchResponseBase<TEvent> type EqlGetResponse<TEvent = unknown> = <<EqlEqlSearchResponseBase>><TEvent>
[pass] [pass]
++++ ++++

View File

@ -80,7 +80,7 @@ interface EqlSearchRequest extends <<RequestBase>> {
++++ ++++
<pre> <pre>
++++ ++++
type EqlSearchResponse<TEvent = unknown> = EqlEqlSearchResponseBase<TEvent> type EqlSearchResponse<TEvent = unknown> = <<EqlEqlSearchResponseBase>><TEvent>
[pass] [pass]
++++ ++++

View File

@ -58,7 +58,7 @@ interface EsqlQueryRequest extends <<RequestBase>> {
params?: <<FieldValue>>[] params?: <<FieldValue>>[]
profile?: boolean profile?: boolean
query: string query: string
tables?: Record<string, Record<string, EsqlTableValuesContainer>> tables?: Record<string, Record<string, <<EsqlTableValuesContainer>>>>
} }
[pass] [pass]

View File

@ -55,7 +55,7 @@ interface ExistsRequest extends <<RequestBase>> {
realtime?: boolean realtime?: boolean
refresh?: boolean refresh?: boolean
routing?: <<Routing>> routing?: <<Routing>>
_source?: SearchSourceConfigParam _source?: <<SearchSourceConfigParam>>
_source_excludes?: <<Fields>> _source_excludes?: <<Fields>>
_source_includes?: <<Fields>> _source_includes?: <<Fields>>
stored_fields?: <<Fields>> stored_fields?: <<Fields>>

View File

@ -55,7 +55,7 @@ interface ExistsSourceRequest extends <<RequestBase>> {
realtime?: boolean realtime?: boolean
refresh?: boolean refresh?: boolean
routing?: <<Routing>> routing?: <<Routing>>
_source?: SearchSourceConfigParam _source?: <<SearchSourceConfigParam>>
_source_excludes?: <<Fields>> _source_excludes?: <<Fields>>
_source_includes?: <<Fields>> _source_includes?: <<Fields>>
version?: <<VersionNumber>> version?: <<VersionNumber>>

View File

@ -58,7 +58,7 @@ interface ExplainRequest extends <<RequestBase>> {
lenient?: boolean lenient?: boolean
preference?: string preference?: string
routing?: <<Routing>> routing?: <<Routing>>
_source?: SearchSourceConfigParam _source?: <<SearchSourceConfigParam>>
_source_excludes?: <<Fields>> _source_excludes?: <<Fields>>
_source_includes?: <<Fields>> _source_includes?: <<Fields>>
stored_fields?: <<Fields>> stored_fields?: <<Fields>>
@ -81,7 +81,7 @@ interface ExplainResponse<TDocument = unknown> {
_index: <<IndexName>> _index: <<IndexName>>
_id: <<Id>> _id: <<Id>>
matched: boolean matched: boolean
explanation?: ExplainExplanationDetail explanation?: <<ExplainExplanationDetail>>
get?: <<InlineGet>><TDocument> get?: <<InlineGet>><TDocument>
} }

View File

@ -63,7 +63,7 @@ interface FeaturesGetFeaturesRequest extends <<RequestBase>> {
<pre> <pre>
++++ ++++
interface FeaturesGetFeaturesResponse { interface FeaturesGetFeaturesResponse {
features: FeaturesFeature[] features: <<FeaturesFeature>>[]
} }
[pass] [pass]

View File

@ -63,7 +63,7 @@ interface FeaturesResetFeaturesRequest extends <<RequestBase>> {
<pre> <pre>
++++ ++++
interface FeaturesResetFeaturesResponse { interface FeaturesResetFeaturesResponse {
features: FeaturesFeature[] features: <<FeaturesFeature>>[]
} }
[pass] [pass]

View File

@ -75,7 +75,7 @@ interface FieldCapsRequest extends <<RequestBase>> {
++++ ++++
interface FieldCapsResponse { interface FieldCapsResponse {
indices: <<Indices>> indices: <<Indices>>
fields: Record<<<Field>>, Record<string, FieldCapsFieldCapability>> fields: Record<<<Field>>, Record<string, <<FieldCapsFieldCapability>>>>
} }
[pass] [pass]

View File

@ -52,7 +52,7 @@ interface FleetGlobalCheckpointsRequest extends <<RequestBase>> {
index: <<IndexName>> | <<IndexAlias>> index: <<IndexName>> | <<IndexAlias>>
wait_for_advance?: boolean wait_for_advance?: boolean
wait_for_index?: boolean wait_for_index?: boolean
checkpoints?: FleetCheckpoint[] checkpoints?: <<FleetCheckpoint>>[]
timeout?: <<Duration>> timeout?: <<Duration>>
} }
@ -68,7 +68,7 @@ interface FleetGlobalCheckpointsRequest extends <<RequestBase>> {
<pre> <pre>
++++ ++++
interface FleetGlobalCheckpointsResponse { interface FleetGlobalCheckpointsResponse {
global_checkpoints: FleetCheckpoint[] global_checkpoints: <<FleetCheckpoint>>[]
timed_out: boolean timed_out: boolean
} }

View File

@ -59,9 +59,9 @@ interface FleetMsearchRequest extends <<RequestBase>> {
search_type?: <<SearchType>> search_type?: <<SearchType>>
rest_total_hits_as_int?: boolean rest_total_hits_as_int?: boolean
typed_keys?: boolean typed_keys?: boolean
wait_for_checkpoints?: FleetCheckpoint[] wait_for_checkpoints?: <<FleetCheckpoint>>[]
allow_partial_search_results?: boolean allow_partial_search_results?: boolean
searches?: MsearchRequestItem[] searches?: <<MsearchRequestItem>>[]
} }
[pass] [pass]
@ -76,7 +76,7 @@ interface FleetMsearchRequest extends <<RequestBase>> {
<pre> <pre>
++++ ++++
interface FleetMsearchResponse<TDocument = unknown> { interface FleetMsearchResponse<TDocument = unknown> {
docs: MsearchResponseItem<TDocument>[] docs: <<MsearchResponseItem>><TDocument>[]
} }
[pass] [pass]

View File

@ -76,39 +76,39 @@ interface FleetSearchRequest extends <<RequestBase>> {
_source_excludes?: <<Fields>> _source_excludes?: <<Fields>>
_source_includes?: <<Fields>> _source_includes?: <<Fields>>
q?: string q?: string
wait_for_checkpoints?: FleetCheckpoint[] wait_for_checkpoints?: <<FleetCheckpoint>>[]
allow_partial_search_results?: boolean allow_partial_search_results?: boolean
aggregations?: Record<string, <<AggregationsAggregationContainer>>> aggregations?: Record<string, <<AggregationsAggregationContainer>>>
pass:[/**] @alias aggregations */ pass:[/**] @alias aggregations */
aggs?: Record<string, <<AggregationsAggregationContainer>>> aggs?: Record<string, <<AggregationsAggregationContainer>>>
collapse?: SearchFieldCollapse collapse?: <<SearchFieldCollapse>>
explain?: boolean explain?: boolean
ext?: Record<string, any> ext?: Record<string, any>
from?: <<integer>> from?: <<integer>>
highlight?: SearchHighlight highlight?: <<SearchHighlight>>
track_total_hits?: SearchTrackHits track_total_hits?: <<SearchTrackHits>>
indices_boost?: Record<<<IndexName>>, <<double>>>[] indices_boost?: Record<<<IndexName>>, <<double>>>[]
docvalue_fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[] docvalue_fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[]
min_score?: <<double>> min_score?: <<double>>
post_filter?: <<QueryDslQueryContainer>> post_filter?: <<QueryDslQueryContainer>>
profile?: boolean profile?: boolean
query?: <<QueryDslQueryContainer>> query?: <<QueryDslQueryContainer>>
rescore?: SearchRescore | SearchRescore[] rescore?: <<SearchRescore>> | <<SearchRescore>>[]
script_fields?: Record<string, <<ScriptField>>> script_fields?: Record<string, <<ScriptField>>>
search_after?: <<SortResults>> search_after?: <<SortResults>>
size?: <<integer>> size?: <<integer>>
slice?: <<SlicedScroll>> slice?: <<SlicedScroll>>
sort?: <<Sort>> sort?: <<Sort>>
_source?: SearchSourceConfig _source?: <<SearchSourceConfig>>
fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[] fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[]
suggest?: SearchSuggester suggest?: <<SearchSuggester>>
terminate_after?: <<long>> terminate_after?: <<long>>
timeout?: string timeout?: string
track_scores?: boolean track_scores?: boolean
version?: boolean version?: boolean
seq_no_primary_term?: boolean seq_no_primary_term?: boolean
stored_fields?: <<Fields>> stored_fields?: <<Fields>>
pit?: SearchPointInTimeReference pit?: <<SearchPointInTimeReference>>
runtime_mappings?: <<MappingRuntimeFields>> runtime_mappings?: <<MappingRuntimeFields>>
stats?: string[] stats?: string[]
} }
@ -128,16 +128,16 @@ interface FleetSearchResponse<TDocument = unknown> {
took: <<long>> took: <<long>>
timed_out: boolean timed_out: boolean
_shards: <<ShardStatistics>> _shards: <<ShardStatistics>>
hits: SearchHitsMetadata<TDocument> hits: <<SearchHitsMetadata>><TDocument>
aggregations?: Record<<<AggregateName>>, <<AggregationsAggregate>>> aggregations?: Record<<<AggregateName>>, <<AggregationsAggregate>>>
_clusters?: <<ClusterStatistics>> _clusters?: <<ClusterStatistics>>
fields?: Record<string, any> fields?: Record<string, any>
max_score?: <<double>> max_score?: <<double>>
num_reduce_phases?: <<long>> num_reduce_phases?: <<long>>
profile?: SearchProfile profile?: <<SearchProfile>>
pit_id?: <<Id>> pit_id?: <<Id>>
_scroll_id?: <<ScrollId>> _scroll_id?: <<ScrollId>>
suggest?: Record<<<SuggestionName>>, SearchSuggest<TDocument>[]> suggest?: Record<<<SuggestionName>>, <<SearchSuggest>><TDocument>[]>
terminated_early?: boolean terminated_early?: boolean
} }

View File

@ -56,7 +56,7 @@ interface GetRequest extends <<RequestBase>> {
realtime?: boolean realtime?: boolean
refresh?: boolean refresh?: boolean
routing?: <<Routing>> routing?: <<Routing>>
_source?: SearchSourceConfigParam _source?: <<SearchSourceConfigParam>>
_source_excludes?: <<Fields>> _source_excludes?: <<Fields>>
_source_includes?: <<Fields>> _source_includes?: <<Fields>>
stored_fields?: <<Fields>> stored_fields?: <<Fields>>
@ -75,7 +75,7 @@ interface GetRequest extends <<RequestBase>> {
++++ ++++
<pre> <pre>
++++ ++++
type GetResponse<TDocument = unknown> = GetGetResult<TDocument> type GetResponse<TDocument = unknown> = <<GetGetResult>><TDocument>
[pass] [pass]
++++ ++++

View File

@ -63,7 +63,7 @@ interface GetScriptContextRequest extends <<RequestBase>> {
<pre> <pre>
++++ ++++
interface GetScriptContextResponse { interface GetScriptContextResponse {
contexts: GetScriptContextContext[] contexts: <<GetScriptContextContext>>[]
} }
[pass] [pass]

View File

@ -63,7 +63,7 @@ interface GetScriptLanguagesRequest extends <<RequestBase>> {
<pre> <pre>
++++ ++++
interface GetScriptLanguagesResponse { interface GetScriptLanguagesResponse {
language_contexts: GetScriptLanguagesLanguageContext[] language_contexts: <<GetScriptLanguagesLanguageContext>>[]
types_allowed: string[] types_allowed: string[]
} }

View File

@ -55,7 +55,7 @@ interface GetSourceRequest extends <<RequestBase>> {
realtime?: boolean realtime?: boolean
refresh?: boolean refresh?: boolean
routing?: <<Routing>> routing?: <<Routing>>
_source?: SearchSourceConfigParam _source?: <<SearchSourceConfigParam>>
_source_excludes?: <<Fields>> _source_excludes?: <<Fields>>
_source_includes?: <<Fields>> _source_includes?: <<Fields>>
stored_fields?: <<Fields>> stored_fields?: <<Fields>>

View File

@ -52,10 +52,10 @@ interface GraphExploreRequest extends <<RequestBase>> {
index: <<Indices>> index: <<Indices>>
routing?: <<Routing>> routing?: <<Routing>>
timeout?: <<Duration>> timeout?: <<Duration>>
connections?: GraphHop connections?: <<GraphHop>>
controls?: GraphExploreControls controls?: <<GraphExploreControls>>
query?: <<QueryDslQueryContainer>> query?: <<QueryDslQueryContainer>>
vertices?: GraphVertexDefinition[] vertices?: <<GraphVertexDefinition>>[]
} }
[pass] [pass]
@ -70,11 +70,11 @@ interface GraphExploreRequest extends <<RequestBase>> {
<pre> <pre>
++++ ++++
interface GraphExploreResponse { interface GraphExploreResponse {
connections: GraphConnection[] connections: <<GraphConnection>>[]
failures: <<ShardFailure>>[] failures: <<ShardFailure>>[]
timed_out: boolean timed_out: boolean
took: <<long>> took: <<long>>
vertices: GraphVertex[] vertices: <<GraphVertex>>[]
} }
[pass] [pass]

View File

@ -68,8 +68,8 @@ interface HealthReportRequest extends <<RequestBase>> {
++++ ++++
interface HealthReportResponse { interface HealthReportResponse {
cluster_name: string cluster_name: string
indicators: HealthReportIndicators indicators: <<HealthReportIndicators>>
status?: HealthReportIndicatorHealthStatus status?: <<HealthReportIndicatorHealthStatus>>
} }
[pass] [pass]

View File

@ -52,7 +52,7 @@ interface IlmPutLifecycleRequest extends <<RequestBase>> {
name: <<Name>> name: <<Name>>
master_timeout?: <<Duration>> master_timeout?: <<Duration>>
timeout?: <<Duration>> timeout?: <<Duration>>
policy?: IlmPolicy policy?: <<IlmPolicy>>
} }
[pass] [pass]

View File

@ -54,7 +54,7 @@ interface IndicesCloneRequest extends <<RequestBase>> {
master_timeout?: <<Duration>> master_timeout?: <<Duration>>
timeout?: <<Duration>> timeout?: <<Duration>>
wait_for_active_shards?: <<WaitForActiveShards>> wait_for_active_shards?: <<WaitForActiveShards>>
aliases?: Record<<<IndexName>>, IndicesAlias> aliases?: Record<<<IndexName>>, <<IndicesAlias>>>
settings?: Record<string, any> settings?: Record<string, any>
} }

View File

@ -53,9 +53,9 @@ interface IndicesCreateRequest extends <<RequestBase>> {
master_timeout?: <<Duration>> master_timeout?: <<Duration>>
timeout?: <<Duration>> timeout?: <<Duration>>
wait_for_active_shards?: <<WaitForActiveShards>> wait_for_active_shards?: <<WaitForActiveShards>>
aliases?: Record<<<Name>>, IndicesAlias> aliases?: Record<<<Name>>, <<IndicesAlias>>>
mappings?: <<MappingTypeMapping>> mappings?: <<MappingTypeMapping>>
settings?: IndicesIndexSettings settings?: <<IndicesIndexSettings>>
} }
[pass] [pass]

View File

@ -51,7 +51,7 @@ Aggregates a time series (TSDS) index and stores pre-computed statistical summar
interface IndicesDownsampleRequest extends <<RequestBase>> { interface IndicesDownsampleRequest extends <<RequestBase>> {
index: <<IndexName>> index: <<IndexName>>
target_index: <<IndexName>> target_index: <<IndexName>>
config?: IndicesDownsampleConfig config?: <<IndicesDownsampleConfig>>
} }
[pass] [pass]

View File

@ -71,7 +71,7 @@ interface IndicesGetRequest extends <<RequestBase>> {
++++ ++++
<pre> <pre>
++++ ++++
type IndicesGetResponse = Record<<<IndexName>>, IndicesIndexState> type IndicesGetResponse = Record<<<IndexName>>, <<IndicesIndexState>>>
[pass] [pass]
++++ ++++

View File

@ -68,7 +68,7 @@ interface IndicesGetDataStreamRequest extends <<RequestBase>> {
<pre> <pre>
++++ ++++
interface IndicesGetDataStreamResponse { interface IndicesGetDataStreamResponse {
data_streams: IndicesDataStream[] data_streams: <<IndicesDataStream>>[]
} }
[pass] [pass]

View File

@ -71,7 +71,7 @@ interface IndicesGetSettingsRequest extends <<RequestBase>> {
++++ ++++
<pre> <pre>
++++ ++++
type IndicesGetSettingsResponse = Record<<<IndexName>>, IndicesIndexState> type IndicesGetSettingsResponse = Record<<<IndexName>>, <<IndicesIndexState>>>
[pass] [pass]
++++ ++++

View File

@ -66,7 +66,7 @@ interface IndicesGetTemplateRequest extends <<RequestBase>> {
++++ ++++
<pre> <pre>
++++ ++++
type IndicesGetTemplateResponse = Record<string, IndicesTemplateMapping> type IndicesGetTemplateResponse = Record<string, <<IndicesTemplateMapping>>>
[pass] [pass]
++++ ++++

View File

@ -54,7 +54,7 @@ interface IndicesPutDataLifecycleRequest extends <<RequestBase>> {
master_timeout?: <<Duration>> master_timeout?: <<Duration>>
timeout?: <<Duration>> timeout?: <<Duration>>
data_retention?: <<Duration>> data_retention?: <<Duration>>
downsampling?: IndicesDataStreamLifecycleDownsampling downsampling?: <<IndicesDataStreamLifecycleDownsampling>>
} }
[pass] [pass]

View File

@ -56,7 +56,7 @@ interface IndicesPutIndexTemplateRequest extends <<RequestBase>> {
index_patterns?: <<Indices>> index_patterns?: <<Indices>>
composed_of?: <<Name>>[] composed_of?: <<Name>>[]
template?: IndicesPutIndexTemplateIndexTemplateMapping template?: IndicesPutIndexTemplateIndexTemplateMapping
data_stream?: IndicesDataStreamVisibility data_stream?: <<IndicesDataStreamVisibility>>
priority?: <<long>> priority?: <<long>>
version?: <<VersionNumber>> version?: <<VersionNumber>>
_meta?: <<Metadata>> _meta?: <<Metadata>>

View File

@ -57,7 +57,7 @@ interface IndicesPutSettingsRequest extends <<RequestBase>> {
master_timeout?: <<Duration>> master_timeout?: <<Duration>>
preserve_existing?: boolean preserve_existing?: boolean
timeout?: <<Duration>> timeout?: <<Duration>>
settings?: IndicesIndexSettings settings?: <<IndicesIndexSettings>>
} }
[pass] [pass]

View File

@ -53,11 +53,11 @@ interface IndicesPutTemplateRequest extends <<RequestBase>> {
create?: boolean create?: boolean
master_timeout?: <<Duration>> master_timeout?: <<Duration>>
cause?: string cause?: string
aliases?: Record<<<IndexName>>, IndicesAlias> aliases?: Record<<<IndexName>>, <<IndicesAlias>>>
index_patterns?: string | string[] index_patterns?: string | string[]
mappings?: <<MappingTypeMapping>> mappings?: <<MappingTypeMapping>>
order?: <<integer>> order?: <<integer>>
settings?: IndicesIndexSettings settings?: <<IndicesIndexSettings>>
version?: <<VersionNumber>> version?: <<VersionNumber>>
} }

View File

@ -55,7 +55,7 @@ interface IndicesRolloverRequest extends <<RequestBase>> {
master_timeout?: <<Duration>> master_timeout?: <<Duration>>
timeout?: <<Duration>> timeout?: <<Duration>>
wait_for_active_shards?: <<WaitForActiveShards>> wait_for_active_shards?: <<WaitForActiveShards>>
aliases?: Record<<<IndexName>>, IndicesAlias> aliases?: Record<<<IndexName>>, <<IndicesAlias>>>
conditions?: IndicesRolloverRolloverConditions conditions?: IndicesRolloverRolloverConditions
mappings?: <<MappingTypeMapping>> mappings?: <<MappingTypeMapping>>
settings?: Record<string, any> settings?: Record<string, any>

View File

@ -54,7 +54,7 @@ interface IndicesShrinkRequest extends <<RequestBase>> {
master_timeout?: <<Duration>> master_timeout?: <<Duration>>
timeout?: <<Duration>> timeout?: <<Duration>>
wait_for_active_shards?: <<WaitForActiveShards>> wait_for_active_shards?: <<WaitForActiveShards>>
aliases?: Record<<<IndexName>>, IndicesAlias> aliases?: Record<<<IndexName>>, <<IndicesAlias>>>
settings?: Record<string, any> settings?: Record<string, any>
} }

View File

@ -57,7 +57,7 @@ interface IndicesSimulateTemplateRequest extends <<RequestBase>> {
index_patterns?: <<Indices>> index_patterns?: <<Indices>>
composed_of?: <<Name>>[] composed_of?: <<Name>>[]
template?: IndicesPutIndexTemplateIndexTemplateMapping template?: IndicesPutIndexTemplateIndexTemplateMapping
data_stream?: IndicesDataStreamVisibility data_stream?: <<IndicesDataStreamVisibility>>
priority?: <<long>> priority?: <<long>>
version?: <<VersionNumber>> version?: <<VersionNumber>>
_meta?: <<Metadata>> _meta?: <<Metadata>>

View File

@ -54,7 +54,7 @@ interface IndicesSplitRequest extends <<RequestBase>> {
master_timeout?: <<Duration>> master_timeout?: <<Duration>>
timeout?: <<Duration>> timeout?: <<Duration>>
wait_for_active_shards?: <<WaitForActiveShards>> wait_for_active_shards?: <<WaitForActiveShards>>
aliases?: Record<<<IndexName>>, IndicesAlias> aliases?: Record<<<IndexName>>, <<IndicesAlias>>>
settings?: Record<string, any> settings?: Record<string, any>
} }

View File

@ -49,7 +49,7 @@ Delete an inference endpoint
<pre> <pre>
++++ ++++
interface InferenceDeleteRequest extends <<RequestBase>> { interface InferenceDeleteRequest extends <<RequestBase>> {
task_type?: InferenceTaskType task_type?: <<InferenceTaskType>>
inference_id: <<Id>> inference_id: <<Id>>
dry_run?: boolean dry_run?: boolean
force?: boolean force?: boolean
@ -66,7 +66,7 @@ interface InferenceDeleteRequest extends <<RequestBase>> {
++++ ++++
<pre> <pre>
++++ ++++
type InferenceDeleteResponse = InferenceDeleteInferenceEndpointResult type InferenceDeleteResponse = <<InferenceDeleteInferenceEndpointResult>>
[pass] [pass]
++++ ++++

View File

@ -49,7 +49,7 @@ Get an inference endpoint
<pre> <pre>
++++ ++++
interface InferenceGetRequest extends <<RequestBase>> { interface InferenceGetRequest extends <<RequestBase>> {
task_type?: InferenceTaskType task_type?: <<InferenceTaskType>>
inference_id?: <<Id>> inference_id?: <<Id>>
} }
@ -65,7 +65,7 @@ interface InferenceGetRequest extends <<RequestBase>> {
<pre> <pre>
++++ ++++
interface InferenceGetResponse { interface InferenceGetResponse {
endpoints: InferenceInferenceEndpointInfo[] endpoints: <<InferenceInferenceEndpointInfo>>[]
} }
[pass] [pass]

View File

@ -49,12 +49,12 @@ Perform inference on the service
<pre> <pre>
++++ ++++
interface InferenceInferenceRequest extends <<RequestBase>> { interface InferenceInferenceRequest extends <<RequestBase>> {
task_type?: InferenceTaskType task_type?: <<InferenceTaskType>>
inference_id: <<Id>> inference_id: <<Id>>
timeout?: <<Duration>> timeout?: <<Duration>>
query?: string query?: string
input: string | string[] input: string | string[]
task_settings?: InferenceTaskSettings task_settings?: <<InferenceTaskSettings>>
} }
[pass] [pass]
@ -68,7 +68,7 @@ interface InferenceInferenceRequest extends <<RequestBase>> {
++++ ++++
<pre> <pre>
++++ ++++
type InferenceInferenceResponse = InferenceInferenceResult type InferenceInferenceResponse = <<InferenceInferenceResult>>
[pass] [pass]
++++ ++++

View File

@ -49,9 +49,9 @@ Create an inference endpoint
<pre> <pre>
++++ ++++
interface InferencePutRequest extends <<RequestBase>> { interface InferencePutRequest extends <<RequestBase>> {
task_type?: InferenceTaskType task_type?: <<InferenceTaskType>>
inference_id: <<Id>> inference_id: <<Id>>
inference_config?: InferenceInferenceEndpoint inference_config?: <<InferenceInferenceEndpoint>>
} }
[pass] [pass]
@ -65,7 +65,7 @@ interface InferencePutRequest extends <<RequestBase>> {
++++ ++++
<pre> <pre>
++++ ++++
type InferencePutResponse = InferenceInferenceEndpointInfo type InferencePutResponse = <<InferenceInferenceEndpointInfo>>
[pass] [pass]
++++ ++++

View File

@ -65,7 +65,7 @@ interface IngestGetPipelineRequest extends <<RequestBase>> {
++++ ++++
<pre> <pre>
++++ ++++
type IngestGetPipelineResponse = Record<string, IngestPipeline> type IngestGetPipelineResponse = Record<string, <<IngestPipeline>>>
[pass] [pass]
++++ ++++

View File

@ -53,7 +53,7 @@ interface IngestPutGeoipDatabaseRequest extends <<RequestBase>> {
master_timeout?: <<Duration>> master_timeout?: <<Duration>>
timeout?: <<Duration>> timeout?: <<Duration>>
name: <<Name>> name: <<Name>>
maxmind: IngestMaxmind maxmind: <<IngestMaxmind>>
} }
[pass] [pass]

View File

@ -55,8 +55,8 @@ interface IngestPutPipelineRequest extends <<RequestBase>> {
if_version?: <<VersionNumber>> if_version?: <<VersionNumber>>
_meta?: <<Metadata>> _meta?: <<Metadata>>
description?: string description?: string
on_failure?: IngestProcessorContainer[] on_failure?: <<IngestProcessorContainer>>[]
processors?: IngestProcessorContainer[] processors?: <<IngestProcessorContainer>>[]
version?: <<VersionNumber>> version?: <<VersionNumber>>
deprecated?: boolean deprecated?: boolean
} }

View File

@ -52,7 +52,7 @@ interface IngestSimulateRequest extends <<RequestBase>> {
id?: <<Id>> id?: <<Id>>
verbose?: boolean verbose?: boolean
docs: IngestSimulateDocument[] docs: IngestSimulateDocument[]
pipeline?: IngestPipeline pipeline?: <<IngestPipeline>>
} }
[pass] [pass]

View File

@ -51,12 +51,12 @@ Run a knn search. NOTE: The kNN search API has been replaced by the `knn` option
interface KnnSearchRequest extends <<RequestBase>> { interface KnnSearchRequest extends <<RequestBase>> {
index: <<Indices>> index: <<Indices>>
routing?: <<Routing>> routing?: <<Routing>>
_source?: SearchSourceConfig _source?: <<SearchSourceConfig>>
docvalue_fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[] docvalue_fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[]
stored_fields?: <<Fields>> stored_fields?: <<Fields>>
fields?: <<Fields>> fields?: <<Fields>>
filter?: <<QueryDslQueryContainer>> | <<QueryDslQueryContainer>>[] filter?: <<QueryDslQueryContainer>> | <<QueryDslQueryContainer>>[]
knn: KnnSearchQuery knn: <<KnnSearchQuery>>
} }
[pass] [pass]
@ -74,7 +74,7 @@ interface KnnSearchResponse<TDocument = unknown> {
took: <<long>> took: <<long>>
timed_out: boolean timed_out: boolean
_shards: <<ShardStatistics>> _shards: <<ShardStatistics>>
hits: SearchHitsMetadata<TDocument> hits: <<SearchHitsMetadata>><TDocument>
fields?: Record<string, any> fields?: Record<string, any>
max_score?: <<double>> max_score?: <<double>>
} }

View File

@ -50,8 +50,8 @@ Updates the license for the cluster.
++++ ++++
interface LicensePostRequest extends <<RequestBase>> { interface LicensePostRequest extends <<RequestBase>> {
acknowledge?: boolean acknowledge?: boolean
license?: LicenseLicense license?: <<LicenseLicense>>
licenses?: LicenseLicense[] licenses?: <<LicenseLicense>>[]
} }
[pass] [pass]
@ -68,7 +68,7 @@ interface LicensePostRequest extends <<RequestBase>> {
interface LicensePostResponse { interface LicensePostResponse {
acknowledge?: LicensePostAcknowledgement acknowledge?: LicensePostAcknowledgement
acknowledged: boolean acknowledged: boolean
license_status: LicenseLicenseStatus license_status: <<LicenseLicenseStatus>>
} }
[pass] [pass]

View File

@ -67,7 +67,7 @@ interface LicensePostStartBasicResponse {
acknowledged: boolean acknowledged: boolean
basic_was_started: boolean basic_was_started: boolean
error_message?: string error_message?: string
type?: LicenseLicenseType type?: <<LicenseLicenseType>>
acknowledge?: Record<string, string | string[]> acknowledge?: Record<string, string | string[]>
} }

View File

@ -68,7 +68,7 @@ interface LicensePostStartTrialResponse {
acknowledged: boolean acknowledged: boolean
error_message?: string error_message?: string
trial_was_started: boolean trial_was_started: boolean
type?: LicenseLicenseType type?: <<LicenseLicenseType>>
} }
[pass] [pass]

View File

@ -63,7 +63,7 @@ interface LogstashGetPipelineRequest extends <<RequestBase>> {
++++ ++++
<pre> <pre>
++++ ++++
type LogstashGetPipelineResponse = Record<<<Id>>, LogstashPipeline> type LogstashGetPipelineResponse = Record<<<Id>>, <<LogstashPipeline>>>
[pass] [pass]
++++ ++++

View File

@ -50,7 +50,7 @@ Creates or updates a pipeline used for Logstash Central Management.
++++ ++++
interface LogstashPutPipelineRequest extends <<RequestBase>> { interface LogstashPutPipelineRequest extends <<RequestBase>> {
id: <<Id>> id: <<Id>>
pipeline?: LogstashPipeline pipeline?: <<LogstashPipeline>>
} }
[pass] [pass]

View File

@ -529,6 +529,89 @@ include::reference-watcher-stop.asciidoc[]
include::reference-watcher-update_settings.asciidoc[] include::reference-watcher-update_settings.asciidoc[]
include::reference-xpack-info.asciidoc[] include::reference-xpack-info.asciidoc[]
include::reference-xpack-usage.asciidoc[] include::reference-xpack-usage.asciidoc[]
include::reference-shared-types-_global.asciidoc[]
include::reference-shared-types-_global.asciidoc[]
include::reference-shared-types-_global.asciidoc[]
include::reference-shared-types-async_search.asciidoc[]
include::reference-shared-types-autoscaling.asciidoc[]
include::reference-shared-types-cat.asciidoc[]
include::reference-shared-types-ccr.asciidoc[]
include::reference-shared-types-cluster.asciidoc[]
include::reference-shared-types-connector.asciidoc[]
include::reference-shared-types-enrich.asciidoc[]
include::reference-shared-types-eql.asciidoc[]
include::reference-shared-types-esql.asciidoc[]
include::reference-shared-types-features.asciidoc[]
include::reference-shared-types-fleet.asciidoc[]
include::reference-shared-types-graph.asciidoc[]
include::reference-shared-types-ilm.asciidoc[]
include::reference-shared-types-indices.asciidoc[]
include::reference-shared-types-indices.asciidoc[]
include::reference-shared-types-inference.asciidoc[]
include::reference-shared-types-ingest.asciidoc[]
include::reference-shared-types-license.asciidoc[]
include::reference-shared-types-logstash.asciidoc[]
include::reference-shared-types-ml.asciidoc[]
include::reference-shared-types-nodes.asciidoc[]
include::reference-shared-types-query_rules.asciidoc[]
include::reference-shared-types-rollup.asciidoc[]
include::reference-shared-types-search_application.asciidoc[]
include::reference-shared-types-searchable_snapshots.asciidoc[]
include::reference-shared-types-security.asciidoc[]
include::reference-shared-types-shutdown.asciidoc[]
include::reference-shared-types-slm.asciidoc[]
include::reference-shared-types-snapshot.asciidoc[]
include::reference-shared-types-synonyms.asciidoc[]
include::reference-shared-types-tasks.asciidoc[]
include::reference-shared-types-transform.asciidoc[]
include::reference-shared-types-watcher.asciidoc[]
include::reference-shared-types-bulk.asciidoc[]
include::reference-shared-types-clear_scroll.asciidoc[]
include::reference-shared-types-close_point_in_time.asciidoc[]
include::reference-shared-types-count.asciidoc[]
include::reference-shared-types-create.asciidoc[]
include::reference-shared-types-delete.asciidoc[]
include::reference-shared-types-delete_by_query.asciidoc[]
include::reference-shared-types-delete_by_query_rethrottle.asciidoc[]
include::reference-shared-types-delete_script.asciidoc[]
include::reference-shared-types-exists.asciidoc[]
include::reference-shared-types-exists_source.asciidoc[]
include::reference-shared-types-explain.asciidoc[]
include::reference-shared-types-field_caps.asciidoc[]
include::reference-shared-types-get.asciidoc[]
include::reference-shared-types-get_script.asciidoc[]
include::reference-shared-types-get_script_context.asciidoc[]
include::reference-shared-types-get_script_languages.asciidoc[]
include::reference-shared-types-get_source.asciidoc[]
include::reference-shared-types-health_report.asciidoc[]
include::reference-shared-types-index.asciidoc[]
include::reference-shared-types-info.asciidoc[]
include::reference-shared-types-knn_search.asciidoc[]
include::reference-shared-types-knn_search.asciidoc[]
include::reference-shared-types-mget.asciidoc[]
include::reference-shared-types-msearch.asciidoc[]
include::reference-shared-types-msearch_template.asciidoc[]
include::reference-shared-types-mtermvectors.asciidoc[]
include::reference-shared-types-open_point_in_time.asciidoc[]
include::reference-shared-types-ping.asciidoc[]
include::reference-shared-types-put_script.asciidoc[]
include::reference-shared-types-rank_eval.asciidoc[]
include::reference-shared-types-reindex.asciidoc[]
include::reference-shared-types-reindex_rethrottle.asciidoc[]
include::reference-shared-types-render_search_template.asciidoc[]
include::reference-shared-types-scripts_painless_execute.asciidoc[]
include::reference-shared-types-scroll.asciidoc[]
include::reference-shared-types-search.asciidoc[]
include::reference-shared-types-search.asciidoc[]
include::reference-shared-types-search_mvt.asciidoc[]
include::reference-shared-types-search_mvt.asciidoc[]
include::reference-shared-types-search_shards.asciidoc[]
include::reference-shared-types-search_template.asciidoc[]
include::reference-shared-types-terms_enum.asciidoc[]
include::reference-shared-types-termvectors.asciidoc[]
include::reference-shared-types-update.asciidoc[]
include::reference-shared-types-update_by_query.asciidoc[]
include::reference-shared-types-update_by_query_rethrottle.asciidoc[]
* <<client.asyncSearch.delete>> * <<client.asyncSearch.delete>>

View File

@ -55,11 +55,11 @@ interface MgetRequest extends <<RequestBase>> {
realtime?: boolean realtime?: boolean
refresh?: boolean refresh?: boolean
routing?: <<Routing>> routing?: <<Routing>>
_source?: SearchSourceConfigParam _source?: <<SearchSourceConfigParam>>
_source_excludes?: <<Fields>> _source_excludes?: <<Fields>>
_source_includes?: <<Fields>> _source_includes?: <<Fields>>
stored_fields?: <<Fields>> stored_fields?: <<Fields>>
docs?: MgetOperation[] docs?: <<MgetOperation>>[]
ids?: <<Ids>> ids?: <<Ids>>
} }
@ -75,7 +75,7 @@ interface MgetRequest extends <<RequestBase>> {
<pre> <pre>
++++ ++++
interface MgetResponse<TDocument = unknown> { interface MgetResponse<TDocument = unknown> {
docs: MgetResponseItem<TDocument>[] docs: <<MgetResponseItem>><TDocument>[]
} }
[pass] [pass]

View File

@ -49,7 +49,7 @@ Estimate job model memory usage. Makes an estimation of the memory usage for an
<pre> <pre>
++++ ++++
interface MlEstimateModelMemoryRequest extends <<RequestBase>> { interface MlEstimateModelMemoryRequest extends <<RequestBase>> {
analysis_config?: MlAnalysisConfig analysis_config?: <<MlAnalysisConfig>>
max_bucket_cardinality?: Record<<<Field>>, <<long>>> max_bucket_cardinality?: Record<<<Field>>, <<long>>>
overall_cardinality?: Record<<<Field>>, <<long>>> overall_cardinality?: Record<<<Field>>, <<long>>>
} }

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