From 0e734ad54526957d8d461601689889a8b57ef7b3 Mon Sep 17 00:00:00 2001 From: David Turner Date: Thu, 7 Aug 2025 20:51:33 +0100 Subject: [PATCH] Expand docs for `include_defaults` (#5052) This parameter is trappy, its notion of "default" includes the values from some arbitrary node's `elasticsearch.yml` file which means they aren't really defaults. But then again the real default values would be even less useful in the (common) case that some setting is overridden on all nodes. Co-authored-by: Dianna Hohensee (cherry picked from commit 4d0434b393d222777797568fcb994bef39757fd1) --- .../cluster/get_settings/ClusterGetSettingsRequest.ts | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/specification/cluster/get_settings/ClusterGetSettingsRequest.ts b/specification/cluster/get_settings/ClusterGetSettingsRequest.ts index e9738535fb..b0ee416818 100644 --- a/specification/cluster/get_settings/ClusterGetSettingsRequest.ts +++ b/specification/cluster/get_settings/ClusterGetSettingsRequest.ts @@ -44,7 +44,12 @@ export interface Request extends RequestBase { */ flat_settings?: boolean /** - * If `true`, returns default cluster settings from the local node. + * If `true`, also returns default values for all other cluster settings, reflecting the values + * in the `elasticsearch.yml` file of one of the nodes in the cluster. If the nodes in your + * cluster do not all have the same values in their `elasticsearch.yml` config files then the + * values returned by this API may vary from invocation to invocation and may not reflect the + * values that Elasticsearch uses in all situations. Use the `GET _nodes/settings` API to + * fetch the settings for each individual node in your cluster. * @server_default false */ include_defaults?: boolean