Skip to content

Commit 0d53fd7

Browse files
committed
Fixed non-boolean defaults.
Signed-off-by: dblock <dblock@amazon.com>
1 parent 4e0615c commit 0d53fd7

File tree

12 files changed

+14
-14
lines changed

12 files changed

+14
-14
lines changed

_api-reference/count.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Parameter | Type | Description
8282
`allow_no_indices` | Boolean | If false, the request returns an error if any wildcard expression or index alias targets any closed or missing indexes. Default is `false`.
8383
`analyzer` | String | The analyzer to use in the query string.
8484
`analyze_wildcard` | Boolean | Specifies whether to analyze wildcard and prefix queries. Default is `false`.
85-
`default_operator` | String | Indicates whether the default operator for a string query should be AND or OR. Default is OR.
85+
`default_operator` | String | Indicates whether the default operator for a string query should be `AND` or `OR`. Default is `OR`.
8686
`df` | String | The default field in case a field prefix is not provided in the query string.
8787
`expand_wildcards` | String | Specifies the type of index that wildcard expressions can match. Supports comma-separated values. Valid values are `all` (match any index), `open` (match open, non-hidden indexes), `closed` (match closed, non-hidden indexes), `hidden` (match hidden indexes), and `none` (deny wildcard expressions). Default is `open`.
8888
`ignore_unavailable` | Boolean | Specifies whether to include missing or closed indexes in the response. Default is `false`.

_api-reference/document-apis/delete-by-query.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ allow_no_indices | Boolean | Whether to ignore wildcards that don’t match any
4444
analyzer | String | The analyzer to use in the query string.
4545
analyze_wildcard | Boolean | Specifies whether to analyze wildcard and prefix queries. Default is `false`.
4646
conflicts | String | Indicates to OpenSearch what should happen if the delete by query operation runs into a version conflict. Valid options are `abort` and `proceed`. Default is `abort`.
47-
default_operator | String | Indicates whether the default operator for a string query should be AND or OR. Default is OR.
47+
default_operator | String | Indicates whether the default operator for a string query should be `AND` or `OR`. Default is `OR`.
4848
df | String | The default field in case a field prefix is not provided in the query string.
4949
expand_wildcards | String | Specifies the type of index that wildcard expressions can match. Supports comma-separated values. Valid values are `all` (match any index), `open` (match open, non-hidden indexes), `closed` (match closed, non-hidden indexes), `hidden` (match hidden indexes), and `none` (deny wildcard expressions). Default is `open`.
5050
from | Integer | The starting index to search from. Default is 0.

_api-reference/document-apis/multi-get.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ All multi-get URL parameters are optional.
2929
Parameter | Type | Description
3030
:--- | :--- | :--- | :---
3131
&lt;index&gt; | String | Name of the index to retrieve documents from.
32-
preference | String | Specifies the nodes or shards OpenSearch should execute the multi-get operation on. Default is random.
32+
preference | String | Specifies the nodes or shards OpenSearch should execute the multi-get operation on. Default is `random`.
3333
realtime | Boolean | Specifies whether the operation should run in realtime. If false, the operation waits for the index to refresh to analyze the source to retrieve data, which makes the operation near-realtime. Default is `true`.
3434
refresh | Boolean | If true, OpenSearch refreshes shards to make the multi-get operation available to search results. Valid options are `true`, `false`, and `wait_for`, which tells OpenSearch to wait for a refresh before executing the operation. Default is `false`.
3535
routing | String | Value used to route the multi-get operation to a specific shard.

_api-reference/index-apis/close-index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Parameter | Type | Description
3434
:--- | :--- | :---
3535
&lt;index-name&gt; | String | The index to close. Can be a comma-separated list of multiple index names. Use `_all` or * to close all indexes.
3636
allow_no_indices | Boolean | Whether to ignore wildcards that don't match any indexes. Default is `true`.
37-
expand_wildcards | String | Expands wildcard expressions to different indexes. Combine multiple values with commas. Available values are all (match all indexes), open (match open indexes), closed (match closed indexes), hidden (match hidden indexes), and none (do not accept wildcard expressions). Default is open.
37+
expand_wildcards | String | Expands wildcard expressions to different indexes. Combine multiple values with commas. Available values are all (match all indexes), open (match open indexes), closed (match closed indexes), hidden (match hidden indexes), and none (do not accept wildcard expressions). Default is `open`.
3838
ignore_unavailable | Boolean | If true, OpenSearch does not search for missing or closed indexes. Default is `false`.
3939
wait_for_active_shards | String | Specifies the number of active shards that must be available before OpenSearch processes the request. Default is 1 (only the primary shard). Set to all or a positive integer. Values greater than 1 require replicas. For example, if you specify a value of 3, the index must have two replicas distributed across two additional nodes for the request to succeed.
4040
cluster_manager_timeout | Time | How long to wait for a connection to the cluster manager node. Default is `30s`.

_api-reference/index-apis/delete-index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ All parameters are optional.
3232
Parameter | Type | Description
3333
:--- | :--- | :---
3434
allow_no_indices | Boolean | Whether to ignore wildcards that don't match any indexes. Default is `true`.
35-
expand_wildcards | String | Expands wildcard expressions to different indexes. Combine multiple values with commas. Available values are all (match all indexes), open (match open indexes), closed (match closed indexes), hidden (match hidden indexes), and none (do not accept wildcard expressions), which must be used with open, closed, or both. Default is open.
35+
expand_wildcards | String | Expands wildcard expressions to different indexes. Combine multiple values with commas. Available values are all (match all indexes), open (match open indexes), closed (match closed indexes), hidden (match hidden indexes), and none (do not accept wildcard expressions), which must be used with open, closed, or both. Default is `open`.
3636
ignore_unavailable | Boolean | If true, OpenSearch does not include missing or closed indexes in the response.
3737
cluster_manager_timeout | Time | How long to wait for a connection to the cluster manager node. Default is `30s`.
3838
timeout | Time | How long to wait for the response to return. Default is `30s`.

_api-reference/index-apis/exists.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ All parameters are optional.
3333
Parameter | Type | Description
3434
:--- | :--- | :---
3535
allow_no_indices | Boolean | Whether to ignore wildcards that don't match any indexes. Default is `true`.
36-
expand_wildcards | String | Expands wildcard expressions to different indexes. Combine multiple values with commas. Available values are all (match all indexes), open (match open indexes), closed (match closed indexes), hidden (match hidden indexes), and none (do not accept wildcard expressions). Default is open.
36+
expand_wildcards | String | Expands wildcard expressions to different indexes. Combine multiple values with commas. Available values are all (match all indexes), open (match open indexes), closed (match closed indexes), hidden (match hidden indexes), and none (do not accept wildcard expressions). Default is `open`.
3737
flat_settings | Boolean | Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of "index": { "creation_date": "123456789" } is "index.creation_date": "123456789".
3838
include_defaults | Boolean | Whether to include default settings as part of the response. This parameter is useful for identifying the names and current values of settings you want to update.
3939
ignore_unavailable | Boolean | If true, OpenSearch does not search for missing or closed indexes. Default is `false`.

_api-reference/index-apis/get-index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ All parameters are optional.
3333
Parameter | Type | Description
3434
:--- | :--- | :---
3535
allow_no_indices | Boolean | Whether to ignore wildcards that don't match any indexes. Default is `true`.
36-
expand_wildcards | String | Expands wildcard expressions to different indexes. Combine multiple values with commas. Available values are all (match all indexes), open (match open indexes), closed (match closed indexes), hidden (match hidden indexes), and none (do not accept wildcard expressions), which must be used with open, closed, or both. Default is open.
36+
expand_wildcards | String | Expands wildcard expressions to different indexes. Combine multiple values with commas. Available values are all (match all indexes), open (match open indexes), closed (match closed indexes), hidden (match hidden indexes), and none (do not accept wildcard expressions), which must be used with open, closed, or both. Default is `open`.
3737
flat_settings | Boolean | Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of "index": { "creation_date": "123456789" } is "index.creation_date": "123456789".
3838
include_defaults | Boolean | Whether to include default settings as part of the response. This parameter is useful for identifying the names and current values of settings you want to update.
3939
ignore_unavailable | Boolean | If true, OpenSearch does not include missing or closed indexes in the response.

_api-reference/index-apis/open-index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Parameter | Type | Description
3434
:--- | :--- | :---
3535
&lt;index-name&gt; | String | The index to open. Can be a comma-separated list of multiple index names. Use `_all` or * to open all indexes.
3636
allow_no_indices | Boolean | Whether to ignore wildcards that don't match any indexes. Default is `true`.
37-
expand_wildcards | String | Expands wildcard expressions to different indexes. Combine multiple values with commas. Available values are all (match all indexes), open (match open indexes), closed (match closed indexes), hidden (match hidden indexes), and none (do not accept wildcard expressions). Default is open.
37+
expand_wildcards | String | Expands wildcard expressions to different indexes. Combine multiple values with commas. Available values are all (match all indexes), open (match open indexes), closed (match closed indexes), hidden (match hidden indexes), and none (do not accept wildcard expressions). Default is `open`.
3838
ignore_unavailable | Boolean | If true, OpenSearch does not search for missing or closed indexes. Default is `false`.
3939
wait_for_active_shards | String | Specifies the number of active shards that must be available before OpenSearch processes the request. Default is 1 (only the primary shard). Set to all or a positive integer. Values greater than 1 require replicas. For example, if you specify a value of 3, the index must have two replicas distributed across two additional nodes for the request to succeed.
4040
cluster_manager_timeout | Time | How long to wait for a connection to the cluster manager node. Default is `30s`.

_dashboards/visualize/visbuilder.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Follow these steps to create a new visualization using VisBuilder in your enviro
2727

2828
1. Open Dashboards:
2929
- If you're not running the Security plugin, go to http://localhost:5601.
30-
- If you're running the Security plugin, go to https://localhost:5601 and log in with your username and password (default is admin/admin).
30+
- If you're running the Security plugin, go to https://localhost:5601 and log in with your username and password (default is `admin/admin`).
3131

3232
1. From the top menu, select **Visualize > Create visualization > VisBuilder**.
3333

_im-plugin/index-transforms/transforms-apis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -447,7 +447,7 @@ from | The starting transform to return. Default is 0. | No
447447
size | Specifies the number of transforms to return. Default is 10. | No
448448
search |The search term to use to filter results. | No
449449
sortField | The field to sort results with. | No
450-
sortDirection | Specifies the direction to sort results in. Can be `ASC` or `DESC`. Default is ASC. | No
450+
sortDirection | Specifies the direction to sort results in. Can be `ASC` or `DESC`. Default is `ASC`. | No
451451

452452
#### Sample Request
453453

0 commit comments

Comments
 (0)