Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions apis/workflows/v1/core.proto
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@
repeated TaskSummary task_summaries = 9;
// The automation that submitted the job.
tilebox.v1.ID automation_id = 10;
// A list of progress bars for the job.
repeated ProgressBar progress_bars = 11;
// A list of progress indicators for the job.
repeated Progress progress = 11;

Check failure on line 45 in apis/workflows/v1/core.proto

View workflow job for this annotation

GitHub Actions / Buf

Field "11" on message "Job" changed name from "progress_bars" to "progress".

Check failure on line 45 in apis/workflows/v1/core.proto

View workflow job for this annotation

GitHub Actions / Buf

Field "11" with name "progress" on message "Job" changed type from "workflows.v1.ProgressBar" to "workflows.v1.Progress".

Check failure on line 45 in apis/workflows/v1/core.proto

View workflow job for this annotation

GitHub Actions / Buf

Field "11" with name "progress" on message "Job" changed option "json_name" from "progressBars" to "progress".
}

// The state of a job.
Expand All @@ -67,9 +67,9 @@
google.protobuf.Timestamp stopped_at = 7;
}

// ProgressBar is an indication of progress for a workflow.
message ProgressBar {
// A human-readable label displayed next to the progress bar. Can also be empty.
// Progress is an indicator of total and completed work units for a job.
message Progress {
// A human-readable label for the progress indicator. Can also be empty.
string label = 1 [(buf.validate.field).string.max_len = 100];
// The total number of work units to be processed.
uint64 total = 2;
Expand Down
4 changes: 2 additions & 2 deletions apis/workflows/v1/job.proto
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ message GetJobRequest {
tilebox.v1.ID job_id = 1 [(buf.validate.field).required = true];
}

// GetJobProgressRequest requests the status of a jobs progress bars. It returns a full job object, but only
// partially filled with progress bars, job state and a started_at timestamp.
// GetJobProgressRequest requests a jobs progress. It returns a full job object, but only
// partially filled with progress indicators, job state and a started_at timestamp.
message GetJobProgressRequest {
// The ID of the job to get progress for.
tilebox.v1.ID job_id = 1 [(buf.validate.field).required = true];
Expand Down
8 changes: 4 additions & 4 deletions apis/workflows/v1/task.proto
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@
string display = 2;
// A list of sub-tasks that the just computed task spawned.
repeated TaskSubmission sub_tasks = 3 [(buf.validate.field).repeated.max_items = 64];
// A list of progress bar updates that the computed task wants to report.
repeated ProgressBar progress_updates = 4;
// A list of progress updates that the computed task wants to report.
repeated Progress progress_updates = 4;

Check failure on line 41 in apis/workflows/v1/task.proto

View workflow job for this annotation

GitHub Actions / Buf

Field "4" with name "progress_updates" on message "ComputedTask" changed type from "workflows.v1.ProgressBar" to "workflows.v1.Progress".
}

// IdlingResponse is set in the response of a NextTaskRequest if no task was returned, indicating that the requesting
Expand Down Expand Up @@ -72,11 +72,11 @@
string display = 2;
// Whether to cancel the job that the task belongs to.
bool cancel_job = 3;
// A list of progress bar updates that the failed task wants to report. Even if a task fails, it could
// A list of progress updates that the failed task wants to report. Even if a task fails, it could
// still have made some progress before failing, and we want to reflect that progress.
// Since progress updates are idempotent, retrying the task and getting the same progress update again
// is not an issue.
repeated ProgressBar progress_updates = 4;
repeated Progress progress_updates = 4;

Check failure on line 79 in apis/workflows/v1/task.proto

View workflow job for this annotation

GitHub Actions / Buf

Field "4" with name "progress_updates" on message "TaskFailedRequest" changed type from "workflows.v1.ProgressBar" to "workflows.v1.Progress".
}

// TaskStateResponse is the response to the TaskFailed request,
Expand Down
Loading