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.

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

feat: index param in async search #6816

Merged

Conversation

IanMenendez
Copy link
Contributor

@IanMenendez IanMenendez commented Mar 31, 2024

Description

  • Adds index param to async search
  • Fix typo in security plugin

Issues Resolved

Closes #6812

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@@ -31,6 +31,7 @@ Options | Description | Default value | Required
`wait_for_completion_timeout` | 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. | 1 second | No
`keep_on_completion` | 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. | `false` | No
`keep_alive` | 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. | 12 hours | No
`index` | The name of the index to be searched, or a comma-separated list or wildcard expression of index names. | searches on all cluster indexes | No
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
`index` | The name of the index to be searched, or a comma-separated list or wildcard expression of index names. | searches on all cluster indexes | No
`index` | 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. | All indexes in the cluster | No

@Naarcha-AWS Naarcha-AWS self-assigned this Apr 2, 2024
@Naarcha-AWS Naarcha-AWS added 4 - Doc review PR: Doc review in progress backport 2.12 PR: Backport label for 2.12 labels Apr 2, 2024
@Naarcha-AWS Naarcha-AWS merged commit 9f35e93 into opensearch-project:main Apr 2, 2024
3 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Apr 2, 2024
* feat: index param in async search

Signed-off-by: Ian Menendez <[email protected]>

* feat: requested changes

Signed-off-by: Ian Menendez <[email protected]>

---------

Signed-off-by: Ian Menendez <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit 9f35e93)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Naarcha-AWS added a commit that referenced this pull request Apr 2, 2024
* feat: index param in async search



* feat: requested changes



---------



(cherry picked from commit 9f35e93)

Signed-off-by: Ian Menendez <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4 - Doc review PR: Doc review in progress backport 2.12 PR: Backport label for 2.12
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Async search missing docs on "index" query parameter
3 participants