sajjad-moradi commented on code in PR #12088:
URL: https://github.com/apache/pinot/pull/12088#discussion_r1433259329
##########
pinot-controller/src/main/java/org/apache/pinot/controller/api/resources/PinotRealtimeTableResource.java:
##########
@@ -136,15 +136,22 @@ public Response resumeConsumption(
notes = "Force commit the current segments in consuming state and
restart consumption. "
+ "This should be used after schema/table config changes. "
+ "Please note that this is an asynchronous operation, "
- + "and 200 response does not mean it has actually been done already")
+ + "and 200 response does not mean it has actually been done already."
+ + "If specific partitions or consuming segments are provided, "
+ + "only those partitions or consuming segments will be force
committed.")
public Map<String, String> forceCommit(
- @ApiParam(value = "Name of the table", required = true)
@PathParam("tableName") String tableName) {
+ @ApiParam(value = "Name of the table", required = true)
@PathParam("tableName") String tableName,
+ @ApiParam(value = "Comma separated list of partition group IDs to be
committed") @QueryParam("partitions")
+ String partitionGroupIds,
+ @ApiParam(value = "Comma separated list of consuming segments to be
committed") @QueryParam("segments")
Review Comment:
I changed the variableName in the method as well as the documentation, but
for the actual API's query param, I believe the shorter forms - `partitions`
and `segments` - are better as they make the endpoint shorter:
```
POST /tables/{tableName}/forceCommit?segments=s1,s2
```
instead of
```
POST /tables/{tableName}/forceCommit?segmentsToCommit=s1,s2
```
--
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
