Skip to content

Commit 88e47f7

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

File tree

604 files changed

+46498
-11692
lines changed

Some content is hidden

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

604 files changed

+46498
-11692
lines changed

‎.buildkite/make.mjs

+1-1
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ async function codegen (args) {
123123
await $`rm -rf ${join(import.meta.url, '..', 'src', 'api')}`
124124
await $`mkdir ${join(import.meta.url, '..', 'src', 'api')}`
125125
await $`cp -R ${join(import.meta.url, '..', '..', 'elastic-client-generator-js', 'output')}/* ${join(import.meta.url, '..', 'src', 'api')}`
126-
await $`mv ${join(import.meta.url, '..', 'src', 'api', 'reference.asciidoc')} ${join(import.meta.url, '..', 'docs', 'reference.asciidoc')}`
126+
await $`mv ${join(import.meta.url, '..', 'src', 'api')}/reference*.asciidoc ${join(import.meta.url, '..', 'docs')}`
127127
await $`npm run build`
128128

129129
// run docs example generation

‎docs/doc_examples/19d60e4890cc57151d596326484d9076.asciidoc

-11
This file was deleted.

‎docs/doc_examples/3fab530a2e43807929c0ef3ebf7d268c.asciidoc ‎docs/doc_examples/216e24f05cbb82c1718713fbab8623d2.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
----
66
const response = await client.ingest.putPipeline({
77
id: "geoip",
8-
description: "Add geoip info",
8+
description: "Add ip geolocation info",
99
processors: [
1010
{
1111
geoip: {

‎docs/doc_examples/d3a558ef226e9dccc1c7c61e1167547f.asciidoc ‎docs/doc_examples/334811cfceb6858aeec5b3461717dd63.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
----
66
const response = await client.ingest.putPipeline({
77
id: "geoip",
8-
description: "Add geoip info",
8+
description: "Add ip geolocation info",
99
processors: [
1010
{
1111
geoip: {

‎docs/doc_examples/3b6718257421b5419bf4cd6a7303c57e.asciidoc

-11
This file was deleted.

‎docs/doc_examples/533087d787b48878a0bf3fa8d0851b64.asciidoc

-11
This file was deleted.

‎docs/doc_examples/4b113c7f475cfe484a150ddbb8e6c5c7.asciidoc ‎docs/doc_examples/5e021307d331a4483a5aa2198168451b.asciidoc

+7-1
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,20 @@
44
[source, js]
55
----
66
const response = await client.security.putRole({
7-
name: "role_with_remote_indices",
7+
name: "only_remote_access_role",
88
remote_indices: [
99
{
1010
clusters: ["my_remote"],
1111
names: ["logs*"],
1212
privileges: ["read", "read_cross_cluster", "view_index_metadata"],
1313
},
1414
],
15+
remote_cluster: [
16+
{
17+
clusters: ["my_remote"],
18+
privileges: ["monitor_stats"],
19+
},
20+
],
1521
});
1622
console.log(response);
1723
----

‎docs/doc_examples/7f1fade93225f8cf6000b93334d76ce4.asciidoc

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
// This file is autogenerated, DO NOT EDIT
2+
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
3+
4+
[source, js]
5+
----
6+
const response = await client.ingest.putPipeline({
7+
id: "ip_location",
8+
description: "Add ip geolocation info",
9+
processors: [
10+
{
11+
ip_location: {
12+
field: "ip",
13+
},
14+
},
15+
],
16+
});
17+
console.log(response);
18+
19+
const response1 = await client.index({
20+
index: "my-index-000001",
21+
id: "my_id",
22+
pipeline: "ip_location",
23+
document: {
24+
ip: "80.231.5.0",
25+
},
26+
});
27+
console.log(response1);
28+
29+
const response2 = await client.get({
30+
index: "my-index-000001",
31+
id: "my_id",
32+
});
33+
console.log(response2);
34+
----

‎docs/doc_examples/981b331db1404b39c1a612a135e4e76d.asciidoc

-17
This file was deleted.

‎docs/doc_examples/a3779f21f132787c48681bfb50453592.asciidoc

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
// This file is autogenerated, DO NOT EDIT
2+
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
3+
4+
[source, js]
5+
----
6+
const response = await client.ingest.putPipeline({
7+
id: "ip_location",
8+
description: "Add ip geolocation info",
9+
processors: [
10+
{
11+
ip_location: {
12+
field: "ip",
13+
},
14+
},
15+
],
16+
});
17+
console.log(response);
18+
19+
const response1 = await client.index({
20+
index: "my-index-000001",
21+
id: "my_id",
22+
pipeline: "ip_location",
23+
document: {
24+
ip: "89.160.20.128",
25+
},
26+
});
27+
console.log(response1);
28+
29+
const response2 = await client.get({
30+
index: "my-index-000001",
31+
id: "my_id",
32+
});
33+
console.log(response2);
34+
----

‎docs/doc_examples/b577e7e7eb5ce9d16cb582356e2cc45c.asciidoc ‎docs/doc_examples/b0ee6f19875fe5bad8aab02d60e3532c.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
----
66
const response = await client.ingest.putPipeline({
77
id: "geoip",
8-
description: "Add geoip info",
8+
description: "Add ip geolocation info",
99
processors: [
1010
{
1111
geoip: {

‎docs/doc_examples/e308899a306e61d1a590868308689955.asciidoc

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
// This file is autogenerated, DO NOT EDIT
2+
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
3+
4+
[source, js]
5+
----
6+
const response = await client.ingest.putPipeline({
7+
id: "ip_location",
8+
description: "Add ip geolocation info",
9+
processors: [
10+
{
11+
ip_location: {
12+
field: "ip",
13+
target_field: "geo",
14+
database_file: "GeoLite2-Country.mmdb",
15+
},
16+
},
17+
],
18+
});
19+
console.log(response);
20+
21+
const response1 = await client.index({
22+
index: "my-index-000001",
23+
id: "my_id",
24+
pipeline: "ip_location",
25+
document: {
26+
ip: "89.160.20.128",
27+
},
28+
});
29+
console.log(response1);
30+
31+
const response2 = await client.get({
32+
index: "my-index-000001",
33+
id: "my_id",
34+
});
35+
console.log(response2);
36+
----

‎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+

0 commit comments

Comments
 (0)