From 85f9c0f06a10d5630c83dfb3e033e6a2ebae4f6d Mon Sep 17 00:00:00 2001 From: Ian Menendez Date: Mon, 1 Apr 2024 12:20:48 -0300 Subject: [PATCH 1/2] feat: index param in async search Signed-off-by: Ian Menendez --- _search-plugins/async/index.md | 1 + _security/access-control/users-roles.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/_search-plugins/async/index.md b/_search-plugins/async/index.md index a663e7faf9..5bd0756f60 100644 --- a/_search-plugins/async/index.md +++ b/_search-plugins/async/index.md @@ -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 #### Example request diff --git a/_security/access-control/users-roles.md b/_security/access-control/users-roles.md index ae7670bc29..687796d0c4 100644 --- a/_security/access-control/users-roles.md +++ b/_security/access-control/users-roles.md @@ -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 } From ff6dbcb35993f44a047f8ccd2206946c587072af Mon Sep 17 00:00:00 2001 From: Ian Menendez Date: Tue, 2 Apr 2024 09:36:35 -0300 Subject: [PATCH 2/2] feat: requested changes Signed-off-by: Ian Menendez --- _search-plugins/async/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_search-plugins/async/index.md b/_search-plugins/async/index.md index 5bd0756f60..099279ba91 100644 --- a/_search-plugins/async/index.md +++ b/_search-plugins/async/index.md @@ -31,7 +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 +`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