Update asynchronous_search descriptions (#687)

* Update asynchronous_search descriptions Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Naarcha-AWS <[email protected]>
opensearch-project · Nov 26, 2024 · d7d6520 · d7d6520
1 parent 610557a
commit d7d6520
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/spec/namespaces/asynchronous_search.yaml b/spec/namespaces/asynchronous_search.yaml
@@ -64,25 +64,25 @@ components:
     asynchronous_search.search::query.wait_for_completion_timeout:
       name: wait_for_completion_timeout
       in: query
-      description: The amount of time that you plan to wait for the results.
+      description: The amount of time that you plan to wait for the results. You can poll the remaining results based on an ID. The maximum value is `300s`. Default is `1s`.
       schema:
         type: string
     asynchronous_search.search::query.keep_on_completion:
       name: keep_on_completion
       in: query
-      description: Whether you want to save the results in the cluster after the search is complete.
+      description: Whether you want to save the results in the cluster after the search is complete. 
       schema:
         type: boolean
     asynchronous_search.search::query.keep_alive:
       name: keep_alive
       in: query
-      description: The amount of time that the result is saved in the cluster.
+      description: The amount of time that the result is saved in the cluster. For example, `2d` means that the results are stored in the cluster for 48 hours. The saved search results are deleted after this period or if the search is canceled. Note that this includes the query execution time. If the query overruns this time, the process cancels this query automatically.
       schema:
         type: string
     asynchronous_search.search::query.index:
       name: index
       in: query
-      description: The name of the index to be searched.
+      description: The name of the index to be searched. Can be an individual name, a comma-separated list of indexes, or a wildcard expression of index names.
       schema:
         type: string
     asynchronous_search.get::path.id: