Fixed non-boolean defaults.

Signed-off-by: dblock <[email protected]>
opensearch-project · Jul 9, 2024 · a5c2292 · a5c2292
1 parent 5b11b19
commit a5c2292
Show file tree

Hide file tree

Showing 12 changed files with 14 additions and 14 deletions.
diff --git a/_api-reference/count.md b/_api-reference/count.md
@@ -82,7 +82,7 @@ Parameter | Type | Description
 `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`.
 `analyzer` | String | The analyzer to use in the query string.
 `analyze_wildcard` | Boolean | Specifies whether to analyze wildcard and prefix queries. Default is `false`.
-`default_operator` | String | Indicates whether the default operator for a string query should be AND or OR. Default is OR.
+`default_operator` | String | Indicates whether the default operator for a string query should be `AND` or `OR`. Default is `OR`.
 `df` | String | The default field in case a field prefix is not provided in the query string.
 `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`.
 `ignore_unavailable` | Boolean | Specifies whether to include missing or closed indexes in the response. Default is `false`.

diff --git a/_api-reference/document-apis/delete-by-query.md b/_api-reference/document-apis/delete-by-query.md
@@ -44,7 +44,7 @@ allow_no_indices | Boolean | Whether to ignore wildcards that don’t match any
 analyzer | String | The analyzer to use in the query string.
 analyze_wildcard | Boolean | Specifies whether to analyze wildcard and prefix queries. Default is `false`.
 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`.
-default_operator | String | Indicates whether the default operator for a string query should be AND or OR. Default is OR.
+default_operator | String | Indicates whether the default operator for a string query should be `AND` or `OR`. Default is `OR`.
 df | String | The default field in case a field prefix is not provided in the query string.
 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`.
 from | Integer | The starting index to search from. Default is 0.

diff --git a/_api-reference/document-apis/multi-get.md b/_api-reference/document-apis/multi-get.md
@@ -29,7 +29,7 @@ All multi-get URL parameters are optional.
 Parameter | Type | Description
 :--- | :--- | :--- | :---
 &lt;index&gt; | String | Name of the index to retrieve documents from.
-preference | String | Specifies the nodes or shards OpenSearch should execute the multi-get operation on. Default is random.
+preference | String | Specifies the nodes or shards OpenSearch should execute the multi-get operation on. Default is `random`.
 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`.
 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`.
 routing | String | Value used to route the multi-get operation to a specific shard.

diff --git a/_api-reference/index-apis/close-index.md b/_api-reference/index-apis/close-index.md
@@ -34,7 +34,7 @@ Parameter | Type | Description
 :--- | :--- | :---
 &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.
 allow_no_indices | Boolean | Whether to ignore wildcards that don't match any indexes. Default is `true`.
-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.
+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`.
 ignore_unavailable | Boolean | If true, OpenSearch does not search for missing or closed indexes. Default is `false`.
 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.
 cluster_manager_timeout | Time | How long to wait for a connection to the cluster manager node. Default is `30s`.

diff --git a/_api-reference/index-apis/delete-index.md b/_api-reference/index-apis/delete-index.md
@@ -32,7 +32,7 @@ All parameters are optional.
 Parameter | Type | Description
 :--- | :--- | :---
 allow_no_indices | Boolean | Whether to ignore wildcards that don't match any indexes. Default is `true`.
-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.
+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`.
 ignore_unavailable | Boolean | If true, OpenSearch does not include missing or closed indexes in the response.
 cluster_manager_timeout | Time | How long to wait for a connection to the cluster manager node. Default is `30s`.
 timeout | Time | How long to wait for the response to return. Default is `30s`.

diff --git a/_api-reference/index-apis/exists.md b/_api-reference/index-apis/exists.md
@@ -33,7 +33,7 @@ All parameters are optional.
 Parameter | Type | Description
 :--- | :--- | :---
 allow_no_indices | Boolean | Whether to ignore wildcards that don't match any indexes. Default is `true`.
-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.
+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`.
 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".
 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.
 ignore_unavailable | Boolean | If true, OpenSearch does not search for missing or closed indexes. Default is `false`.

diff --git a/_api-reference/index-apis/get-index.md b/_api-reference/index-apis/get-index.md
@@ -33,7 +33,7 @@ All parameters are optional.
 Parameter | Type | Description
 :--- | :--- | :---
 allow_no_indices | Boolean | Whether to ignore wildcards that don't match any indexes. Default is `true`.
-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.
+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`.
 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".
 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.
 ignore_unavailable | Boolean | If true, OpenSearch does not include missing or closed indexes in the response.

diff --git a/_api-reference/index-apis/open-index.md b/_api-reference/index-apis/open-index.md
@@ -34,7 +34,7 @@ Parameter | Type | Description
 :--- | :--- | :---
 &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.
 allow_no_indices | Boolean | Whether to ignore wildcards that don't match any indexes. Default is `true`.
-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.
+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`.
 ignore_unavailable | Boolean | If true, OpenSearch does not search for missing or closed indexes. Default is `false`.
 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.
 cluster_manager_timeout | Time | How long to wait for a connection to the cluster manager node. Default is `30s`.

diff --git a/_dashboards/visualize/visbuilder.md b/_dashboards/visualize/visbuilder.md
@@ -27,7 +27,7 @@ Follow these steps to create a new visualization using VisBuilder in your enviro
 
 1. Open Dashboards:
     - If you're not running the Security plugin, go to http://localhost:5601.
-    - If you're running the Security plugin, go to https://localhost:5601 and log in with your username and password (default is admin/admin).
+    - If you're running the Security plugin, go to https://localhost:5601 and log in with your username and password (default is `admin/admin`).
 
 1. From the top menu, select **Visualize > Create visualization > VisBuilder**.
 

diff --git a/_im-plugin/index-transforms/transforms-apis.md b/_im-plugin/index-transforms/transforms-apis.md
@@ -447,7 +447,7 @@ from | The starting transform to return. Default is 0. | No
 size | Specifies the number of transforms to return. Default is 10. | No
 search |The search term to use to filter results. | No
 sortField | The field to sort results with. | No
-sortDirection | Specifies the direction to sort results in. Can be `ASC` or `DESC`. Default is ASC. | No
+sortDirection | Specifies the direction to sort results in. Can be `ASC` or `DESC`. Default is `ASC`. | No
 
 #### Sample Request
 

diff --git a/_security/configuration/tls.md b/_security/configuration/tls.md
@@ -52,11 +52,11 @@ The following settings configure the location and password of your keystore and
 
 Name | Description
 :--- | :---
-`plugins.security.ssl.transport.keystore_type` | The type of the keystore file, JKS or PKCS12/PFX. Optional. Default is JKS.
+`plugins.security.ssl.transport.keystore_type` | The type of the keystore file, `JKS` or `PKCS12/PFX`. Optional. Default is `JKS`.
 `plugins.security.ssl.transport.keystore_filepath` | Path to the keystore file, which must be under the `config` directory, specified using a relative path. Required.
 `plugins.security.ssl.transport.keystore_alias` | The alias name of the keystore. Optional. Default is the first alias.
 `plugins.security.ssl.transport.keystore_password` | Keystore password. Default is `changeit`.
-`plugins.security.ssl.transport.truststore_type` | The type of the truststore file, JKS or PKCS12/PFX. Default is JKS.
+`plugins.security.ssl.transport.truststore_type` | The type of the truststore file, `JKS` or `PKCS12/PFX`. Default is `JKS`.
 `plugins.security.ssl.transport.truststore_filepath` | Path to the truststore file, which must be under the `config` directory, specified using a relative path. Required.
 `plugins.security.ssl.transport.truststore_alias` | The alias name of the truststore. Optional. Default is all certificates.
 `plugins.security.ssl.transport.truststore_password` | Truststore password. Default is `changeit`.

diff --git a/_tuning-your-cluster/availability-and-recovery/snapshots/sm-api.md b/_tuning-your-cluster/availability-and-recovery/snapshots/sm-api.md
@@ -181,7 +181,7 @@ Parameter | Type | Description
 `enabled` | Boolean | Should this SM policy be enabled at creation? Optional.
 `snapshot_config` | Object | The configuration options for snapshot creation. Required.
 `snapshot_config.date_format` | String | Snapshot names have the format `<policy_name>-<date>-<random number>`. `date_format` specifies the format for the date in the snapshot name. Supports all date formats supported by OpenSearch. Optional. Default is "yyyy-MM-dd'T'HH:mm:ss".
-`snapshot_config.date_format_timezone` | String | Snapshot names have the format `<policy_name>-<date>-<random number>`. `date_format_timezone` specifies the time zone for the date in the snapshot name. Optional. Default is UTC.
+`snapshot_config.date_format_timezone` | String | Snapshot names have the format `<policy_name>-<date>-<random number>`. `date_format_timezone` specifies the time zone for the date in the snapshot name. Optional. Default is `UTC`.
 `snapshot_config.indices` | String | The names of the indexes in the snapshot. Multiple index names are separated by `,`. Supports wildcards (`*`). Optional. Default is `*` (all indexes).
 `snapshot_config.repository` | String | The repository in which to store snapshots. Required.
 `snapshot_config.ignore_unavailable` | Boolean | Do you want to ignore unavailable indexes? Optional. Default is `false`.
@@ -197,7 +197,7 @@ Parameter | Type | Description
 `deletion.delete_condition` | Object | Conditions for snapshot deletion. Optional. 
 `deletion.delete_condition.max_count` | Integer | The maximum number of snapshots to be retained. Optional.
 `deletion.delete_condition.max_age` | String | The maximum time a snapshot is retained. Optional.
-`deletion.delete_condition.min_count` | Integer | The minimum number of snapshots to be retained. Optional. Default is one.
+`deletion.delete_condition.min_count` | Integer | The minimum number of snapshots to be retained. Optional. Default is 1.
 `notification` | Object | Defines notifications for SM events. Optional.
 `notification.channel` | Object | Defines a channel for notifications. You must [create and configure a notification channel]({{site.url}}{{site.baseurl}}/notifications-plugin/api) before setting up SM notifications. Required.
 `notification.channel.id` | String | The channel ID of the channel used for notifications. To get the channel IDs of all created channels, use `GET _plugins/_notifications/configs`. Required.