Skip to content

Adds cat node -h values #4771

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

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

Conversation

charlotte-hoblik
Copy link
Contributor

This PR adds the enumerated values for the -h parameter in the following APIs:

Related issue: #4345

Copy link
Contributor

github-actions bot commented Jul 3, 2025

Following you can find the validation changes for the API you have modified.

API Status Request Response
cat.thread_pool 🟢 → 🔴 9/9 → 5/9 9/9

You can validate this API yourself by using the make validate target.

* * `MANUAL_ALLOCATION`: The shard’s allocation was last modified by the Cluster reroute API.
* * `NEW_INDEX_RESTORED`: Unassigned as a result of restoring into a new index.
* * `NODE_LEFT`: Unassigned as a result of the node hosting it leaving the cluster.
* * `NODE_RESTARTING`: Similar to NODE_LEFT, except that the node was registered as restarting using the Node shutdown API.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* * `NODE_RESTARTING`: Similar to NODE_LEFT, except that the node was registered as restarting using the Node shutdown API.
* * `NODE_RESTARTING`: Similar to `NODE_LEFT`, except that the node was registered as restarting using the Node shutdown API.

/** @non_exhaustive */
export enum CatShardColumn {
/**
* The size of completion. For example: `0b`.
Copy link
Contributor

Choose a reason for hiding this comment

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

The size of completion. For example: 0b.

Not a big deal but I noticed this one starts with "The" and the rest don't. IMO they ought to be consistent.

@lcawl
Copy link
Contributor

lcawl commented Jul 3, 2025

I tested the output by running the following commands:

make generate
make transform-to-openapi-for-docs
make overlay

And the output looks good when I upload it to our publishing site. For example:

image

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

Left two minor comments, otherwise output LGTM!

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.

2 participants