Skip to content

Commit

Permalink
Test run of new docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@JoshMock
JoshMock committed Nov 19, 2024
1 parent 1ad057a commit c33db59
Show file tree
Hide file tree
Showing 503 changed files with 36,670 additions and 11,447 deletions.
2 changes: 1 addition & 1 deletion docs/index.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ include::integrations.asciidoc[]
include::observability.asciidoc[]
include::transport.asciidoc[]
include::typescript.asciidoc[]
include::reference.asciidoc[]
include::reference-main-index.asciidoc[]
include::examples/index.asciidoc[]
include::helpers.asciidoc[]
include::redirects.asciidoc[]
Expand Down
60 changes: 60 additions & 0 deletions docs/reference-async_search-delete.asciidoc
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
[[reference-async_search-delete]]

////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////

[discrete]
=== client.asyncSearch.delete

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.

{ref}/async-search.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(AsyncSearchDeleteRequest, options?): Promise<AsyncSearchDeleteResponse>
----

[discrete]
===== `AsyncSearchDeleteRequest`

[source,ts]
----
interface AsyncSearchDeleteRequest extends <<shared-type-request-base, RequestBase>> {
id: <<shared-type-id, Id>>
}
----

[discrete]
===== `AsyncSearchDeleteResponse`

[source,ts]
----
type AsyncSearchDeleteResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
----

63 changes: 63 additions & 0 deletions docs/reference-async_search-get.asciidoc
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
[[reference-async_search-get]]

////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////

[discrete]
=== client.asyncSearch.get

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.

{ref}/async-search.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(AsyncSearchGetRequest, options?): Promise<AsyncSearchGetResponse>
----

[discrete]
===== `AsyncSearchGetRequest`

[source,ts]
----
interface AsyncSearchGetRequest extends <<shared-type-request-base, RequestBase>> {
id: <<shared-type-id, Id>>
keep_alive?: <<shared-type-duration, Duration>>
typed_keys?: boolean
wait_for_completion_timeout?: <<shared-type-duration, Duration>>
}
----

[discrete]
===== `AsyncSearchGetResponse`

[source,ts]
----
type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<<<shared-type-aggregate-name, AggregateName>>, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
----

60 changes: 60 additions & 0 deletions docs/reference-async_search-status.asciidoc
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
[[reference-async_search-status]]

////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////

[discrete]
=== client.asyncSearch.status

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.

{ref}/async-search.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(AsyncSearchStatusRequest, options?): Promise<AsyncSearchStatusResponse>
----

[discrete]
===== `AsyncSearchStatusRequest`

[source,ts]
----
interface AsyncSearchStatusRequest extends <<shared-type-request-base, RequestBase>> {
id: <<shared-type-id, Id>>
}
----

[discrete]
===== `AsyncSearchStatusResponse`

[source,ts]
----
type AsyncSearchStatusResponse = AsyncSearchStatusStatusResponseBase
----

Loading

0 comments on commit c33db59

Please sign in to comment.