AndrewJSchofield commented on code in PR #17681: URL: https://github.com/apache/kafka/pull/17681#discussion_r1829603515
########## clients/src/main/resources/common/message/ShareAcknowledgeResponse.json: ########## @@ -54,7 +54,8 @@ "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." } - ]} + ], + "about": "The current leader of the partition."} Review Comment: I would expect to see the "about" on line 52 before the "fields". ########## clients/src/main/resources/common/message/WriteShareGroupStateRequest.json: ########## @@ -44,10 +44,11 @@ { "name": "LastOffset", "type": "int64", "versions": "0+", "about": "The last offset of this state batch." }, { "name": "DeliveryState", "type": "int8", "versions": "0+", - "about": "The state - 0:Available,2:Acked,4:Archived" }, + "about": "The state - 0:Available,2:Acked,4:Archived." }, { "name": "DeliveryCount", "type": "int16", "versions": "0+", "about": "The delivery count." } - ]} + ], + "about": "The state batches for the partition."} Review Comment: I'd expect to see this on line 41 with the "fields". ########## group-coordinator/src/main/resources/common/message/ShareGroupTargetAssignmentMemberValue.json: ########## @@ -22,8 +22,10 @@ "fields": [ { "name": "TopicPartitions", "versions": "0+", "type": "[]TopicPartition", "about": "The assigned partitions.", "fields": [ - { "name": "TopicId", "versions": "0+", "type": "uuid" }, - { "name": "Partitions", "versions": "0+", "type": "[]int32" } + { "name": "TopicId", "versions": "0+", "type": "uuid", + "about": "The topic id."}, + { "name": "Partitions", "versions": "0+", "type": "[]int32", + "about": "The partition ids."} Review Comment: Generally partition index or partition number, rather than partition id. ########## clients/src/main/resources/common/message/ShareFetchResponse.json: ########## @@ -59,7 +59,8 @@ "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." } - ]}, + ], + "about": "The current leader for this partition."}, Review Comment: Same comment as for ShareAcknowledgeResponse. ########## share-coordinator/src/main/resources/common/message/ShareUpdateValue.json: ########## @@ -33,10 +33,11 @@ { "name": "LastOffset", "type": "int64", "versions": "0", "about": "The last offset of this state batch." }, { "name": "DeliveryState", "type": "int8", "versions": "0", - "about": "The delivery state - 0:Available,2:Acked,4:Archived" }, + "about": "The delivery state - 0:Available,2:Acked,4:Archived." }, { "name": "DeliveryCount", "type": "int16", "versions": "0", "about": "The delivery count." } - ]} + ], + "about": "The state batches that have been updated."} Review Comment: I'd put this on line 30 with the "fields". ########## share-coordinator/src/main/resources/common/message/ShareSnapshotValue.json: ########## @@ -35,10 +35,11 @@ { "name": "LastOffset", "type": "int64", "versions": "0", "about": "The last offset of this state batch." }, { "name": "DeliveryState", "type": "int8", "versions": "0", - "about": "The delivery state - 0:Available,2:Acked,4:Archived" }, + "about": "The delivery state - 0:Available,2:Acked,4:Archived." }, { "name": "DeliveryCount", "type": "int16", "versions": "0", "about": "The delivery count." } - ]} + ], + "about": "The state batches."} Review Comment: I'd put this on line 32 with the "fields". -- 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