Use section headers for shared types

elastic · Nov 19, 2024 · 57b6b65 · 57b6b65
1 parent 8499edb
commit 57b6b65
Show file tree

Hide file tree

Showing 469 changed files with 2,639 additions and 2,850 deletions.
diff --git a/docs/reference-async_search-delete.asciidoc b/docs/reference-async_search-delete.asciidoc
@@ -45,8 +45,8 @@ Delete an async search. If the asynchronous search is still running, it is cance
 
 [source,ts]
 ----
-interface AsyncSearchDeleteRequest extends <<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>>
 ----
 
diff --git a/docs/reference-async_search-get.asciidoc b/docs/reference-async_search-get.asciidoc
@@ -45,11 +45,11 @@ Get async search results. Retrieve the results of a previously submitted asynchr
 
 [source,ts]
 ----
-interface AsyncSearchGetRequest extends <<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>
 ----
 
diff --git a/docs/reference-async_search-status.asciidoc b/docs/reference-async_search-status.asciidoc
@@ -45,8 +45,8 @@ Get the async search status. Get the status of a previously submitted async sear
 
 [source,ts]
 ----
-interface AsyncSearchStatusRequest extends <<shared-type-request-base, RequestBase>> {
-  id: <<shared-type-id, Id>>
+interface AsyncSearchStatusRequest extends <<RequestBase>> {
+  id: <<Id>>
 }
 ----
 

diff --git a/docs/reference-async_search-submit.asciidoc b/docs/reference-async_search-submit.asciidoc
@@ -45,71 +45,71 @@ 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 */
   aggs?: Record<string, AggregationsAggregationContainer>
   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>
 ----
 
diff --git a/docs/reference-autoscaling-delete_autoscaling_policy.asciidoc b/docs/reference-autoscaling-delete_autoscaling_policy.asciidoc
@@ -45,8 +45,8 @@ Delete an autoscaling policy. NOTE: This feature is designed for indirect use by
 
 [source,ts]
 ----
-interface AutoscalingDeleteAutoscalingPolicyRequest extends <<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>>
 ----
 
diff --git a/docs/reference-autoscaling-get_autoscaling_capacity.asciidoc b/docs/reference-autoscaling-get_autoscaling_capacity.asciidoc
@@ -45,7 +45,7 @@ Get the autoscaling capacity. NOTE: This feature is designed for indirect use by
 
 [source,ts]
 ----
-interface AutoscalingGetAutoscalingCapacityRequest extends <<shared-type-request-base, RequestBase>> {
+interface AutoscalingGetAutoscalingCapacityRequest extends <<RequestBase>> {
 }
 ----
 

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

diff --git a/docs/reference-autoscaling-put_autoscaling_policy.asciidoc b/docs/reference-autoscaling-put_autoscaling_policy.asciidoc
@@ -45,8 +45,8 @@ Create or update an autoscaling policy. NOTE: This feature is designed for indir
 
 [source,ts]
 ----
-interface AutoscalingPutAutoscalingPolicyRequest extends <<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>>
 ----
 
diff --git a/docs/reference-bulk.asciidoc b/docs/reference-bulk.asciidoc
@@ -45,16 +45,16 @@ Bulk index or delete documents. Performs multiple indexing or delete operations
 
 [source,ts]
 ----
-interface BulkRequest<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>>
 }
 ----
 
diff --git a/docs/reference-cat-aliases.asciidoc b/docs/reference-cat-aliases.asciidoc
@@ -46,8 +46,8 @@ Get aliases. Retrieves the cluster’s index aliases, including filter and routi
 [source,ts]
 ----
 interface CatAliasesRequest extends CatCatRequestBase {
-  name?: <<shared-type-names, Names>>
-  expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
+  name?: <<Names>>
+  expand_wildcards?: <<ExpandWildcards>>
 }
 ----
 

diff --git a/docs/reference-cat-allocation.asciidoc b/docs/reference-cat-allocation.asciidoc
@@ -46,8 +46,8 @@ Provides a snapshot of the number of shards allocated to each data node and thei
 [source,ts]
 ----
 interface CatAllocationRequest extends CatCatRequestBase {
-  node_id?: <<shared-type-node-ids, NodeIds>>
-  bytes?: <<shared-type-bytes, Bytes>>
+  node_id?: <<NodeIds>>
+  bytes?: <<Bytes>>
 }
 ----
 

diff --git a/docs/reference-cat-count.asciidoc b/docs/reference-cat-count.asciidoc
@@ -46,7 +46,7 @@ Get a document count. Provides quick access to a document count for a data strea
 [source,ts]
 ----
 interface CatCountRequest extends CatCatRequestBase {
-  index?: <<shared-type-indices, Indices>>
+  index?: <<Indices>>
 }
 ----
 

diff --git a/docs/reference-cat-fielddata.asciidoc b/docs/reference-cat-fielddata.asciidoc
@@ -46,8 +46,8 @@ Returns the amount of heap memory currently used by the field data cache on ever
 [source,ts]
 ----
 interface CatFielddataRequest extends CatCatRequestBase {
-  fields?: <<shared-type-fields, Fields>>
-  bytes?: <<shared-type-bytes, Bytes>>
+  fields?: <<Fields>>
+  bytes?: <<Bytes>>
 }
 ----
 

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

diff --git a/docs/reference-cat-indices.asciidoc b/docs/reference-cat-indices.asciidoc
@@ -46,13 +46,13 @@ Get index information. Returns high-level information about indices in a cluster
 [source,ts]
 ----
 interface CatIndicesRequest extends CatCatRequestBase {
-  index?: <<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>>
 }
 ----
 

diff --git a/docs/reference-cat-ml_data_frame_analytics.asciidoc b/docs/reference-cat-ml_data_frame_analytics.asciidoc
@@ -46,12 +46,12 @@ Get data frame analytics jobs. Returns configuration and usage information about
 [source,ts]
 ----
 interface CatMlDataFrameAnalyticsRequest extends CatCatRequestBase {
-  id?: <<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>>
 }
 ----
 

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

diff --git a/docs/reference-cat-ml_jobs.asciidoc b/docs/reference-cat-ml_jobs.asciidoc
@@ -46,12 +46,12 @@ Get anomaly detection jobs. Returns configuration and usage information for anom
 [source,ts]
 ----
 interface CatMlJobsRequest extends CatCatRequestBase {
-  job_id?: <<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>>
 }
 ----
 

diff --git a/docs/reference-cat-ml_trained_models.asciidoc b/docs/reference-cat-ml_trained_models.asciidoc
@@ -46,13 +46,13 @@ Get trained models. Returns configuration and usage information about inference
 [source,ts]
 ----
 interface CatMlTrainedModelsRequest extends CatCatRequestBase {
-  model_id?: <<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>>
 }
 ----
-Original file line number
+Diff line change
@@ Expand Up @@
     [source,ts]
     ----
-    interface AutoscalingGetAutoscalingCapacityRequest extends <<shared-type-request-base, RequestBase>> {
+    interface AutoscalingGetAutoscalingCapacityRequest extends <<RequestBase>> {
     }
     ----
@@ Expand Down @@