Workspace Intelligence / JSON Schema

Workspai Workspace Explain Report

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

Schema version: workspace-explain.v1
Contract path: contracts/workspace-intelligence/workspace-explain.v1.json
Publication: embedded-type, json-schema
Defined fields: 13
Artifact bindings: 3

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.

workspai workspace explain workspai workspace trace workspai workspace why

Produced artifacts

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

Artifact path	Schema	Producer
.workspai/reports/workspace-explain-last-run.json	workspace-explain.v1	workspai workspace explain release-blocked --json --write
.workspai/reports/workspace-trace-last-run.json	workspace-explain.v1	workspai workspace trace
.workspai/reports/workspace-why-last-run.json	workspace-explain.v1	workspai workspace why

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
blockingReasons	array	No	Defines the blockingreasons value at this contract boundary.	—
generatedAt	string	Yes	Defines the generatedat value at this contract boundary.	format: date-time
releaseRisk	string	No	Defines the releaserisk value at this contract boundary.	—
resolutionHints	array	No	Defines the resolutionhints value at this contract boundary.	—
runId	string	No	Defines the runid value at this contract boundary.	minLength: 1
schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "workspace-explain.v1"
sections	array	Yes	Defines the sections value at this contract boundary.	—
sections[].body	string	Yes	Defines the body value at this contract boundary.	—
sections[].id	string	Yes	Defines the id value at this contract boundary.	—
sections[].title	string	Yes	Defines the title value at this contract boundary.	—
summary	string	Yes	Defines the summary value at this contract boundary.	—
target	object	Yes	Defines the target value at this contract boundary.	additionalProperties: true
workspacePath	string	Yes	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/workspace-explain.v1.json",
  "title": "Workspai Workspace Explain Report",
  "type": "object",
  "required": [
    "schemaVersion",
    "generatedAt",
    "workspacePath",
    "target",
    "summary",
    "sections"
  ],
  "properties": {
    "schemaVersion": {
      "const": "workspace-explain.v1"
    },
    "runId": {
      "type": "string",
      "minLength": 1
    },
    "generatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "workspacePath": {
      "type": "string"
    },
    "target": {
      "type": "object",
      "additionalProperties": true
    },
    "summary": {
      "type": "string"
    },
    "sections": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "title",
          "body"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "body": {
            "type": "string"
          }
        },
        "additionalProperties": false
      }
    },
    "releaseRisk": {
      "type": "string"
    },
    "blockingReasons": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "resolutionHints": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  },
  "additionalProperties": false
}