Bandum API (runs on your machine): board
Repos, milestones (sprints) and tasks by status
This page is generated from
openapi.yamlbynpm run gen, so do not edit it by hand. Authentication is described on the overview page.
/v1/reposTracked repos, milestones and sync status
Responses
| Code | Description | Type |
|---|---|---|
| 200 | Repos in the order listed in BANDUM_REPOS | application/json · object[] |
| 401 | Not signed in | application/problem+json · object |
Example response
[
{
"project": "shop-web",
"taskSource": "scm",
"scmConnected": false,
"scmReason": "scm_connection_required",
"fullName": "your-org/your-project",
"url": "string",
"milestones": [
{}
]
}
]Call with curl
curl "http://localhost:8070/v1/repos" \
-H "Authorization: Bearer $BANDUM_LOCAL_KEY"/v1/boardTasks of a repo, filtered by milestone
Without milestone: every open issue plus issues closed in the last 14 days. With milestone: every issue of that milestone (including closed ones).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
repo | query | string | yes | owner/repo; must be linked to a project of the organization |
milestone | query | string | Milestone (sprint) name |
Responses
| Code | Description | Type |
|---|---|---|
| 200 | Board | application/json · object |
| 400 | Invalid parameter | application/problem+json · object |
| 401 | Not signed in | application/problem+json · object |
| 404 | Repo, milestone, task or organization not found | application/problem+json · object |
Example response
{
"repo": "string",
"milestone": {
"number": 0,
"title": "string",
"state": "open",
"dueOn": "2026-11-01T00:00:00Z",
"openTasks": 0,
"closedTasks": 0
},
"readyForRelease": false,
"syncedAt": "2026-11-01T00:00:00Z",
"tasks": [
{
"repo": "string",
"number": 0,
"key": "GH-12",
"taskSource": "scm",
"title": "string",
"url": "string",
"status": "todo",
"assignees": [],
"level": "S",
"testcaseCount": 0
}
]
}Call with curl
curl "http://localhost:8070/v1/board?repo=string" \
-H "Authorization: Bearer $BANDUM_LOCAL_KEY"/v1/inboxMy inbox, the tasks waiting for me
Computed from what the mirror already holds, across every repo of the organization. "Me" is the signed-in login; online it also matches the connected source-control account, in local mode it is the user of the local instance. toTest: status review, open PR, I am not an assignee, and I am a named tester (label tester: <login>) or no tester is named. resubmitted: I sent it back in the latest run and the developer handed it in again (status review). sentBack: my task (I am an assignee) in status rejected. Each task is in at most one list; the oldest comes first.
Responses
| Code | Description | Type |
|---|---|---|
| 200 | Inbox | application/json · object |
| 401 | Not signed in | application/problem+json · object |
| 403 | Not allowed with this role, or the token or session has no organization | application/problem+json · object |
Example response
{
"login": "string",
"count": 0,
"toTest": [
{
"repo": "string",
"number": 0,
"key": "GH-12",
"taskSource": "scm",
"title": "string",
"url": "string",
"status": "todo",
"assignees": [],
"level": "S",
"testcaseCount": 0
}
],
"resubmitted": [
{
"repo": "string",
"number": 0,
"key": "GH-12",
"taskSource": "scm",
"title": "string",
"url": "string",
"status": "todo",
"assignees": [],
"level": "S",
"testcaseCount": 0
}
],
"sentBack": [
{
"repo": "string",
"number": 0,
"key": "GH-12",
"taskSource": "scm",
"title": "string",
"url": "string",
"status": "todo",
"assignees": [],
"level": "S",
"testcaseCount": 0
}
]
}Call with curl
curl "http://localhost:8070/v1/inbox" \
-H "Authorization: Bearer $BANDUM_LOCAL_KEY"/v1/tasks/{owner}/{repo}/{number}Task details, status history and test runs
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
owner | path | string | yes | |
repo | path | string | yes | |
number | path | integer | yes |
Responses
| Code | Description | Type |
|---|---|---|
| 200 | Task | application/json · object + object |
| 401 | Not signed in | application/problem+json · object |
| 404 | Repo, milestone, task or organization not found | application/problem+json · object |
Example response
{
"repo": "string",
"number": 0,
"key": "GH-12",
"taskSource": "scm",
"title": "string",
"url": "string",
"status": "todo",
"assignees": [
"string"
],
"level": "S",
"testcaseCount": 0,
"acceptancePath": "string",
"stagingUrl": "string",
"previewUrl": "string",
"stagingVersion": {
"state": "match",
"commit": "string",
"prCommit": "string",
"error": "blocked"
},
"history": [
{
"at": "2026-11-01T00:00:00Z",
"status": "todo",
"actor": "string"
}
],
"testcases": [
{
"id": "string",
"acs": [],
"title": "string"
}
],
"runs": [
{
"index": 0,
"approved": false,
"total": 0,
"failed": 0,
"tester": "string",
"commit": "string",
"note": "string",
"results": []
}
],
"metrics": {
"repo": "string",
"number": 0,
"key": "string",
"title": "string",
"status": "todo",
"level": "S",
"runs": 0,
"rejections": 0
}
}Call with curl
curl "http://localhost:8070/v1/tasks/<owner>/<repo>/<number>" \
-H "Authorization: Bearer $BANDUM_LOCAL_KEY"/v1/tasks/{owner}/{repo}/{number}/acceptanceRecord manual testing results (Approve / Send back)
Adds a test run to acceptance.md on the PR branch (same format that ph bandum test writes), reviews the PR and changes the label (approved when every test case passes, otherwise rejected), using the GitHub account of the signed-in web user. Every test case in testcases.md at the PR head commit must be graded.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
owner | path | string | yes | |
repo | path | string | yes | |
number | path | integer | yes |
Body (application/json)
| Field | Type | Required | Description |
|---|---|---|---|
note | string | General note | |
commit | string | PR head commit the tester ran (from the task page); if it differs from the current commit, the server returns 409 | |
results | object[] | yes |
Responses
| Code | Description | Type |
|---|---|---|
| 201 | Test run recorded. For a tracker task writeBack tells whether the tracker was updated too (a failed write-back does not undo the recorded run) | application/json · object + object + object |
| 400 | Invalid parameter | application/problem+json · object |
| 401 | Not signed in | application/problem+json · object |
| 403 | Cannot record with the current identity (Tara token, or a session without GitHub write access) | application/problem+json · object |
| 404 | Repo, milestone, task or organization not found | application/problem+json · object |
| 409 | The PR branch just changed (new commit, or someone else recorded a result); reload and grade again | application/problem+json · object |
Example response
{
"index": 0,
"approved": false,
"total": 0,
"failed": 0,
"tester": "string",
"commit": "string",
"note": "string",
"results": [
{
"id": "TC-3",
"acs": [],
"passed": false,
"note": "string"
}
],
"writeBack": {
"ok": false,
"skipped": false,
"commented": false,
"error": "string"
}
}Call with curl
curl -X POST "http://localhost:8070/v1/tasks/<owner>/<repo>/<number>/acceptance" \
-H "Authorization: Bearer $BANDUM_LOCAL_KEY" \
-H "Content-Type: application/json" \
-d '{"note":"string","commit":"string","results":[{"id":"TC-1","passed":false,"note":"string"}]}'/v1/tasks/{owner}/{repo}/{number}/sync-statusRetry writing the latest test result back to the task tracker (tracker tasks only)
Reads the latest run of acceptance.md on the PR branch and writes it to the tracker with the signed-in user's tracker token: a transition to approved or rejected (skipped when the task is already there) and a summary comment (Bandum acceptance run N: …). When the tracker already shows the run's status and the transition is skipped, the run counts as already written and no second comment is posted. Always HTTP 200; ok: false carries the reason when the tracker still refuses. For a GitHub/GitLab task it answers 400.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
owner | path | string | yes | |
repo | path | string | yes | |
number | path | integer | yes |
Responses
| Code | Description | Type |
|---|---|---|
| 200 | Result of the write-back | application/json · object |
| 400 | Invalid parameter | application/problem+json · object |
| 401 | Not signed in | application/problem+json · object |
| 403 | Cannot write with the current identity | application/problem+json · object |
| 404 | Repo, milestone, task or organization not found | application/problem+json · object |
Example response
{
"ok": false,
"skipped": false,
"commented": false,
"error": "string"
}Call with curl
curl -X POST "http://localhost:8070/v1/tasks/<owner>/<repo>/<number>/sync-status" \
-H "Authorization: Bearer $BANDUM_LOCAL_KEY"/v1/tasks/{owner}/{repo}/{number}/bugsReport an out-of-scope bug (new issue, or a comment if it is a duplicate)
Creates a type: bug issue with the connected account of the signed-in web user (local mode: the token from the BANDUM_SCM_TOKEN_CMD command), using the same format and duplicate check as ph bandum bug: task number is where the bug was found (--from); the reporter, commit and branch come from the task's PR if there is one. A duplicate (same normalized title and task, issue still open) does not create a new issue; it adds a "Seen again." comment to the existing issue (duplicate: true). Secrets in the title and body are masked before sending. A bug in the task under test is graded as a "Fail" test case instead; do not use this endpoint for it. If owner has several segments (GitLab subgroups), encode / as %2F.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
owner | path | string | yes | |
repo | path | string | yes | |
number | path | integer | yes |
Body (application/json)
| Field | Type | Required | Description |
|---|---|---|---|
title | string | yes | |
steps | string | Steps to reproduce | |
expected | string | Expected | |
actual | string | Actual | |
severity | high | medium | low | Old values cao, trung-binh and thap are still accepted as aliases for high, medium and low | |
tc | string | Related test case | |
assignees | string[] | Assignee logins; ignored by older kits that do not support assigning |
Responses
| Code | Description | Type |
|---|---|---|
| 201 | Issue created, or comment added to the existing issue | application/json · object |
| 400 | Invalid parameter | application/problem+json · object |
| 401 | Not signed in | application/problem+json · object |
| 403 | Cannot report with the current identity (Tara token, account not connected, or the account cannot create issues) | application/problem+json · object |
| 404 | Repo, milestone, task or organization not found | application/problem+json · object |
| 422 | The scm kit in use has no report capability group; upgrade kit-scm-* | application/problem+json · object |
Example response
{
"number": 0,
"url": "string",
"duplicate": false
}Call with curl
curl -X POST "http://localhost:8070/v1/tasks/<owner>/<repo>/<number>/bugs" \
-H "Authorization: Bearer $BANDUM_LOCAL_KEY" \
-H "Content-Type: application/json" \
-d '{"title":"string","steps":"string","expected":"string","actual":"string"}'