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_r291825057
##########
File path:
pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v2/PersistentTopics.java
##########
@@ -345,11 +552,26 @@ public void skipAllMessages(@PathParam("tenant") String
tenant, @PathParam("name
@POST
@Path("/{tenant}/{namespace}/{topic}/subscription/{subName}/skip/{numMessages}")
@ApiOperation(value = "Skip messages on a topic subscription.")
- @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have
admin permission"),
- @ApiResponse(code = 404, message = "Topic or subscription does not
exist") })
- public void skipMessages(@PathParam("tenant") String tenant,
@PathParam("namespace") String namespace,
- @PathParam("topic") @Encoded String encodedTopic,
@PathParam("subName") String encodedSubName,
+ @ApiResponses(value = {
+ @ApiResponse(code = 401, message = "Don't have permission to
administrate resources on this tenant"),
+ @ApiResponse(code = 403, message = "Don't have admin permission"),
+ @ApiResponse(code = 404, message = "Topic or subscription does not
exist"),
+ @ApiResponse(code = 405, message = "Skip messages on a partitioned
topic is not allowed"),
+ @ApiResponse(code = 500, message = "Internal server error"),
+ @ApiResponse(code = 503, message = "Failed to validate global
cluster configuration")
+ })
+ public void skipMessages(
+ @ApiParam(value = "Specify the tenant", required = true)
+ @PathParam("tenant") String tenant,
+ @ApiParam(value = "Specify the namespace", required = true)
+ @PathParam("namespace") String namespace,
+ @ApiParam(value = "Specify topic name", required = true)
+ @PathParam("topic") @Encoded String encodedTopic,
+ @ApiParam(value = "Subscription to be skip messages on")
+ @PathParam("subName") String encodedSubName,
+ @ApiParam(value = "Number of messages to skip", defaultValue = "0")
Review comment:
```suggestion
@ApiParam(value = "The number of messages to skip", defaultValue
= "0")
```
----------------------------------------------------------------
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
