History operations
2 operations named history.*. Every one runs in a batch through apply_ops, dry_run_ops, the CLI or the admin.
Updated
| Operation | What it does | Permission | Confirmation |
|---|---|---|---|
| history.read | Read the authoritative outcome of a committed request after rechecking its original permissions. | site.read | none |
| history.undo | Reverse a committed batch after checking its documents and original permissions. | history.operation | none |
history.read
Read the authoritative outcome of a committed request after rechecking its original permissions.
permission: site.readreads onlyclass: read
Example input
{
"requestId": "0b7c6d5e-4f3a-4b2c-8d1e-9f0a1b2c3d4e"
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| requestId | string (uuid) | yes |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| requestId | string (uuid) | yes | |
| revision | integer | yes | At least 0. |
| dryRun | boolean | yes | |
| changed | boolean | yes | |
| revisions | record of integer | yes | |
| results | array of object | yes | |
| results[].name | string | yes | |
| results[].ref | string | no | |
| results[].output | any JSON | yes | |
| inverse | array of object | yes | |
| inverse[].name | string | yes | |
| inverse[].input | any JSON | yes | |
| inverse[].ref | string | no | |
| findings | array of object | yes | |
| findings[].ruleId | string | yes | |
| findings[].severity | string | yes | One of "error", "warning", "info". |
| findings[].message | string | yes | |
| findings[].nodeId | string | no | |
| findings[].document | string | no | |
| findings[].fix | object | no |
Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.
Try it
yarn splash history.read '{"requestId":"0b7c6d5e-4f3a-4b2c-8d1e-9f0a1b2c3d4e"}' --dry-runhistory.undo
Reverse a committed batch after checking its documents and original permissions.
permission: history.operationwrites: history:{requestId}class: transactionundo: yes
Example input
{
"requestId": "0b7c6d5e-4f3a-4b2c-8d1e-9f0a1b2c3d4e"
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| requestId | string (uuid) | yes |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| restored | string (uuid) | yes |
Try it
yarn splash history.undo '{"requestId":"0b7c6d5e-4f3a-4b2c-8d1e-9f0a1b2c3d4e"}' --dry-runGenerated from the operation registry and the MCP tool catalogue (source 5114f25cb6f9b98c).
Something wrong on this page? Write to docs@librettocms.com.