docs, revert endpoint path change

This commit is contained in:
Brandon Thomas committed 2024-06-16 13:28:44 -04:00
1 parent f6f769476f
commit 04a19ec4e3
5 files changed
+12 -9

No files matched your search

@@ -152,7 +152,7 @@ impl fmt::Display for BatchGetInferenceJobStatusError {
}
}
/// Get job statuses for a batch of multiple job tokens.
#[utoipa::path(
get,
tag = "Jobs",
@@ -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),
@@ -140,7 +140,7 @@ impl fmt::Display for GetInferenceJobStatusError {
}
}
/// Get the status for a single job.
#[utoipa::path(
get,
tag = "Jobs",
@@ -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",
@@ -43,8 +43,8 @@ pub fn add_job_routes<T, B> (app: App<T>) -> App<T>
.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()))
)
);