Skip to content

Commit 7dca13c

Browse files
Kasper Jungeclaude
authored andcommitted
docs: document test-check API endpoint so users can validate checks before running
The POST /api/projects/{project_dir}/primitives/checks/{name}/test endpoint was implemented but missing from the dashboard REST API reference. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent a7ec027 commit 7dca13c

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

docs/dashboard.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -401,6 +401,27 @@ curl -X DELETE http://127.0.0.1:8765/api/projects/$PROJECT/primitives/checks/typ
401401

402402
Returns `204 No Content` on success.
403403

404+
#### Test a check
405+
406+
Run a single check immediately and get the result — useful for validating a
407+
check command before starting a full run.
408+
409+
```bash
410+
curl -X POST http://127.0.0.1:8765/api/projects/$PROJECT/primitives/checks/tests/test
411+
```
412+
413+
```json
414+
{
415+
"passed": true,
416+
"exit_code": 0,
417+
"output": "4 passed in 1.23s\n",
418+
"timed_out": false,
419+
"duration": 1.45
420+
}
421+
```
422+
423+
Returns `404` if the check does not exist.
424+
404425
### WebSocket
405426

406427
Connect to `/api/ws` for live event streaming:

0 commit comments

Comments
 (0)