Recovery and archival / JSON Schema

Workspace Snapshot V1

Defines the versioned workspace snapshot v1 boundary used by Workspai and its consumers.

Schema version: rapidkit-workspace-snapshot-v1
Contract path: contracts/workspace-snapshot.v1.json
Publication: json-schema
Defined fields: 9
Artifact bindings: 0

Why this contract exists

Architecture role

Preserves recoverable state and records the safety boundary of destructive operations.

Consumption boundary

• Workspai CLI
• Workspace Intelligence consumers
• IDEs and agents

Related commands

Commands are linked only when the runtime contract identifies a direct production relationship. Supporting contracts may be consumed without having a single producer command.

This is a supporting, capability, cache, compatibility, or consumer contract. It has no single direct producer command in the canonical Workspace Intelligence execution registry.

Produced artifacts

These durable files are emitted by registered commands and validated against this contract.

No canonical file artifact is registered for this contract. It may describe capabilities, embedded data, runtime exchange, or supporting state instead of a standalone report.

Field reference

Every declared schema property or published capability path is listed here. Required means the contract declares or publishes that field at the shown boundary.

Field path	Type	Required	Meaning	Constraints
copiedPaths	array	Yes	Defines the copiedpaths value at this contract boundary.	—
createdAt	string	Yes	Defines the createdat value at this contract boundary.	format: date-time
mode	enum	Yes	Defines the mode value at this contract boundary.	enum: metadata, full
name	string	Yes	Defines the name value at this contract boundary.	minLength: 1
projects	array	Yes	Defines the projects value at this contract boundary.	—
reason	string	No	Defines the reason value at this contract boundary.	—
schema	string	Yes	Defines the schema value at this contract boundary.	const: "rapidkit-workspace-snapshot-v1"
workspaceName	string	Yes	Defines the workspacename value at this contract boundary.	minLength: 1
workspacePath	string	Yes	Defines the workspacepath value at this contract boundary.	minLength: 1

Canonical machine-readable definition

The raw synchronized contract remains authoritative. The educational sections above are projections of this definition.

Show raw JSON

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "required": [
    "schema",
    "name",
    "mode",
    "createdAt",
    "workspaceName",
    "workspacePath",
    "copiedPaths",
    "projects"
  ],
  "properties": {
    "schema": {
      "const": "rapidkit-workspace-snapshot-v1"
    },
    "name": {
      "type": "string",
      "minLength": 1
    },
    "mode": {
      "enum": [
        "metadata",
        "full"
      ]
    },
    "reason": {
      "type": "string"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "workspaceName": {
      "type": "string",
      "minLength": 1
    },
    "workspacePath": {
      "type": "string",
      "minLength": 1
    },
    "copiedPaths": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "projects": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  },
  "additionalProperties": false
}