Compatibility / JSON Schema

Workspai Compatibility Matrix

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

Schema version: rapidkit.compatibility-matrix.v1
Contract path: contracts/compatibility-matrix.v1.json
Publication: json-schema
Defined fields: 5
Artifact bindings: 1

Why this contract exists

Architecture role

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

Consumption boundary

• Workspai CLI
• Documentation portal
• Extensions and adapters

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.

workspai bootstrap

Produced artifacts

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

Artifact path	Schema	Producer
.workspai/compatibility-matrix.json	rapidkit.compatibility-matrix.v1	workspai bootstrap

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
generatedAt	string	Yes	Defines the generatedat value at this contract boundary.	format: date-time
notes	array	Yes	Defines the notes value at this contract boundary.	—
runtimes	object	Yes	Defines the runtimes value at this contract boundary.	—
schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "rapidkit.compatibility-matrix.v1"
source	string	Yes	Defines the source 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/compatibility-matrix.v1.json",
  "title": "Workspai Compatibility Matrix",
  "type": "object",
  "required": [
    "schemaVersion",
    "generatedAt",
    "source",
    "runtimes",
    "notes"
  ],
  "properties": {
    "schemaVersion": {
      "const": "rapidkit.compatibility-matrix.v1"
    },
    "generatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "source": {
      "type": "string",
      "minLength": 1
    },
    "runtimes": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    },
    "notes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": true
}