This is an automated email from the ASF dual-hosted git repository.
jackie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pinot.git
The following commit(s) were added to refs/heads/master by this push:
new fb9f2953a2 improving API description to capture the updated
functionality (#13539)
fb9f2953a2 is described below
commit fb9f2953a2626c99412411a968f095bd0376521a
Author: 9aman <[email protected]>
AuthorDate: Wed Jul 10 00:53:56 2024 +0530
improving API description to capture the updated functionality (#13539)
---
.../controller/api/resources/PinotTaskRestletResource.java | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git
a/pinot-controller/src/main/java/org/apache/pinot/controller/api/resources/PinotTaskRestletResource.java
b/pinot-controller/src/main/java/org/apache/pinot/controller/api/resources/PinotTaskRestletResource.java
index 81b9ed268e..be0c1397b5 100644
---
a/pinot-controller/src/main/java/org/apache/pinot/controller/api/resources/PinotTaskRestletResource.java
+++
b/pinot-controller/src/main/java/org/apache/pinot/controller/api/resources/PinotTaskRestletResource.java
@@ -615,11 +615,15 @@ public class PinotTaskRestletResource {
@Authorize(targetType = TargetType.CLUSTER, action =
Actions.Cluster.CREATE_TASK)
@Produces(MediaType.APPLICATION_JSON)
@Authenticate(AccessType.UPDATE)
- @ApiOperation("Schedule tasks and return a map from task type to task name
scheduled")
+ @ApiOperation("Schedule tasks and return a map from task type to task name
scheduled. If task type is missing, "
+ + "schedules all tasks. If table name is missing, schedules tasks for
all tables in the database. If database "
+ + "is missing in headers, uses default.")
@Nullable
public Map<String, String> scheduleTasks(
- @ApiParam(value = "Task type") @QueryParam("taskType") @Nullable String
taskType,
- @ApiParam(value = "Table name (with type suffix)")
@QueryParam("tableName") @Nullable String tableName,
+ @ApiParam(value = "Task type. If missing, schedules all tasks.")
@QueryParam("taskType") @Nullable
+ String taskType,
+ @ApiParam(value = "Table name (with type suffix). If missing, schedules
tasks for all tables in the database.")
+ @QueryParam("tableName") @Nullable String tableName,
@ApiParam(value = "Minion Instance tag to schedule the task explicitly
on") @QueryParam("minionInstanceTag")
@Nullable String minionInstanceTag, @Context HttpHeaders headers) {
String database = headers != null ? headers.getHeaderString(DATABASE) :
DEFAULT_DATABASE;
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
