Region operations
1 operation, region.read. It runs in a batch through apply_ops, dry_run_ops, the CLI or the admin.
Updated
| Operation | What it does | Permission | Confirmation |
|---|---|---|---|
| region.read | Read a site region and its editable page identity. | site.read | none |
region.read
Read a site region and its editable page identity.
permission: site.readreads onlyclass: read
Example input
{
"region": "header"
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| region | string | yes | One of "header", "footer", "above", "below". |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| region | string | yes | One of "header", "footer", "above", "below". |
| pageId | string | yes | At least 1 character. |
| tree | object | yes | |
| tree.format | "splash.tree" | yes | |
| tree.v | 3 | yes | |
| tree.revision | integer | yes | At least 0. |
| tree.root | object | object | object | object | object | object | object | yes |
Try it
yarn splash region.read '{"region":"header"}' --dry-runGenerated from the operation registry and the MCP tool catalogue (source 14cebe7ab2df0c19).
Something wrong on this page? Write to docs@librettocms.com.