ViewPageParams

view/page params: cursor-paged reads of the session view.

Fields and variants

• anchor
• cursor
• direction
• limit
• maxBytes
• sessionId

Source

schema/msp/experimental/msp.schema.json#/types/ViewPageParams

{
  "description": "`view/page` params: cursor-paged reads of the session view.",
  "properties": {
    "anchor": {
      "$ref": "#/$defs/ViewPageAnchor",
      "description": "The cold-client request mode, resolved at\ncall time to the latest installed compaction boundary. The one named\nexception to the observed-only rule."
    },
    "cursor": {
      "description": "The exclusive anchor. Forward: the page starts strictly after it;\nomitted means from the beginning of the view. Backward: the page ends\nstrictly before it; omitted means from the head. Mutually exclusive\nwith `anchor`.",
      "type": "string"
    },
    "direction": {
      "$ref": "#/$defs/ViewPageDirection",
      "description": "Paging direction; `forward` when omitted."
    },
    "limit": {
      "description": "Maximum events to return, 1–1000. The server MAY return fewer.\n\nThe 1–1000 range is ratified and **published**: the model carries the\nbound and the bundle renders `minimum`/`maximum` instead of a bare\n`integer`.",
      "maximum": 1000,
      "minimum": 1,
      "type": "integer"
    },
    "maxBytes": {
      "description": "The caller's page byte cap (kt-dvw5, additive-optional). The page\nserves under `min(server budget, maxBytes)`, so a Console page stays\nunder its own budget without the server's frame cap alone deciding.\nAbsent means the server budget governs. `0` is refused typed\n(`invalid_params`): a 0 cap admits no progress. A single event over\nthe cap is truncated (marked) instead of erroring, except verbatim\nand fetch-key content (`item.args`, `structuredData`, `outputRef`/\n`patchRef`), which is never cut and still answers typed\n`PageEventTooLarge`.",
      "type": "integer"
    },
    "sessionId": {
      "description": "The session to page.",
      "type": "string"
    }
  },
  "required": [
    "limit",
    "sessionId"
  ],
  "type": "object"
}