Skip to content

Commit

Permalink
Add asynchronous search descriptions.
Browse files Browse the repository at this point in the history
Signed-off-by: Archer <[email protected]>
  • Loading branch information
Naarcha-AWS committed Jan 10, 2025
1 parent f021351 commit 6e467f7
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions spec/namespaces/asynchronous_search.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ paths:
operationId: asynchronous_search.search.0
x-operation-group: asynchronous_search.search
x-version-added: '1.0'
description: Perform an asynchronous search.
description: Performs an asynchronous search.
externalDocs:
url: https://opensearch.org/docs/latest/search-plugins/async/index/#rest-api
parameters:
Expand All @@ -27,7 +27,7 @@ paths:
operationId: asynchronous_search.get.0
x-operation-group: asynchronous_search.get
x-version-added: '1.0'
description: Get partial responses from asynchronous search.
description: Gets partial responses from an asynchronous search.
externalDocs:
url: https://opensearch.org/docs/latest/search-plugins/async/index/#get-partial-results
parameters:
Expand All @@ -39,7 +39,7 @@ paths:
operationId: asynchronous_search.delete.0
x-operation-group: asynchronous_search.delete
x-version-added: '1.0'
description: Delete asynchronous search.
description: Deletes any responses from an asynchronous search.
externalDocs:
url: https://opensearch.org/docs/latest/search-plugins/async/index/#delete-searches-and-results
parameters:
Expand All @@ -52,7 +52,7 @@ paths:
operationId: asynchronous_search.stats.0
x-operation-group: asynchronous_search.stats
x-version-added: '1.0'
description: Monitoring of asynchronous searches that are running, completed, and/or persisted.
description: Monitor any asynchronous searches that are `running`, `completed`, `persisted`.
externalDocs:
url: https://opensearch.org/docs/latest/search-plugins/async/index/#monitor-stats
responses:
Expand All @@ -64,19 +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. You can poll the remaining results based on an ID. The maximum value is `300s`. Default is `1s`.
description: |-
The amount of time that you plan to wait for the results.
You can see whatever results you get within this time just like in a normal search.

Check warning on line 69 in spec/namespaces/asynchronous_search.yaml

View workflow job for this annotation

GitHub Actions / check

[vale] reported by reviewdog 🐶 [OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead. Raw Output: {"message": "[OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.", "location": {"path": "spec/namespaces/asynchronous_search.yaml", "range": {"start": {"line": 69, "column": 63}}}, "severity": "WARNING"}
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.
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.
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. 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.
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:
Expand Down

0 comments on commit 6e467f7

Please sign in to comment.