Skip to content

Add cat node -h enumerated values #4344

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.

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

Merged
merged 2 commits into from
May 6, 2025
Merged

Add cat node -h enumerated values #4344

merged 2 commits into from
May 6, 2025

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented May 6, 2025

This PR adds the enumerated values for the -h parameter in the cat nodes API.
They are copied from https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-nodes.html and implemented in a similar manner to the machine learning cat APIs, such as https://github.com/elastic/elasticsearch-specification/blob/main/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts

Copy link
Contributor

github-actions bot commented May 6, 2025

Following you can find the validation results for the APIs you have changed.

API Status Request Response
cat.aliases 🟢 29/29 29/29
cat.allocation 🟢 12/12 12/12
cat.component_templates 🟢 3/3 3/3
cat.count 🟢 9/9 9/9
cat.fielddata 🟢 6/6 6/6
cat.health 🟢 3/3 3/3
cat.help Missing test Missing test
cat.indices 🟢 33/33 32/32
cat.master 🟢 1/1 1/1
cat.ml_data_frame_analytics 🟢 5/5 5/5
cat.ml_datafeeds 🟢 4/4 4/4
cat.ml_jobs 🟢 4/4 4/4
cat.ml_trained_models 🟢 1/1 1/1
cat.nodeattrs 🟢 5/5 5/5
cat.nodes 🔴 10/11 11/11
cat.pending_tasks 🟢 1/1 1/1
cat.plugins 🟢 2/2 2/2
cat.recovery 🟢 6/6 6/6
cat.repositories 🟢 6/6 6/6
cat.segments 🟢 9/9 9/9
cat.shards 🟢 16/16 16/16
cat.snapshots 🟢 4/4 4/4
cat.tasks 🟢 11/11 11/11
cat.templates 🟢 17/17 17/17
cat.thread_pool 🟢 9/9 9/9
cat.transforms 🟢 7/7 7/7

You can validate these APIs yourself by using the make validate target.

@lcawl lcawl mentioned this pull request May 6, 2025
6 tasks
Copy link
Contributor

github-actions bot commented May 6, 2025

Following you can find the validation results for the APIs you have changed.

API Status Request Response
cat.aliases 🟢 29/29 29/29
cat.allocation 🟢 12/12 12/12
cat.component_templates 🟢 3/3 3/3
cat.count 🟢 9/9 9/9
cat.fielddata 🟢 6/6 6/6
cat.health 🟢 3/3 3/3
cat.help Missing test Missing test
cat.indices 🟢 33/33 32/32
cat.master 🟢 1/1 1/1
cat.ml_data_frame_analytics 🟢 5/5 5/5
cat.ml_datafeeds 🟢 4/4 4/4
cat.ml_jobs 🟢 4/4 4/4
cat.ml_trained_models 🟢 1/1 1/1
cat.nodeattrs 🟢 5/5 5/5
cat.nodes 🔴 10/11 11/11
cat.pending_tasks 🟢 1/1 1/1
cat.plugins 🟢 2/2 2/2
cat.recovery 🟢 6/6 6/6
cat.repositories 🟢 6/6 6/6
cat.segments 🟢 9/9 9/9
cat.shards 🟢 16/16 16/16
cat.snapshots 🟢 4/4 4/4
cat.tasks 🟢 11/11 11/11
cat.templates 🟢 17/17 17/17
cat.thread_pool 🟢 9/9 9/9
cat.transforms 🟢 7/7 7/7

You can validate these APIs yourself by using the make validate target.

@lcawl lcawl marked this pull request as ready for review May 6, 2025 02:33
@lcawl lcawl requested a review from a team May 6, 2025 14:30
Copy link
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lcawl lcawl merged commit af8422e into main May 6, 2025
8 checks passed
@lcawl lcawl deleted the cat-nodes-h branch May 6, 2025 16:34
github-actions bot pushed a commit that referenced this pull request May 6, 2025
github-actions bot pushed a commit that referenced this pull request May 6, 2025
github-actions bot pushed a commit that referenced this pull request May 6, 2025
lcawl added a commit that referenced this pull request May 6, 2025
(cherry picked from commit af8422e)

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
lcawl added a commit that referenced this pull request May 6, 2025
(cherry picked from commit af8422e)

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Comment on lines +559 to +560

export enum CatNodeColumn {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this! Note however that this enum should be marked as non-exhaustive, as values like heap.* are allowed. This is done by adding /** @non_exhaustive */ as a comment. See https://github.com/elastic/elasticsearch-specification/blob/main/docs/modeling-guide.md#enum for details.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in #4373

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants