The unit of export, backup and - later - sharing.
The same logical workspace may exist as several physical replicas: one per release channel, one per machine, one in the cloud. They share [id] and never share a database file.
[id]: Workspace::id
API reference sections
Schema
EnsuredWorkspace
Type object or object or object or object or object or object or object
Shape
One of 7 shapes:
state: "active"
Field Type Description workspacerequired Workspace issuesrequired array of WorkspaceAvailabilityIssue staterequired "active" state: "created"
A Workspace manufactured for an empty Profile. Never produced since Plan 1.3 of the root catalog:
EnsureLiveis a non-creating query and answers [Self::Empty] instead. Kept on the wire for the generated schemas and older decoders.Field Type Description workspacerequired Workspace The unit of export, backup and - later - sharing.
The same logical workspace may exist as several physical replicas: one per release channel, one per machine, one in the cloud. They share [
id] and never share a database file.[
id]: Workspace::idstaterequired "created" state: "empty"
A valid state: this Profile has no live workspace; create one explicitly (root-catalog TECHNICAL.final §3.10, §6.3). Nothing was created, and opening, restarting or receiving a remote update over an empty Profile keeps answering this without minting a workspace.
Field Type Description staterequired "empty" state: "pending"
Field Type Description workspacesrequired array of WorkspaceId staterequired "pending" state: "listing_pending"
Field Type Description issuesrequired array of WorkspaceAvailabilityIssue staterequired "listing_pending" state: "uncertain"
Field Type Description issuesrequired array of WorkspaceAvailabilityIssue staterequired "uncertain" state: "removing"
Field Type Description markrequired RemovalMark staterequired "removing"
{
"workspace": {
"id": "00000000-0000-4000-8000-000000000000",
"owner": {},
"name": "string",
"created_at": 0,
"last_opened_at": 0,
"icon": "string",
"color": "string",
"pinned": false,
"archived": false,
"deleted_at": 0,
"position": 0
},
"issues": [
{
"workspace": "00000000-0000-4000-8000-000000000000",
"cause": "string",
"recovery": {
"problem": "string",
"from_checkpoint": 0,
"quarantined": [
"string"
],
"skipped_updates": 0
}
}
],
"state": "active"
}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
Generated from contract version 1. Last updated .