From cc230cde094b3767374acacff2794497807dcb14 Mon Sep 17 00:00:00 2001 From: dblock Date: Tue, 9 Jul 2024 12:42:57 -0400 Subject: [PATCH 1/2] Fix: the value of include_defaults is a boolean. Signed-off-by: dblock --- _api-reference/index-apis/get-settings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_api-reference/index-apis/get-settings.md b/_api-reference/index-apis/get-settings.md index 41eb4ea113..06d004d937 100644 --- a/_api-reference/index-apis/get-settings.md +++ b/_api-reference/index-apis/get-settings.md @@ -40,7 +40,7 @@ Parameter | Data 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`. 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 | String | Whether to include default settings, including settings used within OpenSearch plugins, in the response. Default is false. +include_defaults | Boolean | Whether to include default settings, including settings used within OpenSearch plugins, in the response. Default is false. ignore_unavailable | Boolean | If true, OpenSearch does not include missing or closed indexes in the response. local | Boolean | Whether to return information from the local node only instead of the cluster manager node. Default is false. cluster_manager_timeout | Time | How long to wait for a connection to the cluster manager node. Default is `30s`. From 21332ae0535a7bfde8d1696780bb2eb1c8e82515 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Tue, 9 Jul 2024 12:01:53 -0500 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- _api-reference/index-apis/get-settings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_api-reference/index-apis/get-settings.md b/_api-reference/index-apis/get-settings.md index 06d004d937..9ad0078757 100644 --- a/_api-reference/index-apis/get-settings.md +++ b/_api-reference/index-apis/get-settings.md @@ -40,7 +40,7 @@ Parameter | Data 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`. 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, including settings used within OpenSearch plugins, in the response. Default is false. +include_defaults | Boolean | Whether to include default settings, including settings used within OpenSearch plugins, in the response. Default is `false`. ignore_unavailable | Boolean | If true, OpenSearch does not include missing or closed indexes in the response. local | Boolean | Whether to return information from the local node only instead of the cluster manager node. Default is false. cluster_manager_timeout | Time | How long to wait for a connection to the cluster manager node. Default is `30s`.