From 214503b3740ef6339362fdf2db6b4d139840b0ea Mon Sep 17 00:00:00 2001 From: trivedi-vatsal Date: Tue, 1 Sep 2026 12:34:45 +0530 Subject: [PATCH] Document job list query parameters on GET /api/v1/jobs. Co-authored-by: Cursor --- src/content/docs/using/api.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/content/docs/using/api.md b/src/content/docs/using/api.md index 91bd59b..f8784e6 100644 --- a/src/content/docs/using/api.md +++ b/src/content/docs/using/api.md @@ -67,12 +67,18 @@ aliases that mirror `PATCH` / `DELETE` for the HTML UI are omitted. | Method | Path | Purpose | |---|---|---| -| `GET` | `/api/v1/jobs` | List jobs | +| `GET` | `/api/v1/jobs` | List jobs (`repo`, `status`, `limit`, `offset`) | | `GET` | `/api/v1/jobs/{id}` | Job detail | | `GET` | `/api/v1/jobs/{id}/logs` | Full log (session, or shareable opt-in) | | `POST` | `/api/v1/jobs/{id}/rerun` | New job, new Check Run | | `POST` | `/api/v1/jobs/{id}/cancel` | Cancel a running job | +`GET /api/v1/jobs` returns `{ "jobs": [...] }`, newest first. Omit `repo` and +`status` to list every job. `repo` is an exact `owner/name`. `status` must be +one of `queued`, `in_progress`, `success`, `failure`, `skipped`, `cancelled`, +`error`; any other value is `400`. `limit` defaults to 100 (max 500). `offset` +skips that many rows. + ## Public | Method | Path | Purpose |