-
Notifications
You must be signed in to change notification settings - Fork 24.9k
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
_cat/threadpool remove "size" and add "time" params #55736
Conversation
The rest spec and documentation for _cat/threadpool supports a "size" parameter. However, the "size" parameter will have no impact since there are no values of type "SizeValue" of the return value of this _cat api. This commit removes the "size" param from the spec and documentation. This commit also adds support for the "time" param since and support to format the time param for the "keep_alive" column. By default, the output should not change since the "TimeValue" rendered default (via RestTable) is toString(), and the code prior to this also called toString(). closes elastic#54478
Pinging @elastic/es-core-features (:Core/Features/CAT APIs) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
Client generators may use the params
in REST specs to generate methods/members/types for the allowed parameters for an API. For example
- the .NET client generates a
Size
enum and aSize?
property onCatThreadPoolRequestParameters
- the Rust client generates a
Size
enum and asize()
fn onCatThreadPool<'a, 'b>
- The go client generates a
Size
member onCatThreadPoolRequest
Because of this, I don't believe this change should be backported to 7.x, since it would result in removing these types and members within a major version in clients.
/cc @elastic/es-clients
In the |
Will do, and will hold up this issue until that is done. (trying to ensure changes go through master first) |
Removed the 7.x labels and will only merge this to 8.x. I am not adding the >breaking label because this is not technically breaking in ES. Clients (previous to this PR) that sent the "size" param will continue to work as it always did which has no impact on the result. (all the cat APIs support a common set of params and sometimes they are not applicable) |
blocked by #55984 |
@elasticmachine run elasticsearch-ci/bwc |
@elasticmachine update branch |
@elasticmachine update branch |
The rest spec and documentation for _cat/threadpool supports a "size" parameter.
However, the "size" parameter will have no impact since there are no values
of type "SizeValue" of the return value of this _cat api.
This commit removes the "size" param from the spec and documentation.
This commit also adds support for the "time" param since and support to
format the time param for the "keep_alive" column. By default, the output
should not change since the "TimeValue" rendered default (via RestTable)
is toString(), and the code prior to this also called toString().
closes #54478