Skip to content

Commit 8ab13c1

Browse files
committed
Expand docs for include_defaults
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.
1 parent e585438 commit 8ab13c1

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

specification/cluster/get_settings/ClusterGetSettingsRequest.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,12 @@ export interface Request extends RequestBase {
4545
*/
4646
flat_settings?: boolean
4747
/**
48-
* If `true`, returns default cluster settings from the local node.
48+
* If `true`, also returns default values for all other cluster settings, reflecting the values
49+
* in the `elasticsearch.yml` file of one of the nodes in the cluster. If the nodes in your
50+
* cluster do not all have the same values in their `elasticsearch.yml` config files then the
51+
* values returned by this API may vary from invocation to invocation and may not reflect the
52+
* values that Elasticsearch uses in all situations. Use the `GET _nodes/settings` API to
53+
* observe the settings on individual nodes in your cluster.
4954
* @server_default false
5055
*/
5156
include_defaults?: boolean

0 commit comments

Comments
 (0)