Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add asynchronous search descriptions. #781

Merged
merged 3 commits into from
Jan 13, 2025
Merged

Add asynchronous search descriptions. #781

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6e467f7
Add asynchronous search descriptions.
Naarcha-AWS Jan 10, 2025
2ee36bd
Apply suggestions from code review
Naarcha-AWS Jan 10, 2025
cd09c98
Streamline formatting.
Naarcha-AWS Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions spec/namespaces/asynchronous_search.yaml
View file
Open in desktop
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: Monitors any asynchronous searches that are `running`, `completed`, `persisted`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Insert "or" prior to persisted.

externalDocs:
url: https://opensearch.org/docs/latest/search-plugins/async/index/#monitor-stats
responses:
Expand All @@ -64,19 +64,22 @@ 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 poll the remaining results based on an ID. The maximum value is 300 seconds. Default is `1s`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"The amount of time to wait for the results." Remove "that you plan".

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove "you want".

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"overruns this time" => "exceeds this amount of time"

schema:
type: string
asynchronous_search.search::query.index:
Expand Down
Loading