Setting commands: update, delete
The Setting Verbs update, delete as CLI commands, with inputs, result, refusals and an example.
Reference for Setting, one group of Setting commands.
Setting.update
Changes the given properties of a Setting. Verb page.
npx startup-builder do Setting.update --json '<input>' [--try | --send | --do]Emits Setting.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Setting. |
key | string | The name of the choice. | |
value | json | The chosen value. | |
locked | boolean | True when no holder below may override it. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
setting | Setting | required | The Setting. |
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
npx startup-builder do Setting.update --json '{"id":Setting.delete
Deletes a Setting: a soft delete that keeps its history, undone by Thing.restore. Verb page.
npx startup-builder do Setting.delete --json '<input>' [--try | --send | --do]Emits Setting.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Setting. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
setting | Setting | required | The Setting. |
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
npx startup-builder do Setting.delete --json '{"id":