[
https://issues.apache.org/jira/browse/KAFKA-17785?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Andrew Schofield updated KAFKA-17785:
-------------------------------------
Attachment: APIVersionsResponse_after.png
> Kafka protocol documentation should include tagged field information
> --------------------------------------------------------------------
>
> Key: KAFKA-17785
> URL: https://issues.apache.org/jira/browse/KAFKA-17785
> Project: Kafka
> Issue Type: Improvement
> Components: documentation
> Reporter: Andrew Schofield
> Assignee: Andrew Schofield
> Priority: Major
> Fix For: 4.0.0
>
> Attachments: APIVersionsResponse_after.png,
> APIVersionsResponse_before.png
>
>
> The Kafka documentation includes a description of the Kafka protocol
> ([https://kafka.apache.org/protocol]). This is useful to someone wanting to
> understand the details of the protocol. However, in the area of tagged
> fields, the documentation is not helpful.
> Tagged fields provide a way of supplying optional data in a request or
> response. Modern requests and responses usually permit tagged fields,
> although they are relatively rarely used in practice.
> One RPC in which tagged fields contain important information is the
> APIVersionsResponse. In v3 and above, the response contains the set of
> supported and finalised features, which can be used by a client to determine
> whether a broker supports a feature. This information is carried as tagged
> fields, but if you read the documentation of the protocol, you would be
> entirely in the dark.
> This improvement adds tagged field information into the protocol
> documentation.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
