apoorvmittal10 commented on code in PR #17681:
URL: https://github.com/apache/kafka/pull/17681#discussion_r1828101908
##########
clients/src/main/resources/common/message/BeginQuorumEpochResponse.json:
##########
@@ -31,14 +31,17 @@
"versions": "0+", "fields": [
{ "name": "PartitionIndex", "type": "int32", "versions": "0+",
"about": "The partition index." },
- { "name": "ErrorCode", "type": "int16", "versions": "0+"},
+ { "name": "ErrorCode", "type": "int16", "versions": "0+",
+ "about": "The error code for this partition."},
{ "name": "LeaderId", "type": "int32", "versions": "0+",
"entityType": "brokerId",
"about": "The ID of the current leader or -1 if the leader is
unknown."},
{ "name": "LeaderEpoch", "type": "int32", "versions": "0+",
"about": "The latest known leader epoch"}
Review Comment:
Can we add `.` in the end as like other desciptions here.
##########
clients/src/main/resources/common/message/ConsumerProtocolSubscription.json:
##########
@@ -28,16 +28,23 @@
"validVersions": "0-3",
"flexibleVersions": "none",
"fields": [
- { "name": "Topics", "type": "[]string", "versions": "0+" },
+ { "name": "Topics", "type": "[]string", "versions": "0+",
+ "about": "The topics that the member wants to consume."},
{ "name": "UserData", "type": "bytes", "versions": "0+",
"nullableVersions": "0+",
- "default": "null", "zeroCopy": true },
+ "default": "null", "zeroCopy": true,
+ "about": "Arbitrary data that will be passed back to the consumer."},
Review Comment:
Shouldn't it be `"about": "User data that will be passed back to the
consumer."},`?
##########
clients/src/main/resources/common/message/BeginQuorumEpochResponse.json:
##########
@@ -31,14 +31,17 @@
"versions": "0+", "fields": [
{ "name": "PartitionIndex", "type": "int32", "versions": "0+",
"about": "The partition index." },
- { "name": "ErrorCode", "type": "int16", "versions": "0+"},
+ { "name": "ErrorCode", "type": "int16", "versions": "0+",
+ "about": "The error code for this partition."},
{ "name": "LeaderId", "type": "int32", "versions": "0+",
"entityType": "brokerId",
"about": "The ID of the current leader or -1 if the leader is
unknown."},
{ "name": "LeaderEpoch", "type": "int32", "versions": "0+",
"about": "The latest known leader epoch"}
Review Comment:
Similarly for other abouts in the file and elsewhere, as can see for a lot
you have made such change but have skipped for others. Any reason?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscr...@kafka.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
