Skip to content
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

Merged
merged 5 commits into from
May 6, 2020

Conversation

jakelandis
Copy link
Contributor

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

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
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-features (:Core/Features/CAT APIs)

@jakelandis jakelandis requested a review from russcam April 27, 2020 13:42
Copy link
Contributor

@russcam russcam left a 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

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

@Mpdreamz
Copy link
Member

In the 7.x branches these parameters can be documented as deprecated and the description could read that these parameters are effectively a noop or rejected by the server.

@jakelandis
Copy link
Contributor Author

In the 7.x branches these parameters can be documented as deprecated and the description could read that these parameters are effectively a noop or rejected by the server.

Will do, and will hold up this issue until that is done. (trying to ensure changes go through master first)

@jakelandis
Copy link
Contributor Author

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)

@jakelandis
Copy link
Contributor Author

blocked by #55984

@rjernst rjernst added the Team:Data Management Meta label for data/management team label May 4, 2020
@jakelandis
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/bwc
@elasticmachine run elasticsearch-ci/default-distro

@jakelandis
Copy link
Contributor Author

@elasticmachine update branch

@jakelandis
Copy link
Contributor Author

@elasticmachine update branch

@jakelandis jakelandis merged commit 32269f1 into elastic:master May 6, 2020
@jakelandis jakelandis deleted the fix_cat_rest_validation branch May 6, 2020 19:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Data Management/CAT APIs Text APIs behind /_cat >enhancement Team:Data Management Meta label for data/management team v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

cat thread_pool size enum empty string value
5 participants