You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pinot.apache.org by ki...@apache.org on 2020/07/12 06:26:21 UTC
[incubator-pinot] branch zk-browser updated: Fixing api
documentation
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 95fabab Fixing api documentation
95fabab is described below
commit 95fabab8ad93ef91a4f74022dd070b8c73f4fe13
Author: kishoreg <g....@gmail.com>
AuthorDate: Sat Jul 11 23:26:01 2020 -0700
Fixing api documentation
---
.../apache/pinot/controller/api/resources/ZookeeperResource.java | 8 ++++----
1 file changed, 4 insertions(+), 4 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 4ed1ba1..6870adc 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,7 +57,7 @@ public class ZookeeperResource {
@GET
@Path("/zookeeper/get")
@Produces(MediaType.TEXT_PLAIN)
- @ApiOperation(value = "Get the data of the specific path", notes = "Get the data of the specific path")
+ @ApiOperation(value = "Get content on the znode")
@ApiResponses(value = { //
@ApiResponse(code = 200, message = "Success"), //
@ApiResponse(code = 404, message = "ZK Path not found"), //
@@ -78,7 +78,7 @@ public class ZookeeperResource {
@GET
@Path("/zookeeper/ls")
@Produces(MediaType.APPLICATION_JSON)
- @ApiOperation(value = "Listing the child nodes of one path", notes = "Listing the child nodes of one path")
+ @ApiOperation(value = "List the child znodes")
@ApiResponses(value = { //
@ApiResponse(code = 200, message = "Success"), //
@ApiResponse(code = 404, message = "ZK Path not found"), //
@@ -99,7 +99,7 @@ public class ZookeeperResource {
@GET
@Path("/zookeeper/lsl")
@Produces(MediaType.APPLICATION_JSON)
- @ApiOperation(value = "Listing the child nodes of one path along with stats", notes = "Listing the child nodes of one path along with stats")
+ @ApiOperation(value = "List the child znodes along with Stats")
@ApiResponses(value = { //
@ApiResponse(code = 200, message = "Success"), //
@ApiResponse(code = 404, message = "ZK Path not found"), //
@@ -121,7 +121,7 @@ public class ZookeeperResource {
@GET
@Path("/zookeeper/stat")
@Produces(MediaType.TEXT_PLAIN)
- @ApiOperation(value = "", notes = "Listing the child nodes of one path")
+ @ApiOperation(value = "Get the stat", notes = " Use this api to fetch additional details of a znode such as creation time, modified time, numChildren etc ")
@ApiResponses(value = { //
@ApiResponse(code = 200, message = "Success"), //
@ApiResponse(code = 404, message = "Table not found"), //
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org
For additional commands, e-mail: commits-help@pinot.apache.org