Skip to content

Commit

Permalink
feat: index param in async search (#6816)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
github-actions[bot] and Naarcha-AWS committed Apr 2, 2024
1 parent 28e3d60 commit 73b143a
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions _search-plugins/async/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. Can be an individual name, a comma-separated list of indexes, or a wildcard expression of index names. | All indexes in the cluster | No

#### Example request

Expand Down
2 changes: 1 addition & 1 deletion _security/access-control/users-roles.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ OpenSearch Dashboards provides a user-friendly interface for managing roles. Rol
### Editing the `roles.yml` file

If you want more granular control of your security configuration, you can edit roles and their associated permissions in the `roles.yml` file. This method provides direct access to the underlying configuration and can be version controlled for use in collaborative development environments.
For more information about creating roles, see the [Create roles][https://opensearch.org/docs/latest/security/access-control/users-roles/#create-roles) documentation.
For more information about creating roles, see the [Create roles](https://opensearch.org/docs/latest/security/access-control/users-roles/#create-roles) documentation.

Unless you need to create new [reserved or hidden users]({{site.url}}{{site.baseurl}}/security/access-control/api/#reserved-and-hidden-resources), we **highly** recommend using OpenSearch Dashboards or the REST API to create new users, roles, and role mappings. The `.yml` files are for initial setup, not ongoing use.
{: .warning }
Expand Down

0 comments on commit 73b143a

Please sign in to comment.