Jackie-Jiang commented on a change in pull request #7878:
URL: https://github.com/apache/pinot/pull/7878#discussion_r765329927
##########
File path:
pinot-controller/src/main/java/org/apache/pinot/controller/api/resources/PinotSegmentRestletResource.java
##########
@@ -163,17 +163,21 @@
@GET
@Produces(MediaType.APPLICATION_JSON)
@Path("/segments/{tableName}")
- @ApiOperation(value = "List all segments", notes = "List all segments")
+ @ApiOperation(value = "List all segments. The 'liveOnly' parameter is used
to get the list of segments"
+ + " which can be queried from the table. The value is false by
default.", notes = "List all segments")
public List<Map<TableType, List<String>>> getSegments(
@ApiParam(value = "Name of the table", required = true)
@PathParam("tableName") String tableName,
- @ApiParam(value = "OFFLINE|REALTIME") @QueryParam("type") String
tableTypeStr) {
+ @ApiParam(value = "OFFLINE|REALTIME") @QueryParam("type") String
tableTypeStr,
+ @ApiParam(value = "Whether to return live only segments, which is a set
of segments that can be queried"
Review comment:
This is a little bit vague to me. Here essentially we are excluding the
segments already replaced using the lineage info, and not excluding the
segments that are either in ERROR state or not served by the servers. Suggest
updating the description/method name to make that clear
--
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.
To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org
For additional commands, e-mail: commits-h...@pinot.apache.org
