(kafka) branch trunk updated: KAFKA-21138 Correct AlterConfigPolicy validate documentation (#23579)

[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 41a8c21f21e KAFKA-21138 Correct AlterConfigPolicy validate documentation (#23579)
41a8c21f21e is described below

commit 41a8c21f21eaaba267e7485be35ee400917a359f
Author: YANG-SYUAN CHOU <di...@gmail.com>
AuthorDate: Sun Sep 27 00:18:16 2026 +0800

    KAFKA-21138 Correct AlterConfigPolicy validate documentation (#23579)
    
    Fix outdated Javadoc in `AlterConfigPolicy`:
    
    - `validate`: remove the statement that topics are the only resource
    type whose
    configs can be updated. The policy is applied to any supported config
    resource.
    - `RequestMetadata`: the class comment said "create request parameters",
    which was
    copied from `CreateTopicPolicy`. It now says "alter configs request
    parameters".
    
    Reviewers: Chia-Ping Tsai <ch...@gmail.com>, Ken Huang
     <s7...@gmail.com>
---
 .../main/java/org/apache/kafka/server/policy/AlterConfigPolicy.java  | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/clients/src/main/java/org/apache/kafka/server/policy/AlterConfigPolicy.java b/clients/src/main/java/org/apache/kafka/server/policy/AlterConfigPolicy.java
index 2ca358e0cbf..7fa7606f9d7 100644
--- a/clients/src/main/java/org/apache/kafka/server/policy/AlterConfigPolicy.java
+++ b/clients/src/main/java/org/apache/kafka/server/policy/AlterConfigPolicy.java
@@ -38,7 +38,7 @@ import java.util.Objects;
 public interface AlterConfigPolicy extends Configurable, AutoCloseable {
 
     /**
-     * Class containing the create request parameters.
+     * Class containing the alter configs request parameters.
      */
     class RequestMetadata {
 
@@ -93,8 +93,7 @@ public interface AlterConfigPolicy extends Configurable, AutoCloseable {
      * Clients will receive the POLICY_VIOLATION error code along with the exception's message. Note that validation
      * failure only affects the relevant resource, other resources in the request will still be processed.
      *
-     * @param requestMetadata the alter configs request parameters for the provided resource (topic is the only resource
-     *                        type whose configs can be updated currently).
+     * @param requestMetadata the alter configs request parameters for the provided resource.
      * @throws PolicyViolationException if the request parameters do not satisfy this policy.
      */
     void validate(RequestMetadata requestMetadata) throws PolicyViolationException;