All contracts

Recovery and archival / JSON Schema

Project Archive V1

Defines the versioned project archive v1 boundary used by Workspai and its consumers.

Schema version
rapidkit-project-archive-v1
Contract path
contracts/project-archive.v1.json
Publication
json-schema
Defined fields
7
Artifact bindings
0

Why this contract exists

Architecture role

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

Consumption boundary

  • Workspai CLI
  • Contract-aware integrations

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 pathTypeRequiredMeaningConstraints
archivedAtstringYesDefines the archivedat value at this contract boundary.format: date-time
archivedPathstringYesDefines the archivedpath value at this contract boundary.minLength: 1
originalPathstringYesDefines the originalpath value at this contract boundary.minLength: 1
projectNamestringYesDefines the projectname value at this contract boundary.minLength: 1
reasonstringNoDefines the reason value at this contract boundary.
safetySnapshotPathstringNoDefines the safetysnapshotpath value at this contract boundary.minLength: 1
schemastringYesDefines the schema value at this contract boundary.const: "rapidkit-project-archive-v1"

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",
    "projectName",
    "originalPath",
    "archivedPath",
    "archivedAt"
  ],
  "properties": {
    "schema": {
      "const": "rapidkit-project-archive-v1"
    },
    "projectName": {
      "type": "string",
      "minLength": 1
    },
    "originalPath": {
      "type": "string",
      "minLength": 1
    },
    "archivedPath": {
      "type": "string",
      "minLength": 1
    },
    "reason": {
      "type": "string"
    },
    "archivedAt": {
      "type": "string",
      "format": "date-time"
    },
    "safetySnapshotPath": {
      "type": "string",
      "minLength": 1
    }
  },
  "additionalProperties": false
}