pinakes/docs/api/jobs.md
NotAShelf 934691c0f9
docs: auto-generate API route documentation
Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: Id0d1f9769b7ccdbf83d5fa78adef62e46a6a6964
2026-03-22 22:04:52 +03:00

970 B

Jobs

Background job management

Endpoints

GET /api/v1/jobs

Authentication: Required (Bearer JWT)

Responses

Status Description
200 List of jobs
401 Unauthorized
403 Forbidden

GET /api/v1/jobs/{id}

Authentication: Required (Bearer JWT)

Parameters

Name In Required Description
id path Yes Job ID

Responses

Status Description
200 Job details
401 Unauthorized
403 Forbidden
404 Not found

POST /api/v1/jobs/{id}/cancel

Authentication: Required (Bearer JWT)

Parameters

Name In Required Description
id path Yes Job ID

Responses

Status Description
200 Job cancelled
401 Unauthorized
403 Forbidden
404 Not found