Batches
Every change is an operation batch: its fields, the answer it gets and a minimal call.
Batch fields
| Field | Type | Required | Notes |
|---|---|---|---|
| format | "libretto.batch" | yes | |
| v | 1 | yes | |
| requestId | string (uuid) | yes | |
| baseRevisions | record of integer | yes | |
| operations | array of object | yes | At least 1 item. At most 100 items. |
| operations[].name | string | yes | |
| operations[].input | any JSON | yes | |
| operations[].ref | string | no | |
| dryRun | boolean | no | Default false. |
| confirmed | array of string | no | Default []. |
Answer fields
| 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 |
A minimal batch
{
"format": "libretto.batch",
"v": 1,
"requestId": "0b7c6d5e-4f3a-4b2c-8d1e-9f0a1b2c3d4e",
"baseRevisions": {
"history": 12,
"site": 3
},
"operations": [
{
"name": "site.update",
"input": {
"name": "Studio"
}
}
]
}Generated from the operation registry and the MCP tool catalogue (source 10d44a53fcf838b5).
Something wrong on this page? Write to docs@librettocms.com.