Skip to content
APIProductBuild and shipIssue

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.

Text
PATCH /{namespace}/issues/{id}

Path: id. Body, as JSON: the other inputs. Emits Issue.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Issue.
byWorkerThe Worker that performed it.
forPartyThe Party it was done on behalf of.
viastringThe Interface or request it arrived through.
onstringThe Action or Event that caused it, such as the failed attempt a retry follows.
thingstringThe record, at the Version the Action was decided against.
inputjsonThe input it was called with.
createdAtdatetimeWhen it was called.
reservedmoneyThe most this Action may cost, held against its Limits from the check until it settles, billed misses included.
duedatetimeWhen the Task is due.
priorityintegerIts rank in the inbox, highest first.
recurrencestringThe schedule a recurring duty repeats on.
kindstringOne of bug, request, or question.
severitystringSet by triage; a vulnerability takes critical, high, medium or low, which sets due. An Incident keeps its own scale.
advisorystringFor a vulnerability: the public advisory it matches, with the affected package and range.

Returns

OutputTypeRequiredDescription
issueIssuerequiredThe Issue.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
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"}'
JSON
{
  "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.

Text
DELETE /{namespace}/issues/{id}

Path: id. Emits Issue.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Issue.

Returns

OutputTypeRequiredDescription
issueIssuerequiredThe Issue.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X DELETE https://api.sb/leaseline.app/issues/issue_vWekeqrXCN \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "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"
  }
}