Skip to content

Commit

Permalink
Add editorial comments to async search descriptions (#807)
Browse files Browse the repository at this point in the history
Signed-off-by: Naarcha-AWS <[email protected]>
  • Loading branch information
Naarcha-AWS authored Jan 25, 2025
1 parent 592336a commit 9df46f8
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions spec/namespaces/asynchronous_search.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ paths:
operationId: asynchronous_search.stats.0
x-operation-group: asynchronous_search.stats
x-version-added: '1.0'
description: Monitors any asynchronous searches that are `running`, `completed`, `persisted`.
description: Monitors any asynchronous searches that are `running`, `completed`, or `persisted`.
externalDocs:
url: https://opensearch.org/docs/latest/search-plugins/async/index/#monitor-stats
responses:
Expand All @@ -64,13 +64,13 @@ 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. You can poll the remaining results based on an ID. The maximum value is 300 seconds. Default is `1s`.
description: The amount of time to wait for the results. You can poll the remaining results based on an ID. The maximum value is 300 seconds. 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. You can examine the stored results at a later time.
description: Whether to save the results in the cluster after the search is complete. You can examine the stored results at a later time.
schema:
type: boolean
asynchronous_search.search::query.keep_alive:
Expand All @@ -79,7 +79,7 @@ components:
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.
If the query exceeds this amount of time, the process cancels this query automatically.
schema:
type: string
asynchronous_search.search::query.index:
Expand Down

0 comments on commit 9df46f8

Please sign in to comment.