Document commands: update, delete
The Document Verbs update, delete as CLI commands, with inputs, result, refusals and an example.
Reference for Document, one group of Document commands.
Document.update
Changes the given properties of a Document. Verb page.
npx startup-builder do Document.update --json '<input>' [--try | --send | --do]Emits Document.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Document. |
form | string | One of document, deck, or sheet. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
document | Document | required | The Document. |
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 Document.update --json '{"id":Document.delete
Deletes a Document: a soft delete that keeps its history, undone by Thing.restore. Verb page.
npx startup-builder do Document.delete --json '<input>' [--try | --send | --do]Emits Document.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Document. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
document | Document | required | The Document. |
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 Document.delete --json '{"id":