More type definitions, with fixed links (hopefully)

elastic · Nov 20, 2024 · f75147a · f75147a
1 parent 3b5784a
commit f75147a
Show file tree

Hide file tree

Showing 296 changed files with 23,864 additions and 474 deletions.
diff --git a/docs/reference-async_search-get.asciidoc b/docs/reference-async_search-get.asciidoc
@@ -66,7 +66,7 @@ interface AsyncSearchGetRequest extends <<RequestBase>> {
 ++++
 <pre>
 ++++
-type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
+type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = <<AsyncSearchAsyncSearchDocumentResponseBase>><TDocument, TAggregations>
 
 [pass]
 ++++

diff --git a/docs/reference-async_search-submit.asciidoc b/docs/reference-async_search-submit.asciidoc
@@ -85,35 +85,35 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
   aggregations?: Record<string, <<AggregationsAggregationContainer>>>
   pass:[/**] @alias aggregations */
   aggs?: Record<string, <<AggregationsAggregationContainer>>>
-  collapse?: SearchFieldCollapse
+  collapse?: <<SearchFieldCollapse>>
   explain?: boolean
   ext?: Record<string, any>
   from?: <<integer>>
-  highlight?: SearchHighlight
-  track_total_hits?: SearchTrackHits
+  highlight?: <<SearchHighlight>>
+  track_total_hits?: <<SearchTrackHits>>
   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[]
+  rescore?: <<SearchRescore>> | <<SearchRescore>>[]
   script_fields?: Record<string, <<ScriptField>>>
   search_after?: <<SortResults>>
   size?: <<integer>>
   slice?: <<SlicedScroll>>
   sort?: <<Sort>>
-  _source?: SearchSourceConfig
+  _source?: <<SearchSourceConfig>>
   fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[]
-  suggest?: SearchSuggester
+  suggest?: <<SearchSuggester>>
   terminate_after?: <<long>>
   timeout?: string
   track_scores?: boolean
   version?: boolean
   seq_no_primary_term?: boolean
   stored_fields?: <<Fields>>
-  pit?: SearchPointInTimeReference
+  pit?: <<SearchPointInTimeReference>>
   runtime_mappings?: <<MappingRuntimeFields>>
   stats?: string[]
 }
@@ -129,7 +129,7 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
 ++++
 <pre>
 ++++
-type AsyncSearchSubmitResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
+type AsyncSearchSubmitResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = <<AsyncSearchAsyncSearchDocumentResponseBase>><TDocument, TAggregations>
 
 [pass]
 ++++

diff --git a/docs/reference-autoscaling-get_autoscaling_policy.asciidoc b/docs/reference-autoscaling-get_autoscaling_policy.asciidoc
@@ -63,7 +63,7 @@ interface AutoscalingGetAutoscalingPolicyRequest extends <<RequestBase>> {
 ++++
 <pre>
 ++++
-type AutoscalingGetAutoscalingPolicyResponse = AutoscalingAutoscalingPolicy
+type AutoscalingGetAutoscalingPolicyResponse = <<AutoscalingAutoscalingPolicy>>
 
 [pass]
 ++++

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

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

diff --git a/docs/reference-cat-aliases.asciidoc b/docs/reference-cat-aliases.asciidoc
@@ -48,7 +48,7 @@ Get aliases. Retrieves the cluster’s index aliases, including filter and routi
 ++++
 <pre>
 ++++
-interface CatAliasesRequest extends CatCatRequestBase {
+interface CatAliasesRequest extends <<CatCatRequestBase>> {
   name?: <<Names>>
   expand_wildcards?: <<ExpandWildcards>>
 }

diff --git a/docs/reference-cat-allocation.asciidoc b/docs/reference-cat-allocation.asciidoc
@@ -48,7 +48,7 @@ Provides a snapshot of the number of shards allocated to each data node and thei
 ++++
 <pre>
 ++++
-interface CatAllocationRequest extends CatCatRequestBase {
+interface CatAllocationRequest extends <<CatCatRequestBase>> {
   node_id?: <<NodeIds>>
   bytes?: <<Bytes>>
 }

diff --git a/docs/reference-cat-component_templates.asciidoc b/docs/reference-cat-component_templates.asciidoc
@@ -48,7 +48,7 @@ Get component templates. Returns information about component templates in a clus
 ++++
 <pre>
 ++++
-interface CatComponentTemplatesRequest extends CatCatRequestBase {
+interface CatComponentTemplatesRequest extends <<CatCatRequestBase>> {
   name?: string
 }
 

diff --git a/docs/reference-cat-count.asciidoc b/docs/reference-cat-count.asciidoc
@@ -48,7 +48,7 @@ Get a document count. Provides quick access to a document count for a data strea
 ++++
 <pre>
 ++++
-interface CatCountRequest extends CatCatRequestBase {
+interface CatCountRequest extends <<CatCatRequestBase>> {
   index?: <<Indices>>
 }
 

diff --git a/docs/reference-cat-fielddata.asciidoc b/docs/reference-cat-fielddata.asciidoc
@@ -48,7 +48,7 @@ Returns the amount of heap memory currently used by the field data cache on ever
 ++++
 <pre>
 ++++
-interface CatFielddataRequest extends CatCatRequestBase {
+interface CatFielddataRequest extends <<CatCatRequestBase>> {
   fields?: <<Fields>>
   bytes?: <<Bytes>>
 }

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

diff --git a/docs/reference-cat-help.asciidoc b/docs/reference-cat-help.asciidoc
@@ -48,7 +48,7 @@ Get CAT help. Returns help for the CAT APIs.
 ++++
 <pre>
 ++++
-interface CatHelpRequest extends CatCatRequestBase {
+interface CatHelpRequest extends <<CatCatRequestBase>> {
 }
 
 [pass]

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

diff --git a/docs/reference-cat-master.asciidoc b/docs/reference-cat-master.asciidoc
@@ -48,7 +48,7 @@ Returns information about the master node, including the ID, bound IP address, a
 ++++
 <pre>
 ++++
-interface CatMasterRequest extends CatCatRequestBase {
+interface CatMasterRequest extends <<CatCatRequestBase>> {
 }
 
 [pass]

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

diff --git a/docs/reference-cat-ml_datafeeds.asciidoc b/docs/reference-cat-ml_datafeeds.asciidoc
@@ -48,11 +48,11 @@ Get datafeeds. Returns configuration and usage information about datafeeds. This
 ++++
 <pre>
 ++++
-interface CatMlDatafeedsRequest extends CatCatRequestBase {
+interface CatMlDatafeedsRequest extends <<CatCatRequestBase>> {
   datafeed_id?: <<Id>>
   allow_no_match?: boolean
-  h?: CatCatDatafeedColumns
-  s?: CatCatDatafeedColumns
+  h?: <<CatCatDatafeedColumns>>
+  s?: <<CatCatDatafeedColumns>>
   time?: <<TimeUnit>>
 }
 

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

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

diff --git a/docs/reference-cat-nodeattrs.asciidoc b/docs/reference-cat-nodeattrs.asciidoc
@@ -48,7 +48,7 @@ Returns information about custom node attributes. IMPORTANT: cat APIs are only i
 ++++
 <pre>
 ++++
-interface CatNodeattrsRequest extends CatCatRequestBase {
+interface CatNodeattrsRequest extends <<CatCatRequestBase>> {
 }
 
 [pass]

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

diff --git a/docs/reference-cat-pending_tasks.asciidoc b/docs/reference-cat-pending_tasks.asciidoc
@@ -48,7 +48,7 @@ Returns cluster-level changes that have not yet been executed. IMPORTANT: cat AP
 ++++
 <pre>
 ++++
-interface CatPendingTasksRequest extends CatCatRequestBase {
+interface CatPendingTasksRequest extends <<CatCatRequestBase>> {
 }
 
 [pass]

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

diff --git a/docs/reference-cat-recovery.asciidoc b/docs/reference-cat-recovery.asciidoc
@@ -48,7 +48,7 @@ Returns information about ongoing and completed shard recoveries. Shard recovery
 ++++
 <pre>
 ++++
-interface CatRecoveryRequest extends CatCatRequestBase {
+interface CatRecoveryRequest extends <<CatCatRequestBase>> {
   index?: <<Indices>>
   active_only?: boolean
   bytes?: <<Bytes>>

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

diff --git a/docs/reference-cat-segments.asciidoc b/docs/reference-cat-segments.asciidoc
@@ -48,7 +48,7 @@ Returns low-level information about the Lucene segments in index shards. For dat
 ++++
 <pre>
 ++++
-interface CatSegmentsRequest extends CatCatRequestBase {
+interface CatSegmentsRequest extends <<CatCatRequestBase>> {
   index?: <<Indices>>
   bytes?: <<Bytes>>
 }

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

diff --git a/docs/reference-cat-snapshots.asciidoc b/docs/reference-cat-snapshots.asciidoc
@@ -48,7 +48,7 @@ Returns information about the snapshots stored in one or more repositories. A sn
 ++++
 <pre>
 ++++
-interface CatSnapshotsRequest extends CatCatRequestBase {
+interface CatSnapshotsRequest extends <<CatCatRequestBase>> {
   repository?: <<Names>>
   ignore_unavailable?: boolean
 }

diff --git a/docs/reference-cat-tasks.asciidoc b/docs/reference-cat-tasks.asciidoc
@@ -48,7 +48,7 @@ Returns information about tasks currently executing in the cluster. IMPORTANT: c
 ++++
 <pre>
 ++++
-interface CatTasksRequest extends CatCatRequestBase {
+interface CatTasksRequest extends <<CatCatRequestBase>> {
   actions?: string[]
   detailed?: boolean
   node_id?: string[]

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

diff --git a/docs/reference-cat-thread_pool.asciidoc b/docs/reference-cat-thread_pool.asciidoc
@@ -48,7 +48,7 @@ Returns thread pool statistics for each node in a cluster. Returned information
 ++++
 <pre>
 ++++
-interface CatThreadPoolRequest extends CatCatRequestBase {
+interface CatThreadPoolRequest extends <<CatCatRequestBase>> {
   thread_pool_patterns?: <<Names>>
   time?: <<TimeUnit>>
 }

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

diff --git a/docs/reference-ccr-follow_stats.asciidoc b/docs/reference-ccr-follow_stats.asciidoc
@@ -64,7 +64,7 @@ interface CcrFollowStatsRequest extends <<RequestBase>> {
 <pre>
 ++++
 interface CcrFollowStatsResponse {
-  indices: CcrFollowIndexStats[]
+  indices: <<CcrFollowIndexStats>>[]
 }
 
 [pass]

diff --git a/docs/reference-cluster-get_component_template.asciidoc b/docs/reference-cluster-get_component_template.asciidoc
@@ -68,7 +68,7 @@ interface ClusterGetComponentTemplateRequest extends <<RequestBase>> {
 <pre>
 ++++
 interface ClusterGetComponentTemplateResponse {
-  component_templates: ClusterComponentTemplate[]
+  component_templates: <<ClusterComponentTemplate>>[]
 }
 
 [pass]
-Original file line number
+Diff line change
@@ Expand Up / @@ -66,7 +66,7 @@ interface AsyncSearchGetRequest extends <<RequestBase>> { @@
     ++++
     <pre>
     ++++
-    type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
+    type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = <<AsyncSearchAsyncSearchDocumentResponseBase>><TDocument, TAggregations>
     [pass]
     ++++
@@ Expand Down @@