AndrewJSchofield commented on code in PR #23457:
URL: https://github.com/apache/kafka/pull/23457#discussion_r4008213565


##########
clients/src/main/resources/common/message/README.md:
##########
@@ -157,6 +157,20 @@ fields are serialized in a more efficient way that saves 
space.  The new
 serialization types start with compact.  For example COMPACT_STRING is a more
 efficient form of STRING.
 
+Header Versions
+---------------
+Every request and response is preceded by a versioned header (carrying fields
+like the API key, version, and correlation ID).  A message's top-level
+"headerVersions" property maps its versions to header versions -- for example,
+{"0-1": "1", "2+": "2"} means versions 0-1 use header version 1, and version 2
+and up use header version 2.
+
+The ranges must start at 0, stay contiguous and non-overlapping, and end

Review Comment:
   "and end with an open-ended range" would be clearer.



-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to