[incubator-pinot] branch zk-browser updated: Fixing api documentation

[kishoreg]

This is an automated email from the ASF dual-hosted git repository.

kishoreg pushed a commit to branch zk-browser
in repository https://gitbox.apache.org/repos/asf/incubator-pinot.git


The following commit(s) were added to refs/heads/zk-browser by this push:
     new d29a7f6  Fixing api documentation
d29a7f6 is described below

commit d29a7f6d0b449c1e15899607063577c27e14f961
Author: kishoreg <g.kish...@gmail.com>
AuthorDate: Sat Jul 11 23:34:18 2020 -0700

    Fixing api documentation
---
 .../pinot/controller/api/resources/ZookeeperResource.java      | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git 
a/pinot-controller/src/main/java/org/apache/pinot/controller/api/resources/ZookeeperResource.java
 
b/pinot-controller/src/main/java/org/apache/pinot/controller/api/resources/ZookeeperResource.java
index 6870adc..1daff80 100644
--- 
a/pinot-controller/src/main/java/org/apache/pinot/controller/api/resources/ZookeeperResource.java
+++ 
b/pinot-controller/src/main/java/org/apache/pinot/controller/api/resources/ZookeeperResource.java
@@ -57,14 +57,14 @@ public class ZookeeperResource {
   @GET
   @Path("/zookeeper/get")
   @Produces(MediaType.TEXT_PLAIN)
-  @ApiOperation(value = "Get content on the znode")
+  @ApiOperation(value = "Get content of the znode")
   @ApiResponses(value = { //
       @ApiResponse(code = 200, message = "Success"), //
       @ApiResponse(code = 404, message = "ZK Path not found"), //
       @ApiResponse(code = 204, message = "No Content"), //
       @ApiResponse(code = 500, message = "Internal server error")})
   public String getData(
-      @ApiParam(value = "Zookeeper Path, must start with /", required = false, 
defaultValue = "/") @QueryParam("path") @DefaultValue("") String path) {
+      @ApiParam(value = "Zookeeper Path, must start with /", required = true, 
defaultValue = "/") @QueryParam("path") @DefaultValue("") String path) {
 
     path = validateAndNormalizeZKPath(path);
 
@@ -84,7 +84,7 @@ public class ZookeeperResource {
       @ApiResponse(code = 404, message = "ZK Path not found"), //
       @ApiResponse(code = 500, message = "Internal server error")})
   public String ls(
-      @ApiParam(value = "Zookeeper Path, must start with /", required = false, 
defaultValue = "/") @QueryParam("path") @DefaultValue("") String path) {
+      @ApiParam(value = "Zookeeper Path, must start with /", required = true, 
defaultValue = "/") @QueryParam("path") @DefaultValue("") String path) {
 
     path = validateAndNormalizeZKPath(path);
 
@@ -105,7 +105,7 @@ public class ZookeeperResource {
       @ApiResponse(code = 404, message = "ZK Path not found"), //
       @ApiResponse(code = 500, message = "Internal server error")})
   public String lsl(
-      @ApiParam(value = "Zookeeper Path, must start with /", required = false, 
defaultValue = "/") @QueryParam("path") @DefaultValue("") String path) {
+      @ApiParam(value = "Zookeeper Path, must start with /", required = true, 
defaultValue = "/") @QueryParam("path") @DefaultValue("") String path) {
 
     path = validateAndNormalizeZKPath(path);
 
@@ -127,7 +127,7 @@ public class ZookeeperResource {
       @ApiResponse(code = 404, message = "Table not found"), //
       @ApiResponse(code = 500, message = "Internal server error")})
   public String stat(
-      @ApiParam(value = "Zookeeper Path, must start with /", required = false, 
defaultValue = "/") @QueryParam("path") @DefaultValue("") String path) {
+      @ApiParam(value = "Zookeeper Path, must start with /", required = true, 
defaultValue = "/") @QueryParam("path") @DefaultValue("") String path) {
 
     path = validateAndNormalizeZKPath(path);
 


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org
For additional commands, e-mail: commits-h...@pinot.apache.org