Lifecycle
A Lifecycle is the states a Thing of one Noun moves through and the Verbs that move it between them.
- Read as
- GuideSpec
Properties
| Property | Type | Required | Description |
|---|---|---|---|
states | string[] | required | The states, in order. |
initial | string | required | The state a new Thing starts in. |
Object
{
"$id": "https: //api.sb/ quietcopy.com/ lifecycles/ lifecycle_1",
"$type": "Lifecycle",
"states": [
"Example states"
],
"initial": "Example initial"
}Relationships
- A Lifecycle governs one Noun: a Noun’s Lifecycle lists the states its Things move through and the Verbs that move them.
governs, inversemovesThrough.
Verbs
getReturns one Lifecycle by id.GET /{namespace}/lifecycles/{id}listReturns Lifecycles, newest first, one page at a time.GET /{namespace}/lifecyclesupdateChanges the given properties of a Lifecycle.PATCH /{namespace}/lifecycles/{id}
Permissions
Which Access level may call each Verb. One-way Verbs wait their delay window.
| Operation | owner | admin | member | viewer |
|---|---|---|---|---|
Lifecycle.get | Yes | Yes | Yes | Yes |
Lifecycle.list | Yes | Yes | Yes | Yes |
Lifecycle.update | Yes | Yes | Yes | No |
Call it
Show me the latest lifecycle.Example
The Order Lifecycle runs placed, paid, fulfilled, closed. The Verb pay moves an Order from placed to paid.