Skip to content

Bandum API (runs on your machine) ​

The API version is 0.1.0. The curl examples call http://localhost:8070.

Bandum API: the task board, acceptance testing and delivery metrics of PhillipCLI. This contract is the source for the generated Go server and Bandum web code.

GitHub is the source of truth: an issue is a task, a label is its status, and acceptance.md on the PR branch holds the test results. Bandum keeps a copy only to display data, raise alerts and compute metrics; everything here can be rebuilt by syncing again.

Local mode (BANDUM_MODE=local): one user, listening on loopback. GET /local-login?key=... sets a cookie. Every endpoint except /healthz and /local-login needs that cookie or Authorization: Bearer <BANDUM_LOCAL_KEY>.

Authentication: every endpoint except /healthz and /auth/* requires sign-in. The web app uses a session cookie after GitHub sign-in (/auth/github/login). Phillip, Ryoma and scripts send Authorization: Bearer <Tara token>.

Organizations (multi-tenant): all data belongs to an organization of Tara. Every /v1 route except /v1/me also exists as /v1/orgs/{org}/... (for example /v1/orgs/acme/board). Rules: not a member of {org} (or no such organization) is 404; a Tara token belongs to one organization, so a token of another organization is 403; an unknown route under the prefix is 404. The old routes without the prefix are deprecated aliases that use the organization of the token (Tara token) or the only organization of the session; a web session in several organizations must use the prefixed routes. Roles: Owner and Admin manage project settings; Member can too only for projects where they are project admin on Tara; Viewer can view and record acceptance results (the connected source control account decides write access) but cannot change project settings. Platform staff have no access to customer data.

Task status: todo (no status label yet), in_progress, review, rejected, approved (label status: ...), done (issue closed).

Endpoint groups ​

GroupDescriptionEndpoints
system1
account1
boardRepos, milestones (sprints) and tasks by status7
metricsDelivery metrics for PMs and Ryoma1
syncSync the copy from GitHub1
projectsProjects of the organization (key equal to the Tara project key, linked to a repo)3
releasesRelease candidates per milestone, approval and the release workflow (B3)5

These pages are generated

Endpoint descriptions come from the service's openapi.yaml each time you run npm run gen. Endpoints labeled Admin can be called only by admin roles. A few internal endpoints are left out of the public edition.