One item of context, pinned.
The workspace travels with every item because content lives in exactly one workspace and a document id alone cannot say which room to open (DATAMODEL, content lives in exactly one workspace).
Schema
One item of context, pinned.
The workspace travels with every item because content lives in exactly one workspace and a document id alone cannot say which room to open (DATAMODEL, content lives in exactly one workspace).
Type object or object or object
One of 3 shapes:
kind: "document"
A whole document at one captured version.
| Field | Type | Description |
|---|---|---|
| workspacerequired | WorkspaceId | |
| documentrequired | DocumentId | DocumentId - a client-minted v4 UUID, hyphenated and lowercase. Immutable, and never derived from a name or a path. |
| versionrequired | DocumentVersionId | DocumentVersionId - a client-minted v4 UUID, hyphenated and lowercase. Immutable, and never derived from a name or a path. |
| kindrequired | "document" |
kind: "block"
One block of a document, at one captured version of that document. The version is the document's - a block has no history of its own.
| Field | Type | Description |
|---|---|---|
| workspacerequired | WorkspaceId | |
| documentrequired | DocumentId | DocumentId - a client-minted v4 UUID, hyphenated and lowercase. Immutable, and never derived from a name or a path. |
| versionrequired | DocumentVersionId | DocumentVersionId - a client-minted v4 UUID, hyphenated and lowercase. Immutable, and never derived from a name or a path. |
| noderequired | BlockNodeId | |
| kindrequired | "block" |
kind: "blob"
A file, image or PDF from the content-addressed blob store, pinned at its hash. Retention is asserted at capture (§7.2 step 2).
| Field | Type | Description |
|---|---|---|
| workspacerequired | WorkspaceId | |
| blobrequired | BlobHash |
The algorithm is in the value because a hash that does not say what it is cannot be migrated: adopting a second one has to be additive, or every document already written is orphaned. |
| blob_kindrequired | BlobKind | What kind of bytes a blob item carries. The kind decides how the item is materialized for the provider (P1.7); the hash decides what it is. |
| kindrequired | "blob" |
{
"workspace": "00000000-0000-4000-8000-000000000000",
"document": "00000000-0000-4000-8000-000000000000",
"version": "00000000-0000-4000-8000-000000000000",
"kind": "document"
}The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.
Generated from contract version 1. Last updated .