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

Update asynchronous_search descriptions #687

Merged
merged 3 commits into from
Nov 26, 2024
Merged

Update asynchronous_search descriptions #687

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9408325
Update asynchronous_search descriptions
Naarcha-AWS Nov 21, 2024
79aeb91
Apply suggestions from code review
Naarcha-AWS Nov 22, 2024
4a9244f
Apply suggestions from code review
Naarcha-AWS Nov 25, 2024
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
8 changes: 4 additions & 4 deletions spec/namespaces/asynchronous_search.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,25 +64,25 @@
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 see whatever results you get within this time just like in a normal search. You can poll the remaining results based on an ID. The maximum value is 300 seconds.

Check warning on line 67 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": 67, "column": 132}}}, "severity": "WARNING"}
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
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.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
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:
Expand Down
Loading