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

dengziming 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 e8cd661becb MINOR: Document MetadataResponse invariants for name and 
ID (#15386)
e8cd661becb is described below

commit e8cd661becb08279702f1670bb8f1d816537adea
Author: Anton Agestam <[email protected]>
AuthorDate: Mon Feb 26 07:49:59 2024 +0100

    MINOR: Document MetadataResponse invariants for name and ID (#15386)
    
    Reviewers: Justine Olshan <[email protected]>, Ziming Deng 
<[email protected]>, Greg Harris <[email protected]>.
---
 clients/src/main/resources/common/message/MetadataResponse.json | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/clients/src/main/resources/common/message/MetadataResponse.json 
b/clients/src/main/resources/common/message/MetadataResponse.json
index 714b28b53d9..bb0b6a802c3 100644
--- a/clients/src/main/resources/common/message/MetadataResponse.json
+++ b/clients/src/main/resources/common/message/MetadataResponse.json
@@ -67,8 +67,9 @@
       { "name": "ErrorCode", "type": "int16", "versions": "0+",
         "about": "The topic error, or 0 if there was no error." },
       { "name": "Name", "type": "string", "versions": "0+", "mapKey": true, 
"entityType": "topicName", "nullableVersions": "12+",
-        "about": "The topic name." },
-      { "name": "TopicId", "type": "uuid", "versions": "10+", "ignorable": 
true, "about": "The topic id." },
+        "about": "The topic name. Null for non-existing topics queried by ID. 
This is never null when ErrorCode is zero. One of Name and TopicId is always 
populated." },
+      { "name": "TopicId", "type": "uuid", "versions": "10+", "ignorable": 
true,
+        "about": "The topic id. Zero for non-existing topics queried by name. 
This is never zero when ErrorCode is zero. One of Name and TopicId is always 
populated." },
       { "name": "IsInternal", "type": "bool", "versions": "1+", "default": 
"false", "ignorable": true,
         "about": "True if the topic is internal." },
       { "name": "Partitions", "type": "[]MetadataResponsePartition", 
"versions": "0+",

Reply via email to