From f91bcda2240a2c0ccfc367cc1fc297da2580ffec Mon Sep 17 00:00:00 2001 From: Lukas Bindreiter Date: Tue, 16 Sep 2025 17:20:17 +0200 Subject: [PATCH] Fix naming of progress in protobuf messages --- apis/workflows/v1/core.proto | 10 +++++----- apis/workflows/v1/job.proto | 4 ++-- apis/workflows/v1/task.proto | 8 ++++---- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/apis/workflows/v1/core.proto b/apis/workflows/v1/core.proto index 7413d87..fcd0036 100644 --- a/apis/workflows/v1/core.proto +++ b/apis/workflows/v1/core.proto @@ -41,8 +41,8 @@ message Job { 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; } // The state of a job. @@ -67,9 +67,9 @@ message TaskSummary { 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; diff --git a/apis/workflows/v1/job.proto b/apis/workflows/v1/job.proto index 8f1385d..4f120c3 100644 --- a/apis/workflows/v1/job.proto +++ b/apis/workflows/v1/job.proto @@ -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]; diff --git a/apis/workflows/v1/task.proto b/apis/workflows/v1/task.proto index 466a3cb..6cf5b07 100644 --- a/apis/workflows/v1/task.proto +++ b/apis/workflows/v1/task.proto @@ -37,8 +37,8 @@ message ComputedTask { 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; } // IdlingResponse is set in the response of a NextTaskRequest if no task was returned, indicating that the requesting @@ -72,11 +72,11 @@ message TaskFailedRequest { 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; } // TaskStateResponse is the response to the TaskFailed request,