Browse Source

ES|QL Minor async query doc parameter clarification (#104327)

This commit adds a minor clarification to an ESQL async query doc
parameter.
Chris Hegarty 1 year ago
parent
commit
5d6b833fe6
1 changed files with 3 additions and 2 deletions
  1. 3 2
      docs/reference/esql/esql-async-query-api.asciidoc

+ 3 - 2
docs/reference/esql/esql-async-query-api.asciidoc

@@ -93,8 +93,9 @@ parameters:
 Timeout duration to wait for the request to finish. Defaults to a 1 second,
 meaning the request waits for 1 second for the query results.
 
-If this parameter is specified and the request completes during this period,
-complete results are returned.
+If the query completes during this period then results will be
+returned. Otherwise, a query `id` is returned that can later be used to
+retrieve the results.
 
 If the request does not complete during this period, a query
 <<esql-async-query-api-response-body-query-id,id>> is returned.