Introduce NodeStatsLevel enum for nodes stats API #5265
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Following you can find the validation changes against the target branch for the APIs. No changes detected. You can validate these APIs yourself by using the |
pquentin
reviewed
Sep 8, 2025
There was a problem hiding this comment.
The problem here is that Level is used in 3 different APIs. While it's the same enum in the specification, there are two different enums in Elasticsearch:
- Node stats:
/_nodes/statsuses NodeStatsLevel - Index stats:
/_statsuses ClusterStatsLevel - Cluster health:
/_cluster/healthuses ClusterStatsLevel
And they are different!
- NodeStatsLevel supports node, indices and shards
- ClusterStatsLevel supports cluster, indices and shards
The proper fix would be to use two enums, but that would be a breaking change. Another option is to add node to Level without removing cluster, with a comment explaining in which API they are available.
It supports 'node' instead of 'cluster' like Level, which is really ClusterStatsLevel.
pquentin
changed the title
|
We discussed this with @l-trotta and @Anaethelion, and we decided to introduce a NodeStatsLevel enum since using |
l-trotta
approved these changes
Sep 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR fixes an error in the documentation: changes the vales of the Level string from
cluster, indices or shardstonode, indices or shardsConnected to: elastic/docs-content#1258