You are viewing a plain text version of this content. The canonical link for it is here.

Posted to jira@kafka.apache.org by "Dongjin Lee (Jira)" <ji...@apache.org> on 2020/07/04 13:59:00 UTC

[jira] [Updated] (KAFKA-8794) Provide Javadoc on DescribeLogDirsResult

     [ https://issues.apache.org/jira/browse/KAFKA-8794?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Dongjin Lee updated KAFKA-8794:
-------------------------------
    Labels: needs-kip  (was: )

> Provide Javadoc on DescribeLogDirsResult
> ----------------------------------------
>
>                 Key: KAFKA-8794
>                 URL: https://issues.apache.org/jira/browse/KAFKA-8794
>             Project: Kafka
>          Issue Type: Improvement
>          Components: clients, documentation
>            Reporter: Dongjin Lee
>            Assignee: Dongjin Lee
>            Priority: Minor
>              Labels: needs-kip
>
> As of 2.3.0, DescribeLogDirsResult returned by AdminClient#describeLogDirs(Collection) is exposing the internal data structure, DescribeLogDirsResponse.LogDirInfo. By doing so, its Javadoc provides no documentation on it. Its imparity is clear when comparing with DescribeReplicaLogDirsResult, returned by AdminClient#describeReplicaLogDirs(Collection).
> To resolve this, org.apache.kafka.clients.admin.DescribeLogDirsResult should provide [LogDirInfo, ReplicaInfo] as its internal class, like DescribeReplicaLogDirsResult.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)