Bandum API (runs on your machine): projects
Projects of the organization (key equal to the Tara project key, linked to a repo)
This page is generated from
openapi.yamlbynpm run gen, so do not edit it by hand. Authentication is described on the overview page.
/v1/projectsProjects of the organization (any role)
Server mode mirrors the organization's projects from Tara (refreshed at most every 60 seconds per organization): Tara is the single source of truth. Local mode lists the projects of the local organization.
Responses
| Code | Description | Type |
|---|---|---|
| 200 | Projects in key order | 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
[
{
"key": "shop-web",
"name": "Shop Web",
"repo": "acme/shop-web",
"repos": [
"string"
],
"scmConnected": false
}
]Call with curl
curl "http://localhost:8070/v1/projects" \
-H "Authorization: Bearer $BANDUM_LOCAL_KEY"/v1/projects/{key}Link a repo to a project (create it if needed; local mode only)
Server mode returns 403: projects are managed in Tara and Bandum mirrors them. Owner and Admin of the organization, or the project admin of key (Tara). The key is the Tara project key. Changing the repo deletes the copy of the old repo. Viewer and other Members get 403.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
key | path | string | yes | Project key (the Tara project key) |
Body (application/json)
| Field | Type | Required | Description |
|---|---|---|---|
repo | string | yes |
Responses
| Code | Description | Type |
|---|---|---|
| 200 | Saved | application/json · object |
| 400 | Invalid parameter | application/problem+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 |
| 409 | The repo is already linked to another project of this organization | application/problem+json · object |
Example response
{
"key": "shop-web",
"name": "Shop Web",
"repo": "acme/shop-web",
"repos": [
"string"
],
"scmConnected": false
}Call with curl
curl -X PUT "http://localhost:8070/v1/projects/<key>" \
-H "Authorization: Bearer $BANDUM_LOCAL_KEY" \
-H "Content-Type: application/json" \
-d '{"repo":"acme/shop-web"}'/v1/projects/{key}Delete a project and the copy of its repo (local mode only; server mode returns 403, projects are managed in Tara)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
key | path | string | yes | Project key (the Tara project key) |
Responses
| Code | Description | Type |
|---|---|---|
| 204 | Deleted | |
| 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 |
| 404 | Repo, milestone, task or organization not found | application/problem+json · object |
Call with curl
curl -X DELETE "http://localhost:8070/v1/projects/<key>" \
-H "Authorization: Bearer $BANDUM_LOCAL_KEY"