Jennifer88huang commented on a change in pull request #4367:
[document][swagger]Update topics rest api document
URL: https://github.com/apache/pulsar/pull/4367#discussion_r287558927
##########
File path:
pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v2/PersistentTopics.java
##########
@@ -426,9 +608,18 @@ public void resetCursorOnPosition(@PathParam("tenant")
String tenant, @PathParam
@ApiOperation(value = "Peek nth message on a topic subscription.")
@ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have
admin permission"),
@ApiResponse(code = 404, message = "Topic, subscription or the
message position does not exist") })
- public Response peekNthMessage(@PathParam("tenant") String tenant,
@PathParam("namespace") String namespace,
- @PathParam("topic") @Encoded String encodedTopic,
@PathParam("subName") String encodedSubName,
+ public Response peekNthMessage(
+ @ApiParam(value = "Specify the tenant to which this topic
belongs", required = true)
+ @PathParam("tenant") String tenant,
+ @ApiParam(value = "Specify the namespace to which this topic
belongs", required = true)
+ @PathParam("namespace") String namespace,
+ @ApiParam(value = "Specifies topic name", required = true)
+ @PathParam("topic") @Encoded String encodedTopic,
+ @ApiParam(name = "subName", value = "Subscription to get messages
from", required = true)
Review comment:
we can re-write this sentence to make it more clear.
----------------------------------------------------------------
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:
[email protected]
With regards,
Apache Git Services
