Skip to content

Commit c33db59

Browse files
JoshMockJoshMock
committed
Test run of new docs
1 parent 1ad057a commit c33db59

File tree

503 files changed

+36670
-11447
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

+36670
-11447
lines changed

‎docs/index.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ include::integrations.asciidoc[]
1717
include::observability.asciidoc[]
1818
include::transport.asciidoc[]
1919
include::typescript.asciidoc[]
20-
include::reference.asciidoc[]
20+
include::reference-main-index.asciidoc[]
2121
include::examples/index.asciidoc[]
2222
include::helpers.asciidoc[]
2323
include::redirects.asciidoc[]

‎docs/reference-async_search-delete.asciidoc

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
[[reference-async_search-delete]]
2+
3+
////////
4+
===========================================================================================================================
5+
|| ||
6+
|| ||
7+
|| ||
8+
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
9+
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
10+
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
11+
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
12+
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
13+
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
14+
|| ||
15+
|| ||
16+
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
17+
|| You should update the script that does the generation, which can be found in: ||
18+
|| https://github.com/elastic/elastic-client-generator-js ||
19+
|| ||
20+
|| You can run the script with the following command: ||
21+
|| npm run elasticsearch -- --version <version> ||
22+
|| ||
23+
|| ||
24+
|| ||
25+
===========================================================================================================================
26+
////////
27+
28+
[discrete]
29+
=== client.asyncSearch.delete
30+
31+
Delete an async search. If the asynchronous search is still running, it is cancelled. Otherwise, the saved search results are deleted. If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.
32+
33+
{ref}/async-search.html[{es} documentation]
34+
35+
[discrete]
36+
==== Function signature
37+
38+
[source,ts]
39+
----
40+
(AsyncSearchDeleteRequest, options?): Promise<AsyncSearchDeleteResponse>
41+
----
42+
43+
[discrete]
44+
===== `AsyncSearchDeleteRequest`
45+
46+
[source,ts]
47+
----
48+
interface AsyncSearchDeleteRequest extends <<shared-type-request-base, RequestBase>> {
49+
id: <<shared-type-id, Id>>
50+
}
51+
----
52+
53+
[discrete]
54+
===== `AsyncSearchDeleteResponse`
55+
56+
[source,ts]
57+
----
58+
type AsyncSearchDeleteResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
59+
----
60+

‎docs/reference-async_search-get.asciidoc

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
[[reference-async_search-get]]
2+
3+
////////
4+
===========================================================================================================================
5+
|| ||
6+
|| ||
7+
|| ||
8+
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
9+
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
10+
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
11+
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
12+
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
13+
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
14+
|| ||
15+
|| ||
16+
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
17+
|| You should update the script that does the generation, which can be found in: ||
18+
|| https://github.com/elastic/elastic-client-generator-js ||
19+
|| ||
20+
|| You can run the script with the following command: ||
21+
|| npm run elasticsearch -- --version <version> ||
22+
|| ||
23+
|| ||
24+
|| ||
25+
===========================================================================================================================
26+
////////
27+
28+
[discrete]
29+
=== client.asyncSearch.get
30+
31+
Get async search results. Retrieve the results of a previously submitted asynchronous search request. If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.
32+
33+
{ref}/async-search.html[{es} documentation]
34+
35+
[discrete]
36+
==== Function signature
37+
38+
[source,ts]
39+
----
40+
(AsyncSearchGetRequest, options?): Promise<AsyncSearchGetResponse>
41+
----
42+
43+
[discrete]
44+
===== `AsyncSearchGetRequest`
45+
46+
[source,ts]
47+
----
48+
interface AsyncSearchGetRequest extends <<shared-type-request-base, RequestBase>> {
49+
id: <<shared-type-id, Id>>
50+
keep_alive?: <<shared-type-duration, Duration>>
51+
typed_keys?: boolean
52+
wait_for_completion_timeout?: <<shared-type-duration, Duration>>
53+
}
54+
----
55+
56+
[discrete]
57+
===== `AsyncSearchGetResponse`
58+
59+
[source,ts]
60+
----
61+
type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<<<shared-type-aggregate-name, AggregateName>>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
62+
----
63+

‎docs/reference-async_search-status.asciidoc

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
[[reference-async_search-status]]
2+
3+
////////
4+
===========================================================================================================================
5+
|| ||
6+
|| ||
7+
|| ||
8+
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
9+
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
10+
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
11+
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
12+
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
13+
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
14+
|| ||
15+
|| ||
16+
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
17+
|| You should update the script that does the generation, which can be found in: ||
18+
|| https://github.com/elastic/elastic-client-generator-js ||
19+
|| ||
20+
|| You can run the script with the following command: ||
21+
|| npm run elasticsearch -- --version <version> ||
22+
|| ||
23+
|| ||
24+
|| ||
25+
===========================================================================================================================
26+
////////
27+
28+
[discrete]
29+
=== client.asyncSearch.status
30+
31+
Get the async search status. Get the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.
32+
33+
{ref}/async-search.html[{es} documentation]
34+
35+
[discrete]
36+
==== Function signature
37+
38+
[source,ts]
39+
----
40+
(AsyncSearchStatusRequest, options?): Promise<AsyncSearchStatusResponse>
41+
----
42+
43+
[discrete]
44+
===== `AsyncSearchStatusRequest`
45+
46+
[source,ts]
47+
----
48+
interface AsyncSearchStatusRequest extends <<shared-type-request-base, RequestBase>> {
49+
id: <<shared-type-id, Id>>
50+
}
51+
----
52+
53+
[discrete]
54+
===== `AsyncSearchStatusResponse`
55+
56+
[source,ts]
57+
----
58+
type AsyncSearchStatusResponse = AsyncSearchStatusStatusResponseBase
59+
----
60+

0 commit comments

Comments
 (0)