Skip to content

Commit

Permalink
Edit async search summaries
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl committed Sep 26, 2024
1 parent 0010fd3 commit 5cd8144
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 9 deletions.
4 changes: 2 additions & 2 deletions specification/async_search/delete/AsyncSearchDeleteRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ import { RequestBase } from '@_types/Base'
import { Id } from '@_types/common'

/**
* Deletes an async search by identifier.
* If the search is still running, the search request will be cancelled.
* Deletes 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.
* @rest_spec_name async_search.delete
Expand Down
3 changes: 2 additions & 1 deletion specification/async_search/get/AsyncSearchGetRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ import { Id } from '@_types/common'
import { Duration } from '@_types/Time'

/**
* Retrieves the results of a previously submitted async search request given its identifier.
* 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.
* @rest_spec_name async_search.get
* @availability stack since=7.7.0 stability=stable
Expand Down
4 changes: 2 additions & 2 deletions specification/async_search/status/AsyncSearchStatusRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ import { RequestBase } from '@_types/Base'
import { Id } from '@_types/common'

/**
* Get async search status
* Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
* Get async search status.
* Retrieve 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.
* @rest_spec_name async_search.status
* @availability stack since=7.11.0 stability=stable
Expand Down
10 changes: 6 additions & 4 deletions specification/async_search/submit/AsyncSearchSubmitRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,12 @@ import { Sort, SortResults } from '@_types/sort'
import { Duration } from '@_types/Time'

/**
* Runs a search request asynchronously.
* When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.
* Warning: Async search does not support scroll nor search requests that only include the suggest section.
* By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
* Run an async search.
* When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.
*
* Warning: Asynchronous search does not support scroll or search requests that include only the suggest section.
*
* By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
* The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.
* @rest_spec_name async_search.submit
* @availability stack since=7.7.0 stability=stable
Expand Down

0 comments on commit 5cd8144

Please sign in to comment.