(kafka) branch trunk updated: KAFKA-17494: Document message structure in Protocol Guide (#17122)

[jl...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

jlprat pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/kafka.git


The following commit(s) were added to refs/heads/trunk by this push:
     new ab1eb8d561c KAFKA-17494: Document message structure in Protocol Guide (#17122)
ab1eb8d561c is described below

commit ab1eb8d561ca3ac4a1366f866d450d92c3a0144a
Author: Ivan Yurchenko <iv...@ivanyu.me>
AuthorDate: Mon Sep 16 13:03:59 2024 +0300

    KAFKA-17494: Document message structure in Protocol Guide (#17122)
    
    Reviewers: Josep Prat <jo...@aiven.io>
---
 docs/protocol.html | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/docs/protocol.html b/docs/protocol.html
index b8c04ca0d62..cc4689903ee 100644
--- a/docs/protocol.html
+++ b/docs/protocol.html
@@ -206,6 +206,14 @@ Kafka request. SASL/GSSAPI authentication is performed starting with this packet
 <h4 class="anchor-heading"><a id="protocol_messages" class="anchor-link"></a><a href="#protocol_messages">The Messages</a></h4>
 
 <p>This section gives details on each of the individual API Messages, their usage, their binary format, and the meaning of their fields.</p>
+
+<p>The message consists of the header and body:</p>
+<pre>
+Message => RequestOrResponseHeader Body
+</pre>
+
+<p><code>RequestOrResponseHeader</code> is the versioned request or response header. <code>Body</code> is the message-specific body.</p>
+
 <!--#include virtual="generated/protocol_messages.html" -->
 
 <h4 class="anchor-heading"><a id="protocol_philosophy" class="anchor-link"></a><a href="#protocol_philosophy">Some Common Philosophical Questions</a></h4>