From 04a19ec4e33cb7f446dc9844ae91dc798d0d0097 Mon Sep 17 00:00:00 2001 From: Brandon Thomas Date: Sun, 16 Jun 2024 13:28:44 -0400 Subject: [PATCH] docs, revert endpoint path change --- .../batch_get_inference_job_status_handler.rs | 2 +- .../dismiss_finished_session_jobs_handler.rs | 4 ++-- .../inference_job/get_inference_job_status_handler.rs | 2 +- .../endpoints/inference_job/list_session_jobs_handler.rs | 9 ++++++--- .../service/web/storyteller_web/src/routes/job_routes.rs | 4 ++-- 5 files changed, 12 insertions(+), 9 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 e343e58534..3087db43d0 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 @@ -152,7 +152,7 @@ impl fmt::Display for BatchGetInferenceJobStatusError { } } - +/// Get job statuses for a batch of multiple job tokens. #[utoipa::path( get, tag = "Jobs", diff --git a/crates/service/web/storyteller_web/src/http_server/endpoints/inference_job/dismiss_finished_session_jobs_handler.rs b/crates/service/web/storyteller_web/src/http_server/endpoints/inference_job/dismiss_finished_session_jobs_handler.rs index e0b7317d0f..661d5e1bea 100644 --- a/crates/service/web/storyteller_web/src/http_server/endpoints/inference_job/dismiss_finished_session_jobs_handler.rs +++ b/crates/service/web/storyteller_web/src/http_server/endpoints/inference_job/dismiss_finished_session_jobs_handler.rs @@ -62,9 +62,9 @@ impl fmt::Display for DismissFinishedSessionJobsError { /// /// This will prevent these jobs from being returned in the "list session jobs" endpoint. #[utoipa::path( - delete, + post, tag = "Jobs", - path = "/v1/jobs/session/finished", + path = "/v1/jobs/session/dismiss_finished", responses( (status = 200, body = DismissFinishedSessionJobsSuccessResponse), (status = 500, body = DismissFinishedSessionJobsError), 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 9b1e7b9ec1..eee356b66c 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 @@ -140,7 +140,7 @@ impl fmt::Display for GetInferenceJobStatusError { } } - +/// Get the status for a single job. #[utoipa::path( get, tag = "Jobs", 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 d9251cc974..6742495fa2 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 @@ -161,10 +161,13 @@ impl fmt::Display for ListSessionJobsError { } -/// List jobs (pending, finished, dead, etc.) that are associated with the user's session. +/// List job statuses for jobs that are associated with the user's session. /// -/// The user must be logged in. This endpoint will only show the last 36 hours of jobs. -/// Any jobs "dismissed" by the user will not be returned. +/// The user must be logged in. This endpoint will only show the last 36 hours +/// of jobs. Any jobs "dismissed" by the user will not be returned. +/// +/// This returns jobs of all states: pending, started, attempt_failed, +/// complete_success, dead, etc. #[utoipa::path( get, tag = "Jobs", diff --git a/crates/service/web/storyteller_web/src/routes/job_routes.rs b/crates/service/web/storyteller_web/src/routes/job_routes.rs index d0245640b8..73eb409c0c 100644 --- a/crates/service/web/storyteller_web/src/routes/job_routes.rs +++ b/crates/service/web/storyteller_web/src/routes/job_routes.rs @@ -43,8 +43,8 @@ pub fn add_job_routes (app: App) -> App .route(web::head().to(|| HttpResponse::Ok())) ) .service( - web::resource("/session/finished") - .route(web::delete().to(dismiss_finished_session_jobs_handler)) + web::resource("/session/dismiss_finished") + .route(web::post().to(dismiss_finished_session_jobs_handler)) .route(web::head().to(|| HttpResponse::Ok())) ) );