From 175035000b38d9a24efa9d6a8abc5e29d07f9d97 Mon Sep 17 00:00:00 2001 From: Brandon Thomas Date: Fri, 5 Jul 2024 16:04:02 -0400 Subject: [PATCH] better doc --- .../inference_job/batch_get_inference_job_status_handler.rs | 3 ++- .../inference_job/get_inference_job_status_handler.rs | 3 ++- .../endpoints/inference_job/list_session_jobs_handler.rs | 3 ++- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/crates/service/web/storyteller_web/src/http_server/endpoints/inference_job/batch_get_inference_job_status_handler.rs b/crates/service/web/storyteller_web/src/http_server/endpoints/inference_job/batch_get_inference_job_status_handler.rs index 33c02e23a8..cfe3a1d635 100644 --- a/crates/service/web/storyteller_web/src/http_server/endpoints/inference_job/batch_get_inference_job_status_handler.rs +++ b/crates/service/web/storyteller_web/src/http_server/endpoints/inference_job/batch_get_inference_job_status_handler.rs @@ -110,7 +110,8 @@ pub struct BatchStatusDetailsResponse { /// messages. These pertain to both transient and permanent failures. pub maybe_failure_category: Option, - /// This is an integer number between 0 and 100 that reports the completeness. + /// This is an integer number between 0 and 100 (both inclusive) that + /// reports the completeness. pub progress_percentage: u8, } diff --git a/crates/service/web/storyteller_web/src/http_server/endpoints/inference_job/get_inference_job_status_handler.rs b/crates/service/web/storyteller_web/src/http_server/endpoints/inference_job/get_inference_job_status_handler.rs index 79af386148..8e80eb57fb 100644 --- a/crates/service/web/storyteller_web/src/http_server/endpoints/inference_job/get_inference_job_status_handler.rs +++ b/crates/service/web/storyteller_web/src/http_server/endpoints/inference_job/get_inference_job_status_handler.rs @@ -98,7 +98,8 @@ pub struct StatusDetailsResponse { /// messages. These pertain to both transient and permanent failures. pub maybe_failure_category: Option, - /// This is an integer number between 0 and 100 that reports the completeness. + /// This is an integer number between 0 and 100 (both inclusive) that + /// reports the completeness. pub progress_percentage: u8, } diff --git a/crates/service/web/storyteller_web/src/http_server/endpoints/inference_job/list_session_jobs_handler.rs b/crates/service/web/storyteller_web/src/http_server/endpoints/inference_job/list_session_jobs_handler.rs index 9824a557ca..2ba96a339c 100644 --- a/crates/service/web/storyteller_web/src/http_server/endpoints/inference_job/list_session_jobs_handler.rs +++ b/crates/service/web/storyteller_web/src/http_server/endpoints/inference_job/list_session_jobs_handler.rs @@ -114,7 +114,8 @@ pub struct ListSessionStatusDetailsResponse { /// messages. These pertain to both transient and permanent failures. pub maybe_failure_category: Option, - /// This is an integer number between 0 and 100 that reports the completeness. + /// This is an integer number between 0 and 100 (both inclusive) that + /// reports the completeness. pub progress_percentage: u8, }