[GitHub] [pulsar] merlimat commented on a change in pull request #4421: rest: add swagger doc for tenants

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

merlimat commented on a change in pull request #4421: rest: add swagger doc for tenants
URL: https://github.com/apache/pulsar/pull/4421#discussion_r289226762
 
 

 ##########
 File path: pulsar-common/src/main/java/org/apache/pulsar/common/policies/data/TenantInfo.java
 ##########
 @@ -20,20 +20,31 @@
 
 import com.google.common.collect.Sets;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import java.util.Set;
 
 import lombok.Data;
 
 @Data
+@ApiModel(value = "TenantInfo", description = "Information of adminRoles and allowedClusters for tenant")
 public class TenantInfo {
     /**
      * List of role enabled as admin for this tenant
      */
+    @ApiModelProperty(
+        value = "Comma separated list of auth principal allowed to administrate the tenant. If empty the current set of roles won't be modified",
+        name = "adminRoles"
+    )
     private Set<String> adminRoles;
 
     /**
      * List of clusters this tenant is restricted on
      */
+    @ApiModelProperty(
+        value = "Comma separated allowed clusters. If omitted, the current set of clusters will be preserved",
 
 Review comment:
   Same here, not sure the doc is correct for REST point of view

----------------------------------------------------------------
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