Workspace Intelligence / JSON Schema

Workspai Studio Blocker Handoff

Defines the versioned studio blocker handoff v1 boundary used by Workspai and its consumers.

Schema version: rapidkit-studio-blocker-handoff-v1
Contract path: contracts/workspace-intelligence/studio-blocker-handoff.v1.json
Publication: synced-supporting-contract
Defined fields: 26
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
• 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
artifactPath	string	Yes	Defines the artifactpath value at this contract boundary.	—
blockers	array	Yes	Defines the blockers value at this contract boundary.	—
blockerSignature	string	No	Defines the blockersignature value at this contract boundary.	minLength: 8
cardId	string	Yes	Defines the cardid value at this contract boundary.	minLength: 1
cardLabel	string	No	Defines the cardlabel value at this contract boundary.	—
cardStatus	enum	Yes	Defines the cardstatus value at this contract boundary.	enum: pass, warn, fail, missing
commandRunCount	integer	No	Defines the commandruncount value at this contract boundary.	minimum: 0
exitCode	integer \| null	No	Defines the exitcode value at this contract boundary.	—
handoffSource	enum	No	Defines the handoffsource value at this contract boundary.	enum: repair, artifacts, advisor, tree, dashboard
incidentSummary	object	No	Defines the incidentsummary value at this contract boundary.	additionalProperties: false
incidentSummary.auditStatus	enum	Yes	Defines the auditstatus value at this contract boundary.	enum: not-started, pending, saved, failed, unknown
incidentSummary.phase	enum	Yes	Defines the phase value at this contract boundary.	enum: detect, diagnose, fix, verify, audit
incidentSummary.primaryAction	string	Yes	Defines the primaryaction value at this contract boundary.	minLength: 1
incidentSummary.title	string	Yes	Defines the title value at this contract boundary.	minLength: 1
incidentSummary.verifyRequired	boolean	Yes	Defines the verifyrequired value at this contract boundary.	—
projectPath	string	No	Defines the projectpath value at this contract boundary.	—
resolutionClass	enum	No	Defines the resolutionclass value at this contract boundary.	enum: artifact-missing, command-failed-repeat, config-fixable, semantic-attention, unresolvable-without-human
resolutionHints	array	No	Defines the resolutionhints value at this contract boundary.	—
schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "rapidkit-studio-blocker-handoff-v1"
scope	enum	Yes	Defines the scope value at this contract boundary.	enum: workspace, project
sourceCommand	string	Yes	Defines the sourcecommand value at this contract boundary.	—
stderrTail	string	No	Defines the stderrtail value at this contract boundary.	—
studioMode	enum	No	Defines the studiomode value at this contract boundary.	enum: FIX, RUN_ONCE, VERIFY_ONLY, EXPLAIN
verifyArtifact	string	No	Defines the verifyartifact value at this contract boundary.	—
verifyCommand	string	No	Defines the verifycommand value at this contract boundary.	—
workspacePath	string	No	Defines the workspacepath value at this contract boundary.	—

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/studio-blocker-handoff.v1.json",
  "title": "Workspai Studio Blocker Handoff",
  "type": "object",
  "required": [
    "schemaVersion",
    "cardId",
    "cardStatus",
    "blockers",
    "artifactPath",
    "sourceCommand",
    "scope"
  ],
  "properties": {
    "schemaVersion": {
      "const": "rapidkit-studio-blocker-handoff-v1"
    },
    "cardId": {
      "type": "string",
      "minLength": 1
    },
    "cardLabel": {
      "type": "string"
    },
    "cardStatus": {
      "enum": [
        "pass",
        "warn",
        "fail",
        "missing"
      ]
    },
    "blockers": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "artifactPath": {
      "type": "string"
    },
    "sourceCommand": {
      "type": "string"
    },
    "scope": {
      "enum": [
        "workspace",
        "project"
      ]
    },
    "stderrTail": {
      "type": "string"
    },
    "exitCode": {
      "type": [
        "integer",
        "null"
      ]
    },
    "blockerSignature": {
      "type": "string",
      "minLength": 8
    },
    "commandRunCount": {
      "type": "integer",
      "minimum": 0
    },
    "resolutionClass": {
      "enum": [
        "artifact-missing",
        "command-failed-repeat",
        "config-fixable",
        "semantic-attention",
        "unresolvable-without-human"
      ]
    },
    "studioMode": {
      "enum": [
        "FIX",
        "RUN_ONCE",
        "VERIFY_ONLY",
        "EXPLAIN"
      ]
    },
    "incidentSummary": {
      "type": "object",
      "required": [
        "title",
        "phase",
        "primaryAction",
        "verifyRequired",
        "auditStatus"
      ],
      "properties": {
        "title": {
          "type": "string",
          "minLength": 1
        },
        "phase": {
          "enum": [
            "detect",
            "diagnose",
            "fix",
            "verify",
            "audit"
          ]
        },
        "primaryAction": {
          "type": "string",
          "minLength": 1
        },
        "verifyRequired": {
          "type": "boolean"
        },
        "auditStatus": {
          "enum": [
            "not-started",
            "pending",
            "saved",
            "failed",
            "unknown"
          ]
        }
      },
      "additionalProperties": false
    },
    "resolutionHints": {
      "type": "array",
      "items": {
        "$ref": "blocker-resolution.v1.json"
      }
    },
    "verifyCommand": {
      "type": "string"
    },
    "verifyArtifact": {
      "type": "string"
    },
    "handoffSource": {
      "enum": [
        "repair",
        "artifacts",
        "advisor",
        "tree",
        "dashboard"
      ]
    },
    "workspacePath": {
      "type": "string"
    },
    "projectPath": {
      "type": "string"
    }
  },
  "additionalProperties": false
}