KAFKA-17051: ApiKeys#toHtml should exclude the APIs having unstable latest version #16480
Conversation
This file contains 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
chia7712
reviewed
Jun 28, 2024
| @@ -332,6 +332,7 @@ public static EnumSet<ApiKeys> controllerApis() { | |||
| public static EnumSet<ApiKeys> clientApis() { | |||
| List<ApiKeys> apis = Arrays.stream(ApiKeys.values()) | |||
| .filter(apiKey -> apiKey.inScope(ApiMessageType.ListenerType.ZK_BROKER) || apiKey.inScope(ApiMessageType.ListenerType.BROKER)) | |||
| .filter(apiKey -> !apiKey.messageType.latestVersionUnstable()) | |||
There was a problem hiding this comment.
We can't add this change to clientApis since it is used by other callers. Please add the filter into toHtml. Also, please have test for it
|
@chia7712, Thanks for your review, PTAL |
|
@chia7712, Thanks for your comments, PTAL |
chia7712
reviewed
Jun 30, 2024
docs/protocol.html
Outdated
| @@ -200,7 +200,7 @@ <h5 class="anchor-heading"><a id="protocol_error_codes" class="anchor-link"></a> | |||
| <!--#include virtual="generated/protocol_errors.html" --> | |||
|
|
|||
| <h5 class="anchor-heading"><a id="protocol_api_keys" class="anchor-link"></a><a href="#protocol_api_keys">Api Keys</a></h5> | |||
| <p>The following are the numeric codes that the ApiKey in the request can take for each of the below request types.</p> | |||
| <p>The following are the numeric codes that the ApiKey which last version is stable in the request can take for each of the below request types.</p> | |||
There was a problem hiding this comment.
maybe stable ApiKey is good enough?
There was a problem hiding this comment.
Yes, If ApiKey only have last version, I agree that use stable ApiKey is good enough
chia7712
reviewed
Jul 1, 2024
| String html = ApiKeys.toHtml(); | ||
| for (ApiKeys apiKeys : ApiKeys.clientApis()) { | ||
| if (apiKeys.messageType.latestVersionUnstable()) { | ||
| assertFalse(html.contains(apiKeys.name), "Html should not contain unstable api: " + apiKeys.name); |
There was a problem hiding this comment.
Could you use "The_Messages_" + apiKeys.name? that is more accurate. If the api name is "too" normal, it could be used by other APIs :)
There was a problem hiding this comment.
Thanks for your suggestion, I updated the test
chirag-wadhwa5
pushed a commit
to chirag-wadhwa5/kafka
that referenced
this pull request
Jul 3, 2024
…test version (apache#16480) Reviewers: Chia-Ping Tsai <[email protected]>
abhi-ksolves
pushed a commit
to ksolves/kafka
that referenced
this pull request
Jul 31, 2024
…test version (apache#16480) Reviewers: Chia-Ping Tsai <[email protected]>
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.
https://issues.apache.org/jira/browse/KAFKA-17051
we should exclude those APIs having make "latestVersionUnstable=true".
Committer Checklist (excluded from commit message)