Skip to content

Commit 96b709b

Browse files
committed
More iteration on generated docs
1 parent 5567876 commit 96b709b

File tree

503 files changed

+11718
-6091
lines changed

Some content is hidden

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

503 files changed

+11718
-6091
lines changed

docs/basic-config.asciidoc

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ _Default:_ `3`
8585
_Default:_ `30000`
8686

8787
|`pingTimeout`
88-
|`number` - Max ping request timeout in milliseconds for each request. +
88+
|`number` - Max number of milliseconds a `ClusterConnectionPool` will wait when pinging nodes before marking them dead. +
8989
_Default:_ `3000`
9090

9191
|`sniffInterval`
@@ -105,17 +105,13 @@ _Default:_ `'_nodes/_all/http'`
105105
_Default:_ `false`
106106

107107
|`resurrectStrategy`
108-
|`string` - Configure the node resurrection strategy. +
108+
|`string` - Strategy for resurrecting dead nodes when using `ClusterConnectionPool`. 'ping' will issue a test request to a node and resurrect it if it responds. 'optimistic' marks a node as alive without testing it. 'none' will never attempt to revive a dead connection. +
109109
_Options:_ `'ping'`, `'optimistic'`, `'none'` +
110110
_Default:_ `'ping'`
111111

112-
|`suggestCompression`
113-
|`boolean` - Adds `accept-encoding` header to every request. +
114-
_Default:_ `false`
115-
116112
|`compression`
117113
|`string, boolean` - Enables gzip request body compression. +
118-
_Options:_ `'gzip'`, `false` +
114+
_Options:_ `true`, `false` +
119115
_Default:_ `false`
120116

121117
|`tls`

docs/index.asciidoc

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
= Elasticsearch JavaScript Client
22

3-
include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[]
4-
include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
5-
63
include::introduction.asciidoc[]
74
include::getting-started.asciidoc[]
85
include::changelog.asciidoc[]
@@ -21,5 +18,4 @@ include::reference.asciidoc[]
2118
include::reference-main-index.asciidoc[]
2219
include::examples/index.asciidoc[]
2320
include::helpers.asciidoc[]
24-
include::redirects.asciidoc[]
2521
include::timeout-best-practices.asciidoc[]

docs/reference-async_search-delete.asciidoc

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,20 +41,30 @@ Delete an async search. If the asynchronous search is still running, it is cance
4141
----
4242

4343
[discrete]
44-
===== `AsyncSearchDeleteRequest`
44+
==== AsyncSearchDeleteRequest
4545

46-
[source,ts]
47-
----
46+
[pass]
47+
++++
48+
<pre>
49+
++++
4850
interface AsyncSearchDeleteRequest extends <<RequestBase>> {
4951
id: <<Id>>
5052
}
51-
----
5253

54+
[pass]
55+
++++
56+
</pre>
57+
++++
5358
[discrete]
54-
===== `AsyncSearchDeleteResponse`
59+
==== AsyncSearchDeleteResponse
5560

56-
[source,ts]
57-
----
61+
[pass]
62+
++++
63+
<pre>
64+
++++
5865
type AsyncSearchDeleteResponse = <<AcknowledgedResponseBase>>
59-
----
6066

67+
[pass]
68+
++++
69+
</pre>
70+
++++

docs/reference-async_search-get.asciidoc

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,23 +41,33 @@ Get async search results. Retrieve the results of a previously submitted asynchr
4141
----
4242

4343
[discrete]
44-
===== `AsyncSearchGetRequest`
44+
==== AsyncSearchGetRequest
4545

46-
[source,ts]
47-
----
46+
[pass]
47+
++++
48+
<pre>
49+
++++
4850
interface AsyncSearchGetRequest extends <<RequestBase>> {
4951
id: <<Id>>
5052
keep_alive?: <<Duration>>
5153
typed_keys?: boolean
5254
wait_for_completion_timeout?: <<Duration>>
5355
}
54-
----
5556

57+
[pass]
58+
++++
59+
</pre>
60+
++++
5661
[discrete]
57-
===== `AsyncSearchGetResponse`
62+
==== AsyncSearchGetResponse
5863

59-
[source,ts]
60-
----
64+
[pass]
65+
++++
66+
<pre>
67+
++++
6168
type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
62-
----
6369

70+
[pass]
71+
++++
72+
</pre>
73+
++++

docs/reference-async_search-status.asciidoc

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,20 +41,30 @@ Get the async search status. Get the status of a previously submitted async sear
4141
----
4242

4343
[discrete]
44-
===== `AsyncSearchStatusRequest`
44+
==== AsyncSearchStatusRequest
4545

46-
[source,ts]
47-
----
46+
[pass]
47+
++++
48+
<pre>
49+
++++
4850
interface AsyncSearchStatusRequest extends <<RequestBase>> {
4951
id: <<Id>>
5052
}
51-
----
5253

54+
[pass]
55+
++++
56+
</pre>
57+
++++
5358
[discrete]
54-
===== `AsyncSearchStatusResponse`
59+
==== AsyncSearchStatusResponse
5560

56-
[source,ts]
57-
----
61+
[pass]
62+
++++
63+
<pre>
64+
++++
5865
type AsyncSearchStatusResponse = AsyncSearchStatusStatusResponseBase
59-
----
6066

67+
[pass]
68+
++++
69+
</pre>
70+
++++

docs/reference-async_search-submit.asciidoc

Lines changed: 27 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,12 @@ Run an async search. When the primary sort of the results is an indexed field, s
4141
----
4242

4343
[discrete]
44-
===== `AsyncSearchSubmitRequest`
44+
==== AsyncSearchSubmitRequest
4545

46-
[source,ts]
47-
----
46+
[pass]
47+
++++
48+
<pre>
49+
++++
4850
interface AsyncSearchSubmitRequest extends <<RequestBase>> {
4951
index?: <<Indices>>
5052
wait_for_completion_timeout?: <<Duration>>
@@ -54,25 +56,25 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
5456
allow_partial_search_results?: boolean
5557
analyzer?: string
5658
analyze_wildcard?: boolean
57-
batched_reduce_size?: <<long>>
59+
batched_reduce_size?: number
5860
ccs_minimize_roundtrips?: boolean
5961
default_operator?: QueryDslOperator
6062
df?: string
6163
expand_wildcards?: <<ExpandWildcards>>
6264
ignore_throttled?: boolean
6365
ignore_unavailable?: boolean
6466
lenient?: boolean
65-
max_concurrent_shard_requests?: <<long>>
67+
max_concurrent_shard_requests?: number
6668
min_compatible_shard_node?: <<VersionString>>
6769
preference?: string
68-
pre_filter_shard_size?: <<long>>
70+
pre_filter_shard_size?: number
6971
request_cache?: boolean
7072
routing?: <<Routing>>
7173
scroll?: <<Duration>>
7274
search_type?: <<SearchType>>
7375
suggest_field?: <<Field>>
7476
suggest_mode?: <<SuggestMode>>
75-
suggest_size?: <<long>>
77+
suggest_size?: number
7678
suggest_text?: string
7779
typed_keys?: boolean
7880
rest_total_hits_as_int?: boolean
@@ -85,26 +87,26 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
8587
collapse?: SearchFieldCollapse
8688
explain?: boolean
8789
ext?: Record<string, any>
88-
from?: <<integer>>
90+
from?: number
8991
highlight?: SearchHighlight
9092
track_total_hits?: SearchTrackHits
91-
indices_boost?: Record<<<IndexName>>, <<double>>>[]
93+
indices_boost?: Record<<<IndexName>>, number>[]
9294
docvalue_fields?: (QueryDslFieldAndFormat | <<Field>>)[]
9395
knn?: <<KnnSearch>> | <<KnnSearch>>[]
94-
min_score?: <<double>>
96+
min_score?: number
9597
post_filter?: QueryDslQueryContainer
9698
profile?: boolean
9799
query?: QueryDslQueryContainer
98100
rescore?: SearchRescore | SearchRescore[]
99101
script_fields?: Record<string, <<ScriptField>>>
100102
search_after?: <<SortResults>>
101-
size?: <<integer>>
103+
size?: number
102104
slice?: <<SlicedScroll>>
103105
sort?: <<Sort>>
104106
_source?: SearchSourceConfig
105107
fields?: (QueryDslFieldAndFormat | <<Field>>)[]
106108
suggest?: SearchSuggester
107-
terminate_after?: <<long>>
109+
terminate_after?: number
108110
timeout?: string
109111
track_scores?: boolean
110112
version?: boolean
@@ -114,13 +116,21 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
114116
runtime_mappings?: MappingRuntimeFields
115117
stats?: string[]
116118
}
117-
----
118119

120+
[pass]
121+
++++
122+
</pre>
123+
++++
119124
[discrete]
120-
===== `AsyncSearchSubmitResponse`
125+
==== AsyncSearchSubmitResponse
121126

122-
[source,ts]
123-
----
127+
[pass]
128+
++++
129+
<pre>
130+
++++
124131
type AsyncSearchSubmitResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
125-
----
126132

133+
[pass]
134+
++++
135+
</pre>
136+
++++

docs/reference-autoscaling-delete_autoscaling_policy.asciidoc

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,20 +41,30 @@ Delete an autoscaling policy. NOTE: This feature is designed for indirect use by
4141
----
4242

4343
[discrete]
44-
===== `AutoscalingDeleteAutoscalingPolicyRequest`
44+
==== AutoscalingDeleteAutoscalingPolicyRequest
4545

46-
[source,ts]
47-
----
46+
[pass]
47+
++++
48+
<pre>
49+
++++
4850
interface AutoscalingDeleteAutoscalingPolicyRequest extends <<RequestBase>> {
4951
name: <<Name>>
5052
}
51-
----
5253

54+
[pass]
55+
++++
56+
</pre>
57+
++++
5358
[discrete]
54-
===== `AutoscalingDeleteAutoscalingPolicyResponse`
59+
==== AutoscalingDeleteAutoscalingPolicyResponse
5560

56-
[source,ts]
57-
----
61+
[pass]
62+
++++
63+
<pre>
64+
++++
5865
type AutoscalingDeleteAutoscalingPolicyResponse = <<AcknowledgedResponseBase>>
59-
----
6066

67+
[pass]
68+
++++
69+
</pre>
70+
++++

docs/reference-autoscaling-get_autoscaling_capacity.asciidoc

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,21 +41,31 @@ Get the autoscaling capacity. NOTE: This feature is designed for indirect use by
4141
----
4242

4343
[discrete]
44-
===== `AutoscalingGetAutoscalingCapacityRequest`
44+
==== AutoscalingGetAutoscalingCapacityRequest
4545

46-
[source,ts]
47-
----
46+
[pass]
47+
++++
48+
<pre>
49+
++++
4850
interface AutoscalingGetAutoscalingCapacityRequest extends <<RequestBase>> {
4951
}
50-
----
5152

53+
[pass]
54+
++++
55+
</pre>
56+
++++
5257
[discrete]
53-
===== `AutoscalingGetAutoscalingCapacityResponse`
58+
==== AutoscalingGetAutoscalingCapacityResponse
5459

55-
[source,ts]
56-
----
60+
[pass]
61+
++++
62+
<pre>
63+
++++
5764
interface AutoscalingGetAutoscalingCapacityResponse {
5865
policies: Record<string, AutoscalingGetAutoscalingCapacityAutoscalingDeciders>
5966
}
60-
----
6167

68+
[pass]
69+
++++
70+
</pre>
71+
++++

docs/reference-autoscaling-get_autoscaling_policy.asciidoc

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,20 +41,30 @@ Get an autoscaling policy. NOTE: This feature is designed for indirect use by El
4141
----
4242

4343
[discrete]
44-
===== `AutoscalingGetAutoscalingPolicyRequest`
44+
==== AutoscalingGetAutoscalingPolicyRequest
4545

46-
[source,ts]
47-
----
46+
[pass]
47+
++++
48+
<pre>
49+
++++
4850
interface AutoscalingGetAutoscalingPolicyRequest extends <<RequestBase>> {
4951
name: <<Name>>
5052
}
51-
----
5253

54+
[pass]
55+
++++
56+
</pre>
57+
++++
5358
[discrete]
54-
===== `AutoscalingGetAutoscalingPolicyResponse`
59+
==== AutoscalingGetAutoscalingPolicyResponse
5560

56-
[source,ts]
57-
----
61+
[pass]
62+
++++
63+
<pre>
64+
++++
5865
type AutoscalingGetAutoscalingPolicyResponse = AutoscalingAutoscalingPolicy
59-
----
6066

67+
[pass]
68+
++++
69+
</pre>
70+
++++

0 commit comments

Comments
 (0)