Platform contracts / JSON Schema

Mirror Ops V1

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

Schema version: mirror-ops.v1
Contract path: contracts/mirror-ops.v1.json
Publication: synced-supporting-contract
Defined fields: 7
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
• 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.

workspai mirror status

Produced artifacts

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

Artifact path	Schema	Producer
.workspai/reports/mirror-ops.latest.json	mirror-ops.v1	workspai mirror status

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
action	enum	Yes	Defines the action value at this contract boundary.	enum: status, sync, verify, rotate
command	string	Yes	Defines the command value at this contract boundary.	const: "mirror"
mirror	object	Yes	Defines the mirror value at this contract boundary.	—
result	enum	Yes	Defines the result value at this contract boundary.	enum: ok, failed
schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "mirror-ops.v1"
timestamp	string	Yes	Defines the timestamp value at this contract boundary.	format: date-time
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",
  "$id": "https://getrapidkit.com/schemas/mirror-ops.v1.json",
  "type": "object",
  "required": [
    "schemaVersion",
    "command",
    "action",
    "result",
    "timestamp",
    "workspacePath",
    "mirror"
  ],
  "properties": {
    "schemaVersion": {
      "const": "mirror-ops.v1"
    },
    "command": {
      "const": "mirror"
    },
    "action": {
      "enum": [
        "status",
        "sync",
        "verify",
        "rotate"
      ]
    },
    "result": {
      "enum": [
        "ok",
        "failed"
      ]
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    },
    "workspacePath": {
      "type": "string",
      "minLength": 1
    },
    "mirror": {
      "type": "object"
    }
  },
  "additionalProperties": true
}