[ 
https://issues.apache.org/jira/browse/KAFKA-8794?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16905873#comment-16905873
 ] 

ASF GitHub Bot commented on KAFKA-8794:
---------------------------------------

dongjinleekr commented on pull request #7204: KAFKA-8794: Provide Javadoc on 
DescribeLogDirsResult
URL: https://github.com/apache/kafka/pull/7204
 
 
   ### Committer Checklist (excluded from commit message)
   - [ ] Verify design and implementation 
   - [ ] Verify test coverage and CI build status
   - [ ] Verify documentation (including upgrade notes)
   
 
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


> Provide Javadoc on DescribeLogDirsResult
> ----------------------------------------
>
>                 Key: KAFKA-8794
>                 URL: https://issues.apache.org/jira/browse/KAFKA-8794
>             Project: Kafka
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Lee Dongjin
>            Assignee: Lee Dongjin
>            Priority: Minor
>
> 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
(v7.6.14#76016)

Reply via email to