apache / apache/pulsar

ProducerConfigurationData & ConsumerConfigurationData is not documented with @ApiModelProperty

Open
#20,188 3 comments 0 reactions 2 assignees Claimed by @tisonkun View on GitHub
Stale type/enhancement
Dominant language
Java
Stars
15.3k
Forks
3.8k
Avg merge
1d 14h
Merged PRs (30d)
160

Description

### Search before asking

- [X] I searched in the [issues](https://github.com/apache/pulsar/issues) and found nothing similar.

### Motivation

ClientConfigurationData has all its fields annotated with @ApiModelProperty, but ProducerConfigurationData & ConsumerConfigurationData do not have that.

It would be very useful to have documentation on these properties, too, especially if this documentation generates a list of available properties for clients, consumers & producers. Also, the documentation could be a bit more detailed.

### Solution

Add @ApiModelProperty for each public property with a detailed enough description.

Also, expand on the descriptions for ClientConfigurationData :)

### Alternatives

_No response_

### Anything else?

I guess I could add those myself and send a PR but I might not have the right description for some of those properties.

### Are you willing to submit a PR?

- [X] I'm willing to submit a PR!

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.