From c32409da2224a78d9bdc93d99c27283bec7b0b27 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Wed, 17 Mar 2021 10:50:15 +0100 Subject: [PATCH] [DOCS] Fixes typo in async search API docs. (#70448) (#70458) --- docs/reference/search/async-search.asciidoc | 84 ++++++++++----------- 1 file changed, 42 insertions(+), 42 deletions(-) diff --git a/docs/reference/search/async-search.asciidoc b/docs/reference/search/async-search.asciidoc index c0ca6e52c7bfd..6af34d2069f5f 100644 --- a/docs/reference/search/async-search.asciidoc +++ b/docs/reference/search/async-search.asciidoc @@ -3,15 +3,14 @@ [[async-search]] === Async search -The async search API let you asynchronously execute a -search request, monitor its progress, and retrieve partial results -as they become available. +The async search API let you asynchronously execute a search request, monitor +its progress, and retrieve partial results as they become available. [[submit-async-search]] ==== Submit async search API -Executes a search request asynchronously. It accepts the same -parameters and request body as the <>. +Executes a search request asynchronously. It accepts the same parameters and +request body as the <>. [source,console,id=submit-async-search-date-histogram-example] -------------------------------------------------- @@ -33,10 +32,10 @@ POST /sales*/_async_search?size=0 // TEST[setup:sales] // TEST[s/size=0/size=0&wait_for_completion_timeout=10s&keep_on_completion=true/] -The response contains an identifier of the search being executed. -You can use this ID to later retrieve the search's final results. -The currently available search -results are returned as part of the <> object. +The response contains an identifier of the search being executed. You can use +this ID to later retrieve the search's final results. The currently available +search results are returned as part of the +<> object. [source,console-result] -------------------------------------------------- @@ -104,18 +103,17 @@ The `keep_on_completion` parameter, which defaults to `false`, can be set to `true` to request that results are stored for later retrieval also when the search completes within the `wait_for_completion_timeout`. -You can also specify how long the async search needs to be -available through the `keep_alive` parameter, which defaults to `5d` (five days). -Ongoing async searches and any saved search results are deleted after this -period. +You can also specify how long the async search needs to be available through the +`keep_alive` parameter, which defaults to `5d` (five days). Ongoing async +searches and any saved search results are deleted after this period. -NOTE: 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. +NOTE: 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. -The submit async search API supports the same <> -as the search API, though some have different default values: +The submit async search API supports the same +<> as the search API, though some +have different default values: * `batched_reduce_size` defaults to `5`: this affects how often partial results become available, which happens whenever shard results are reduced. A partial @@ -130,16 +128,16 @@ query get skipped. supported value WARNING: Async search does not support <> -nor search requests that only include the <>. -{ccs} is supported only with <> -set to `false`. +nor search requests that only include the <>. +{ccs-cap} is supported only with +<> set to `false`. [[get-async-search]] ==== Get async search -The get async search API retrieves the results of a previously submitted -async search request given its id. If the {es} {security-features} are enabled, -the access to the results of a specific async search is restricted to +The get async search API retrieves the results of a previously submitted async +search request given its id. If the {es} {security-features} are enabled, the +access to the results of a specific async search is restricted to <>. [source,console,id=get-async-search-date-histogram-example] @@ -211,25 +209,25 @@ completed the execution of the query. The `wait_for_completion_timeout` parameter can also be provided when calling the Get Async Search API, in order to wait for the search to be completed up until the provided timeout. Final results will be returned if available before -the timeout expires, otherwise the currently available results will be -returned once the timeout expires. By default no timeout is set meaning that -the currently available results will be returned without any additional wait. +the timeout expires, otherwise the currently available results will be returned +once the timeout expires. By default no timeout is set meaning that the +currently available results will be returned without any additional wait. The `keep_alive` parameter specifies how long the async search should be available in the cluster. When not specified, the `keep_alive` set with the corresponding submit async request will be used. Otherwise, it is possible to override such value and extend the validity of the request. When this period -expires, the search, if still running, is cancelled. If the search is -completed, its saved results are deleted. +expires, the search, if still running, is cancelled. If the search is completed, +its saved results are deleted. [[get-async-search-status]] ==== Get async search status -The get async search status API, without retrieving search results, shows -only the status of a previously submitted async search request given its `id`. -If the {es} {security-features} are enabled, the access to the get async -search status API is restricted to the -<>. + +The get async search status API, without retrieving search results, shows only +the status of a previously submitted async search request given its `id`. If the +{es} {security-features} are enabled, the access to the get async search status +API is restricted to the <>. [source,console,id=get-async-search-status-example] -------------------------------------------------- @@ -257,9 +255,10 @@ GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVm <1> Indicates how many shards have executed the query so far. -For an async search that has been completed, the status response has -an additional `completion_status` field that shows the status -code of the completed async search. +For an async search that has been completed, the status response has an +additional `completion_status` field that shows the status code of the completed +async search. + [source,console-result] -------------------------------------------------- { @@ -279,7 +278,7 @@ code of the completed async search. -------------------------------------------------- // TEST[skip: a sample output of a status of a completed async search] -<1> Indicates that the async search was successfully completed +<1> Indicates that the async search was successfully completed. [source,console-result] @@ -301,13 +300,14 @@ code of the completed async search. -------------------------------------------------- // TEST[skip: a sample output of a status of a completed async search] -<1> Indicates that the async search was completed with an error +<1> Indicates that the async search was completed with an error. + [[delete-async-search]] ==== Delete async search -You can use the delete async search API to manually delete an async search -by ID. If the search is still running, the search request will be cancelled. +You can use the delete async search API to manually delete an async search by +ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. [source,console,id=delete-async-search-date-histogram-example]