pulsar
pulsar copied to clipboard
[Doc] Fix incorrect API documentation for non-persistent topic endpoints
Search before reporting
- [x] I searched in the issues and found nothing similar.
What issue do you find in Pulsar docs?
The API documentation for non-persistent topic endpoints incorrectly describes them as persistent topic endpoints, which could mislead users. For example:
@POST
@Path("/non-persistent/{tenant}/{namespace}/{topic}/partitions/{partition}")
@ApiOperation(value = "Produce message to a partition of a persistent topic.",
response = String.class, responseContainer = "List")
What is your suggestion?
- Fix the API operation description for non-persistent topic endpoint from "Produce message to a persistent topic" to "Produce message to a non-persistent topic"
- Fix the API operation description for non-persistent topic partition endpoint from "Produce message to a partition of a persistent topic" to "Produce message to a partition of a non-persistent topic"
Any reference?
No response
Are you willing to submit a PR?
- [x] I'm willing to submit a PR!