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_r287558799
##########
File path:
pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v2/PersistentTopics.java
##########
@@ -180,8 +219,15 @@ public void
createNonPartitionedTopic(@PathParam("tenant") String tenant, @PathP
@ApiResponse(code = 409, message = "Partitioned topic does not exist"),
@ApiResponse(code = 412, message = "Partitioned topic name is invalid")
})
- public void updatePartitionedTopic(@PathParam("tenant") String tenant,
@PathParam("namespace") String namespace,
- @PathParam("topic") @Encoded String encodedTopic, int
numPartitions) {
+ public void updatePartitionedTopic(
+ @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(value = "Number of partitions for the topic", required =
true, type = "int", defaultValue = "0")
Review comment:
```suggestion
@ApiParam(value = "The number of partitions for the topic",
required = true, type = "int", 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
