Anonymitaet commented on a change in pull request #4374: [rest] improve
clusters rest endpoint by documenting the endpoints with more swagger
annotations
URL: https://github.com/apache/pulsar/pull/4374#discussion_r287594664
##########
File path:
pulsar-common/src/main/java/org/apache/pulsar/common/policies/data/ClusterData.java
##########
@@ -20,18 +20,48 @@
import static com.google.common.base.Preconditions.checkNotNull;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
import java.util.LinkedHashSet;
import java.util.Objects;
import com.google.common.base.MoreObjects;
+@ApiModel(
+ value = "ClusterData",
+ description = "The configuration data for a cluster"
+)
public class ClusterData {
+ @ApiModelProperty(
+ name = "serviceUrl",
+ value = "The http rest service url (for admin operations)",
+ example = "http://pulsar.example.com:8080";
+ )
private String serviceUrl;
+ @ApiModelProperty(
+ name = "serviceUrlTls",
+ value = "The https rest service url (for admin operations)",
Review comment:
```suggestion
value = "The https rest service URL (for admin operations)",
```
----------------------------------------------------------------
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
