Workspace operations / JSON Schema

Workspace Sync V1

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

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

Why this contract exists

Architecture role

Keeps workspace identity and discovery consistent across tools and machines.

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
contractSynced	boolean	Yes	Defines the contractsynced value at this contract boundary.	—
registry	object	Yes	Defines the registry value at this contract boundary.	—
registrySummary	object	Yes	Defines the registrysummary value at this contract boundary.	—
schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "rapidkit-workspace-sync-v1"
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": [
    "schemaVersion",
    "workspacePath",
    "registry",
    "contractSynced",
    "registrySummary"
  ],
  "properties": {
    "schemaVersion": {
      "const": "rapidkit-workspace-sync-v1"
    },
    "workspacePath": {
      "type": "string",
      "minLength": 1
    },
    "registry": {
      "type": "object"
    },
    "contractSynced": {
      "type": "boolean"
    },
    "registrySummary": {
      "type": "object"
    }
  },
  "additionalProperties": true
}