[KAFKA-17090] Add documentation to CreateTopicsResult#config to remind users that both "type" and "document" are null

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 3.9.0
• Assignee: Ming-Yen Chung
• Reporter: Chia-Ping Tsai
• Created: 05/Jul/24 13:38
• Updated: 10/Jul/24 17:33
• Resolved: 10/Jul/24 17:33

Description

CreateTopicsResult#config [0] always has null type and null document, since kafka protocol does not declare those fields[1]. However, CreateTopicsResult#config reuse the class `ConfigEntry`, and so users may expect those fields are defined too.

[0] https://github.com/apache/kafka/blob/trunk/clients/src/main/java/org/apache/kafka/clients/admin/CreateTopicsResult.java#L68
[1] https://github.com/apache/kafka/blob/trunk/clients/src/main/resources/common/message/CreateTopicsResponse.json#L55

Issue Links

• links to: GitHub Pull Request #16539