You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by "adrian-tarau (via GitHub)" <gi...@apache.org> on 2023/04/26 15:39:22 UTC
[GitHub] [pulsar] adrian-tarau opened a new issue, #20188: ProducerConfigurationData & ConsumerConfigurationData is not documented with @ApiModelProperty
adrian-tarau opened a new issue, #20188:
URL: https://github.com/apache/pulsar/issues/20188
### 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!
--
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.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] adrian-tarau commented on issue #20188: ProducerConfigurationData & ConsumerConfigurationData is not documented with @ApiModelProperty
Posted by "adrian-tarau (via GitHub)" <gi...@apache.org>.
adrian-tarau commented on issue #20188:
URL: https://github.com/apache/pulsar/issues/20188#issuecomment-1556045119
I'll do my best.
--
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.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] tisonkun commented on issue #20188: ProducerConfigurationData & ConsumerConfigurationData is not documented with @ApiModelProperty
Posted by "tisonkun (via GitHub)" <gi...@apache.org>.
tisonkun commented on issue #20188:
URL: https://github.com/apache/pulsar/issues/20188#issuecomment-1552330715
I can see that some field of `ConsumerConfigurationData` and `ProducerConfigurationData` have the `ApiModelProperty` annotation.
And yes, feel free to submit a patch to add any description you think is good for documenting. I'm glad to give them a review.
It's not quite easy to set up the assertions all fields are well documented but we can gradually improve it,
--
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.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] github-actions[bot] commented on issue #20188: ProducerConfigurationData & ConsumerConfigurationData is not documented with @ApiModelProperty
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on issue #20188:
URL: https://github.com/apache/pulsar/issues/20188#issuecomment-1598008401
The issue had no activity for 30 days, mark with Stale label.
--
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.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org