JournalReadPageResult

Experimental

journal/readPage result.

Fields and variants

• atCut — Experimental
• completeThrough — Experimental
• journalError — Experimental
• next — Experimental
• records — Experimental
• remainingBudget — Experimental

Source

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

{
  "description": "`journal/readPage` result.",
  "properties": {
    "atCut": {
      "type": "boolean"
    },
    "completeThrough": {
      "type": [
        "integer",
        "null"
      ]
    },
    "journalError": {
      "type": [
        "string",
        "null"
      ]
    },
    "next": {
      "$ref": "#/$defs/JournalAnchor"
    },
    "records": {
      "items": {
        "$ref": "#/$defs/JournalPageRecord"
      },
      "type": "array"
    },
    "remainingBudget": {
      "$ref": "#/$defs/JournalReadBudget"
    }
  },
  "required": [
    "atCut",
    "completeThrough",
    "journalError",
    "next",
    "records",
    "remainingBudget"
  ],
  "type": "object",
  "x-msp-descriptor": "journal/readPage",
  "x-msp-stability": "experimental"
}