(kafka) branch trunk updated: KAFKA-17882 improve the document about "default value" of tagged structure field (#17618)

[ch...@apache.org]

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

chia7712 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 f7f4e5b5b1a KAFKA-17882 improve the document about "default value" of tagged structure field (#17618)
f7f4e5b5b1a is described below

commit f7f4e5b5b1a23c2e2c27eebdca279a81900544ad
Author: Ken Huang <s7...@gmail.com>
AuthorDate: Mon Nov 4 05:46:20 2024 +0800

    KAFKA-17882 improve the document about "default value" of tagged structure field (#17618)
    
    Reviewers: Chia-Ping Tsai <ch...@gmail.com>
---
 clients/src/main/resources/common/message/README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/clients/src/main/resources/common/message/README.md b/clients/src/main/resources/common/message/README.md
index dadc98164d8..8c92fd6bc94 100644
--- a/clients/src/main/resources/common/message/README.md
+++ b/clients/src/main/resources/common/message/README.md
@@ -139,6 +139,12 @@ breaking compatibility.
 
 Note that tagged fields can only be added to "flexible" message versions.
 
+#### Default Value Handling for Tagged Fields
+
+In Kafka's serialization mechanism, a tagged field may be omitted from the serialized message 
+if all its associated fields are equal to their default values, whether those defaults are explicit 
+or implicit. This behavior optimizes message size by avoiding the transmission of redundant data.
+
 Flexible Versions
 -----------------
 Kafka serialization has been improved over time to be more flexible and