Issue routes: update, delete
The Issue Verbs update, delete as api.sb routes, with inputs, result, refusals and an example.
Reference for Issue, one group of Issue routes.
Issue.update
Changes the given properties of an Issue. Verb page.
PATCH /{namespace}/ issues/ {id}Path: id. Body, as JSON: the other inputs. Emits Issue.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Issue. |
by | Worker | The Worker that performed it. | |
for | Party | The Party it was done on behalf of. | |
via | string | The Interface or request it arrived through. | |
on | string | The Action or Event that caused it, such as the failed attempt a retry follows. | |
thing | string | The record, at the Version the Action was decided against. | |
input | json | The input it was called with. | |
createdAt | datetime | When it was called. | |
reserved | money | The most this Action may cost, held against its Limits from the check until it settles, billed misses included. | |
due | datetime | When the Task is due. | |
priority | integer | Its rank in the inbox, highest first. | |
recurrence | string | The schedule a recurring duty repeats on. | |
kind | string | One of bug, request, or question. | |
severity | string | Set by triage; a vulnerability takes critical, high, medium or low, which sets due. An Incident keeps its own scale. | |
advisory | string | For a vulnerability: the public advisory it matches, with the affected package and range. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
issue | Issue | required | The Issue. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
curl -X PATCH https: //api.sb/ leaseline.app/ issues/ issue_vWekeqrXCN \
-H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
-H "Content-Type: application/ json" \
-d '{"kind": "bug"}'{
"api": "https: //api.sb/ leaseline.app",
"issue": {
"$id": "https: //api.sb/ leaseline.app/ issues/ issue_vWekeqrXCN",
"$type": "Issue",
"status": "pending",
"mode": "try",
"kind": "bug"
},
"action": {
"$id": "https: //api.sb/ leaseline.app/ actions/ act_br07HsG8MG",
"operation": "Issue.update",
"status": "done"
},
"links": {
"self": "https: //api.sb/ leaseline.app/ actions/ act_br07HsG8MG"
}
}Issue.delete
Deletes an Issue: a soft delete that keeps its history, undone by Thing.restore. Verb page.
DELETE /{namespace}/ issues/ {id}Path: id. Emits Issue.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Issue. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
issue | Issue | required | The Issue. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
curl -X DELETE https: //api.sb/ leaseline.app/ issues/ issue_vWekeqrXCN \
-H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"{
"api": "https: //api.sb/ leaseline.app",
"issue": {
"$id": "https: //api.sb/ leaseline.app/ issues/ issue_vWekeqrXCN",
"$type": "Issue",
"status": "pending",
"mode": "try"
},
"action": {
"$id": "https: //api.sb/ leaseline.app/ actions/ act_br07HsG8MG",
"operation": "Issue.delete",
"status": "done"
},
"links": {
"self": "https: //api.sb/ leaseline.app/ actions/ act_br07HsG8MG"
}
}