Skip to content

Commit 57b6b65

Browse files
committed
Use section headers for shared types
1 parent 8499edb commit 57b6b65

File tree

469 files changed

+2639
-2850
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

469 files changed

+2639
-2850
lines changed

docs/reference-async_search-delete.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ Delete an async search. If the asynchronous search is still running, it is cance
4545

4646
[source,ts]
4747
----
48-
interface AsyncSearchDeleteRequest extends <<shared-type-request-base, RequestBase>> {
49-
id: <<shared-type-id, Id>>
48+
interface AsyncSearchDeleteRequest extends <<RequestBase>> {
49+
id: <<Id>>
5050
}
5151
----
5252

@@ -55,6 +55,6 @@ interface AsyncSearchDeleteRequest extends <<shared-type-request-base, RequestBa
5555

5656
[source,ts]
5757
----
58-
type AsyncSearchDeleteResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
58+
type AsyncSearchDeleteResponse = <<AcknowledgedResponseBase>>
5959
----
6060

docs/reference-async_search-get.asciidoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ Get async search results. Retrieve the results of a previously submitted asynchr
4545

4646
[source,ts]
4747
----
48-
interface AsyncSearchGetRequest extends <<shared-type-request-base, RequestBase>> {
49-
id: <<shared-type-id, Id>>
50-
keep_alive?: <<shared-type-duration, Duration>>
48+
interface AsyncSearchGetRequest extends <<RequestBase>> {
49+
id: <<Id>>
50+
keep_alive?: <<Duration>>
5151
typed_keys?: boolean
52-
wait_for_completion_timeout?: <<shared-type-duration, Duration>>
52+
wait_for_completion_timeout?: <<Duration>>
5353
}
5454
----
5555

@@ -58,6 +58,6 @@ interface AsyncSearchGetRequest extends <<shared-type-request-base, RequestBase>
5858

5959
[source,ts]
6060
----
61-
type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<<<shared-type-aggregate-name, AggregateName>>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
61+
type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
6262
----
6363

docs/reference-async_search-status.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ Get the async search status. Get the status of a previously submitted async sear
4545

4646
[source,ts]
4747
----
48-
interface AsyncSearchStatusRequest extends <<shared-type-request-base, RequestBase>> {
49-
id: <<shared-type-id, Id>>
48+
interface AsyncSearchStatusRequest extends <<RequestBase>> {
49+
id: <<Id>>
5050
}
5151
----
5252

docs/reference-async_search-submit.asciidoc

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -45,71 +45,71 @@ Run an async search. When the primary sort of the results is an indexed field, s
4545

4646
[source,ts]
4747
----
48-
interface AsyncSearchSubmitRequest extends <<shared-type-request-base, RequestBase>> {
49-
index?: <<shared-type-indices, Indices>>
50-
wait_for_completion_timeout?: <<shared-type-duration, Duration>>
48+
interface AsyncSearchSubmitRequest extends <<RequestBase>> {
49+
index?: <<Indices>>
50+
wait_for_completion_timeout?: <<Duration>>
5151
keep_on_completion?: boolean
52-
keep_alive?: <<shared-type-duration, Duration>>
52+
keep_alive?: <<Duration>>
5353
allow_no_indices?: boolean
5454
allow_partial_search_results?: boolean
5555
analyzer?: string
5656
analyze_wildcard?: boolean
57-
batched_reduce_size?: <<shared-type-long, long>>
57+
batched_reduce_size?: <<long>>
5858
ccs_minimize_roundtrips?: boolean
5959
default_operator?: QueryDslOperator
6060
df?: string
61-
expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
61+
expand_wildcards?: <<ExpandWildcards>>
6262
ignore_throttled?: boolean
6363
ignore_unavailable?: boolean
6464
lenient?: boolean
65-
max_concurrent_shard_requests?: <<shared-type-long, long>>
66-
min_compatible_shard_node?: <<shared-type-version-string, VersionString>>
65+
max_concurrent_shard_requests?: <<long>>
66+
min_compatible_shard_node?: <<VersionString>>
6767
preference?: string
68-
pre_filter_shard_size?: <<shared-type-long, long>>
68+
pre_filter_shard_size?: <<long>>
6969
request_cache?: boolean
70-
routing?: <<shared-type-routing, Routing>>
71-
scroll?: <<shared-type-duration, Duration>>
72-
search_type?: <<shared-type-search-type, SearchType>>
73-
suggest_field?: <<shared-type-field, Field>>
74-
suggest_mode?: <<shared-type-suggest-mode, SuggestMode>>
75-
suggest_size?: <<shared-type-long, long>>
70+
routing?: <<Routing>>
71+
scroll?: <<Duration>>
72+
search_type?: <<SearchType>>
73+
suggest_field?: <<Field>>
74+
suggest_mode?: <<SuggestMode>>
75+
suggest_size?: <<long>>
7676
suggest_text?: string
7777
typed_keys?: boolean
7878
rest_total_hits_as_int?: boolean
79-
_source_excludes?: <<shared-type-fields, Fields>>
80-
_source_includes?: <<shared-type-fields, Fields>>
79+
_source_excludes?: <<Fields>>
80+
_source_includes?: <<Fields>>
8181
q?: string
8282
aggregations?: Record<string, AggregationsAggregationContainer>
8383
/** @alias aggregations */
8484
aggs?: Record<string, AggregationsAggregationContainer>
8585
collapse?: SearchFieldCollapse
8686
explain?: boolean
8787
ext?: Record<string, any>
88-
from?: <<shared-type-integer, integer>>
88+
from?: <<integer>>
8989
highlight?: SearchHighlight
9090
track_total_hits?: SearchTrackHits
91-
indices_boost?: Record<<<shared-type-index-name, IndexName>>, <<shared-type-double, double>>>[]
92-
docvalue_fields?: (QueryDslFieldAndFormat | <<shared-type-field, Field>>)[]
93-
knn?: <<shared-type-knn-search, KnnSearch>> | <<shared-type-knn-search, KnnSearch>>[]
94-
min_score?: <<shared-type-double, double>>
91+
indices_boost?: Record<<<IndexName>>, <<double>>>[]
92+
docvalue_fields?: (QueryDslFieldAndFormat | <<Field>>)[]
93+
knn?: <<KnnSearch>> | <<KnnSearch>>[]
94+
min_score?: <<double>>
9595
post_filter?: QueryDslQueryContainer
9696
profile?: boolean
9797
query?: QueryDslQueryContainer
9898
rescore?: SearchRescore | SearchRescore[]
99-
script_fields?: Record<string, <<shared-type-script-field, ScriptField>>>
100-
search_after?: <<shared-type-sort-results, SortResults>>
101-
size?: <<shared-type-integer, integer>>
102-
slice?: <<shared-type-sliced-scroll, SlicedScroll>>
103-
sort?: <<shared-type-sort, Sort>>
99+
script_fields?: Record<string, <<ScriptField>>>
100+
search_after?: <<SortResults>>
101+
size?: <<integer>>
102+
slice?: <<SlicedScroll>>
103+
sort?: <<Sort>>
104104
_source?: SearchSourceConfig
105-
fields?: (QueryDslFieldAndFormat | <<shared-type-field, Field>>)[]
105+
fields?: (QueryDslFieldAndFormat | <<Field>>)[]
106106
suggest?: SearchSuggester
107-
terminate_after?: <<shared-type-long, long>>
107+
terminate_after?: <<long>>
108108
timeout?: string
109109
track_scores?: boolean
110110
version?: boolean
111111
seq_no_primary_term?: boolean
112-
stored_fields?: <<shared-type-fields, Fields>>
112+
stored_fields?: <<Fields>>
113113
pit?: SearchPointInTimeReference
114114
runtime_mappings?: MappingRuntimeFields
115115
stats?: string[]
@@ -121,6 +121,6 @@ interface AsyncSearchSubmitRequest extends <<shared-type-request-base, RequestBa
121121

122122
[source,ts]
123123
----
124-
type AsyncSearchSubmitResponse<TDocument = unknown, TAggregations = Record<<<shared-type-aggregate-name, AggregateName>>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
124+
type AsyncSearchSubmitResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
125125
----
126126

docs/reference-autoscaling-delete_autoscaling_policy.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ Delete an autoscaling policy. NOTE: This feature is designed for indirect use by
4545

4646
[source,ts]
4747
----
48-
interface AutoscalingDeleteAutoscalingPolicyRequest extends <<shared-type-request-base, RequestBase>> {
49-
name: <<shared-type-name, Name>>
48+
interface AutoscalingDeleteAutoscalingPolicyRequest extends <<RequestBase>> {
49+
name: <<Name>>
5050
}
5151
----
5252

@@ -55,6 +55,6 @@ interface AutoscalingDeleteAutoscalingPolicyRequest extends <<shared-type-reques
5555

5656
[source,ts]
5757
----
58-
type AutoscalingDeleteAutoscalingPolicyResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
58+
type AutoscalingDeleteAutoscalingPolicyResponse = <<AcknowledgedResponseBase>>
5959
----
6060

docs/reference-autoscaling-get_autoscaling_capacity.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Get the autoscaling capacity. NOTE: This feature is designed for indirect use by
4545

4646
[source,ts]
4747
----
48-
interface AutoscalingGetAutoscalingCapacityRequest extends <<shared-type-request-base, RequestBase>> {
48+
interface AutoscalingGetAutoscalingCapacityRequest extends <<RequestBase>> {
4949
}
5050
----
5151

docs/reference-autoscaling-get_autoscaling_policy.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ Get an autoscaling policy. NOTE: This feature is designed for indirect use by El
4545

4646
[source,ts]
4747
----
48-
interface AutoscalingGetAutoscalingPolicyRequest extends <<shared-type-request-base, RequestBase>> {
49-
name: <<shared-type-name, Name>>
48+
interface AutoscalingGetAutoscalingPolicyRequest extends <<RequestBase>> {
49+
name: <<Name>>
5050
}
5151
----
5252

docs/reference-autoscaling-put_autoscaling_policy.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ Create or update an autoscaling policy. NOTE: This feature is designed for indir
4545

4646
[source,ts]
4747
----
48-
interface AutoscalingPutAutoscalingPolicyRequest extends <<shared-type-request-base, RequestBase>> {
49-
name: <<shared-type-name, Name>>
48+
interface AutoscalingPutAutoscalingPolicyRequest extends <<RequestBase>> {
49+
name: <<Name>>
5050
policy?: AutoscalingAutoscalingPolicy
5151
}
5252
----
@@ -56,6 +56,6 @@ interface AutoscalingPutAutoscalingPolicyRequest extends <<shared-type-request-b
5656

5757
[source,ts]
5858
----
59-
type AutoscalingPutAutoscalingPolicyResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
59+
type AutoscalingPutAutoscalingPolicyResponse = <<AcknowledgedResponseBase>>
6060
----
6161

docs/reference-bulk.asciidoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -45,16 +45,16 @@ Bulk index or delete documents. Performs multiple indexing or delete operations
4545

4646
[source,ts]
4747
----
48-
interface BulkRequest<TDocument = unknown, TPartialDocument = unknown> extends <<shared-type-request-base, RequestBase>> {
49-
index?: <<shared-type-index-name, IndexName>>
48+
interface BulkRequest<TDocument = unknown, TPartialDocument = unknown> extends <<RequestBase>> {
49+
index?: <<IndexName>>
5050
pipeline?: string
51-
refresh?: <<shared-type-refresh, Refresh>>
52-
routing?: <<shared-type-routing, Routing>>
51+
refresh?: <<Refresh>>
52+
routing?: <<Routing>>
5353
_source?: SearchSourceConfigParam
54-
_source_excludes?: <<shared-type-fields, Fields>>
55-
_source_includes?: <<shared-type-fields, Fields>>
56-
timeout?: <<shared-type-duration, Duration>>
57-
wait_for_active_shards?: <<shared-type-wait-for-active-shards, WaitForActiveShards>>
54+
_source_excludes?: <<Fields>>
55+
_source_includes?: <<Fields>>
56+
timeout?: <<Duration>>
57+
wait_for_active_shards?: <<WaitForActiveShards>>
5858
require_alias?: boolean
5959
operations?: (BulkOperationContainer | BulkUpdateAction<TDocument, TPartialDocument> | TDocument)[]
6060
}
@@ -68,8 +68,8 @@ interface BulkRequest<TDocument = unknown, TPartialDocument = unknown> extends <
6868
interface BulkResponse {
6969
errors: boolean
7070
items: Partial<Record<BulkOperationType, BulkResponseItem>>[]
71-
took: <<shared-type-long, long>>
72-
ingest_took?: <<shared-type-long, long>>
71+
took: <<long>>
72+
ingest_took?: <<long>>
7373
}
7474
----
7575

docs/reference-cat-aliases.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ Get aliases. Retrieves the cluster’s index aliases, including filter and routi
4646
[source,ts]
4747
----
4848
interface CatAliasesRequest extends CatCatRequestBase {
49-
name?: <<shared-type-names, Names>>
50-
expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
49+
name?: <<Names>>
50+
expand_wildcards?: <<ExpandWildcards>>
5151
}
5252
----
5353

0 commit comments

Comments
 (0)