Jobs API cleanup

This commit is contained in:
Brett Williams
2026-06-06 08:01:48 -05:00
parent d49cd9df79
commit 5e154b6bab
6 changed files with 53 additions and 52 deletions
+12 -12
View File
@@ -48,7 +48,7 @@ Known callers:
- `RenderServerProxy.get_all_jobs()`
- `src/ui/main_window.py`
### `GET /api/jobs_long_poll`
### `GET /api/jobs/long_poll`
Long-polls the job list until the supplied cache token changes or 30 seconds
elapse.
@@ -68,7 +68,7 @@ Known callers:
- `RenderServerProxy.get_all_jobs()` through the background cache updater.
### `GET /api/jobs/<status_val>`
### `GET /api/jobs/status/<status_val>`
Returns jobs matching a render status.
@@ -86,7 +86,7 @@ Responses:
Review note: this route is not currently wrapped by `RenderServerProxy` and no
in-repo callers were found.
### `GET /api/job/<job_id>`
### `GET /api/jobs/<job_id>`
Returns one job as JSON.
@@ -98,7 +98,7 @@ Known callers:
- `src/distributed_job_manager.py`
- `tests/job_creation_tests.py`
### `GET /api/job/<job_id>/logs`
### `GET /api/jobs/<job_id>/logs`
Returns the job log file as `text/plain`.
@@ -106,7 +106,7 @@ Known callers:
- `src/ui/main_window.py` opens this URL directly.
### `GET /api/job/<job_id>/file_list`
### `GET /api/jobs/<job_id>/files`
Returns a list of output filenames for the job.
@@ -115,7 +115,7 @@ Known callers:
- `RenderServerProxy.get_job_files_list()`
- `src/utilities/server_helper.py`
### `GET /api/job/<job_id>/download`
### `GET /api/jobs/<job_id>/download`
Downloads one output file.
@@ -136,7 +136,7 @@ Known callers:
- `RenderServerProxy.download_job_file()`
- `src/utilities/server_helper.py`
### `GET /api/job/<job_id>/download_all`
### `GET /api/jobs/<job_id>/download_all`
Creates a temporary zip of the job output directory and downloads it.
@@ -146,7 +146,7 @@ Known callers:
- `src/ui/main_window.py`
- `src/utilities/server_helper.py`
### `GET /api/job/<job_id>/thumbnail`
### `GET /api/jobs/<job_id>/thumbnail`
Returns a generated preview image or video for a job.
@@ -207,7 +207,7 @@ Known callers:
- `src/distributed_job_manager.py`
- `tests/job_creation_tests.py`
### `POST /api/job/<job_id>/cancel`
### `POST /api/jobs/<job_id>/cancel`
Cancels a job.
@@ -224,7 +224,7 @@ Known callers:
- `src/ui/main_window.py`
- `src/distributed_job_manager.py`
### `POST /api/job/<job_id>/delete`
### `POST /api/jobs/<job_id>/delete`
Deletes a job, stops it first, deletes previews, and removes owned upload/output
directories when safe.
@@ -240,7 +240,7 @@ Known callers:
- `RenderServerProxy.delete_job()`
- `src/ui/main_window.py`
### `POST /api/job/<job_id>/send_subjob_update_notification`
### `POST /api/jobs/<job_id>/subjob_update`
Notifies a parent job that a child/subjob changed state.
@@ -498,7 +498,7 @@ Likely redundant or overlapping routes:
used internally by `/api/full_status`.
Routes with no in-repo callers found:
- `GET /api/jobs/<status_val>`
- `GET /api/jobs/status/<status_val>`
- `GET /api/presets`
- `GET /api/disk_benchmark`
- `GET /api/engines/<engine_name>/args`