HistoryPage

Type object

Shape

Field	Type	Description
entriesrequired	array of HistoryEntry
next_before_at	integer (int64) or null	Default `null`
next_before_id	HistoryEntryId or null	Default `null`
stale	boolean or null	Whether the document has changed since its newest marker - the store's own comparison, not something a client derives. A property of the document, so it is on the page rather than on each entry: "changed since the newest marker" is one question however many rows the page carries. `Option`, not `bool`, and that is the whole compatibility story. A bare `bool` with `#[serde(default)]` reads `false` - not stale - from every store built before this field existed, and a client that believed it would offer to rename a marker over a document that has moved on. `None` means this store does not say, and a caller must then fall back to whatever it did before it could ask. `Some(true)` when the document has no markers at all: there is nothing to be unchanged relative to. Default `null`

Example

{
  "entries": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "document": "00000000-0000-4000-8000-000000000000",
      "version": "00000000-0000-4000-8000-000000000000",
      "reason": "string",
      "recorded_at": 0,
      "label": "string",
      "message": "string",
      "boundary": "string",
      "pinned": false
    }
  ],
  "next_before_at": 0,
  "next_before_id": "00000000-0000-4000-8000-000000000000",
  "stale": false
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Used by

GET/v1/workspaces/{id}/documents/{document}/history
A document's durable history markers, newest first

Generated from contract version 1. Last updated November 12, 2026.