Platform contracts / JSON Schema

Workspai Version Contract

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

Schema version: rapidkit-version-v1
Contract path: contracts/version.v1.json
Publication: synced-supporting-contract
Defined fields: 8
Artifact bindings: 0

Why this contract exists

Architecture role

Defines a versioned interoperability boundary used by Workspai and contract-aware consumers.

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 path	Type	Required	Meaning	Constraints
capabilitiesSchemaVersion	string	Yes	Defines the capabilitiesschemaversion value at this contract boundary.	const: "rapidkit-command-capabilities-v1"
cli	string	Yes	Defines the cli value at this contract boundary.	const: "workspai"
contractCatalog	object	Yes	Defines the contractcatalog value at this contract boundary.	additionalProperties: true
contracts	object	Yes	Defines the contracts value at this contract boundary.	additionalProperties: true
node	string	Yes	Defines the node value at this contract boundary.	minLength: 1
platform	string	Yes	Defines the platform value at this contract boundary.	minLength: 1
schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "rapidkit-version-v1"
version	string	Yes	Defines the version 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",
  "$id": "https://workspai.dev/schemas/version.v1.json",
  "title": "Workspai Version Contract",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "schemaVersion",
    "cli",
    "version",
    "node",
    "platform",
    "capabilitiesSchemaVersion",
    "contracts",
    "contractCatalog"
  ],
  "properties": {
    "schemaVersion": {
      "const": "rapidkit-version-v1"
    },
    "cli": {
      "const": "workspai"
    },
    "version": {
      "type": "string",
      "minLength": 1
    },
    "node": {
      "type": "string",
      "minLength": 1
    },
    "platform": {
      "type": "string",
      "minLength": 1
    },
    "capabilitiesSchemaVersion": {
      "const": "rapidkit-command-capabilities-v1"
    },
    "contracts": {
      "type": "object",
      "additionalProperties": true
    },
    "contractCatalog": {
      "type": "object",
      "additionalProperties": true
    }
  }
}