admin/openfang
1
0
Fork 0
mirror of https://github.com/RightNow-AI/openfang.git synced 2026-08-14 00:47:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add complete JSON response examples to cron endpoint docs

Browse Source 
- GET /api/cron/jobs: show actual {jobs: [...], total} wrapper and
  document the ?agent_id query filter
- POST /api/cron/jobs: fix status code to 201 Created, show the actual
  {result: "<stringified-json>"} response shape
- GET /api/cron/jobs/{id}/status: show full JobMeta structure with
  nested job object, one_shot, last_status, consecutive_errors

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
vnz
2026-03-19 04:24:39 +01:00
co-authored by Claude Opus 4.6
parent 0b99ac4071
commit 7b1057df0c
1 changed files with 62 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api-reference.md
+62 -6
View File
@@ -1777,9 +1777,37 @@ Manage recurring and one-shot scheduled jobs. Jobs can trigger agent turns, syst
### GET /api/cron/jobs
List all cron jobs.
List all cron jobs. Optionally filter by agent with `?agent_id=<uuid>`.
**Response** `200 OK`: Array of `CronJob` objects.
**Response** `200 OK`:
```json
{
"jobs": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"agent_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"name": "daily-report",
"enabled": true,
"schedule": { "kind": "every", "every_secs": 3600 },
"action": {
"kind": "agent_turn",
"message": "Generate the daily report",
"timeout_secs": 120
},
"delivery": {
"kind": "channel",
"channel": "slack",
"to": "#reports"
},
"created_at": "2026-03-15T10:30:00Z",
"last_run": "2026-03-16T09:00:00Z",
"next_run": "2026-03-16T10:00:00Z"
}
],
"total": 1
}
```
### POST /api/cron/jobs
@@ -1789,9 +1817,8 @@ Create a new cron job.
```json
{
"agent_id": "uuid",
"agent_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"name": "daily-report",
"enabled": true,
"schedule": { "kind": "every", "every_secs": 3600 },
"action": {
"kind": "agent_turn",
@@ -1806,7 +1833,13 @@ Create a new cron job.
}
```
**Response** `200 OK`: The created `CronJob` object with assigned `id`.
**Response** `201 Created`:
```json
{
"result": "{\"job_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"status\":\"created\"}"
}
```
### DELETE /api/cron/jobs/{id}
@@ -1838,7 +1871,30 @@ Enable or disable a cron job.
Get job metadata including last run time, status, and error history.
**Response** `200 OK`: `JobMeta` object with fields like `last_run`, `last_status`, `consecutive_errors`.
**Response** `200 OK`:
```json
{
"job": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"agent_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"name": "daily-report",
"enabled": true,
"schedule": { "kind": "every", "every_secs": 3600 },
"action": {
"kind": "agent_turn",
"message": "Generate the daily report",
"timeout_secs": 120
},
"delivery": { "kind": "none" },
"created_at": "2026-03-15T10:30:00Z",
"last_run": "2026-03-16T09:00:00Z",
"next_run": "2026-03-16T10:00:00Z"
},
"one_shot": false,
"last_status": "ok",
"consecutive_errors": 0
}
### POST /api/cron/jobs/{id}/run