[GitHub] [pulsar] Jennifer88huang commented on a change in pull request #4367: [document][swagger]Update topics rest api document

[GitBox <gi...@apache.org>]

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_r287558744
 
 

 ##########
 File path: pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v2/PersistentTopics.java
 ##########
 @@ -90,8 +98,13 @@
             + "namespace level combined (union) with any eventual specific permission set on the topic.")
     @ApiResponses(value = { @ApiResponse(code = 403, message = "Don't have admin permission"),
             @ApiResponse(code = 404, message = "Namespace doesn't exist") })
-    public Map<String, Set<AuthAction>> getPermissionsOnTopic(@PathParam("tenant") String tenant,
-            @PathParam("namespace") String namespace, @PathParam("topic") @Encoded String encodedTopic) {
+    public Map<String, Set<AuthAction>> getPermissionsOnTopic(
+            @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)
 
 Review comment:
   ```suggestion
               @ApiParam(value = "Specify the topic name", required = true)
   ```

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services