Skip to content

Expand docs for include_defaults #5052

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Expand docs for include_defaults #5052

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ab13c1
Expand docs for `include_defaults`
DaveCTurner Jul 29, 2025
efbd5cd
Merge branch 'main' into 2025/07/29/cluster-settings-include-defaults
DaveCTurner Jul 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion specification/cluster/get_settings/ClusterGetSettingsRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,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
* observe the settings on individual nodes in your cluster.
* @server_default false
*/
include_defaults?: boolean
Expand Down