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_r287594523
##########
File path:
pulsar-common/src/main/java/org/apache/pulsar/common/policies/data/NamespaceIsolationData.java
##########
@@ -20,16 +20,45 @@
import static com.google.common.base.Preconditions.checkArgument;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
import java.util.ArrayList;
import java.util.List;
import com.google.common.base.Objects;
+@ApiModel(
+ value = "NamespaceIsolationData",
+ description = "The namespace isolation configuration data"
+)
public class NamespaceIsolationData {
+ @ApiModelProperty(
+ name = "namespaces",
+ value = "The list of namespaces to apply this namespace isolation data"
+ )
public List<String> namespaces = new ArrayList<String>();
+ @ApiModelProperty(
+ name = "primary",
+ value = "The list of primary brokers for serving the list of
namespaces in this isolation policy"
+ )
public List<String> primary = new ArrayList<String>();
+ @ApiModelProperty(
+ name = "primary",
+ value = "The list of secondary brokers for serving the list of
namespaces in this isolation policy"
+ )
public List<String> secondary = new ArrayList<String>();
+ @ApiModelProperty(
+ name = "auto_failover_policy",
+ value = "The auto failover policy configuration data",
Review comment:
```suggestion
value = "The data of auto-failover policy configuration",
```
----------------------------------------------------------------
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