Workspace Intelligence / JSON Schema

Workspai Workspace Impact

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

Schema version: workspace-impact.v1
Contract path: contracts/workspace-intelligence/workspace-impact.v1.json
Publication: embedded-type, json-schema
Defined fields: 35
Artifact bindings: 1

Why this contract exists

Architecture role

Relates workspace structure and change so downstream reasoning remains traceable.

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 impact

Produced artifacts

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

Artifact path	Schema	Producer
.workspai/reports/workspace-impact-last-run.json	workspace-impact.v1	workspai workspace impact --from .workspai/reports/workspace-model-diff-last-run.json --json

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
affectedProjects	array	Yes	Defines the affectedprojects value at this contract boundary.	—
agentBrief	object	Yes	Defines the agentbrief value at this contract boundary.	additionalProperties: false
agentBrief.bullets	array	Yes	Defines the bullets value at this contract boundary.	—
agentBrief.headline	string	Yes	Defines the headline value at this contract boundary.	—
agentBrief.unsafeAssumptions	array	Yes	Defines the unsafeassumptions value at this contract boundary.	—
criticalPathHotspots	array	Yes	Defines the criticalpathhotspots value at this contract boundary.	—
criticalPathHotspots[].betweenness	number	Yes	Defines the betweenness value at this contract boundary.	minimum: 0
criticalPathHotspots[].fanIn	integer	Yes	Defines the fanin value at this contract boundary.	minimum: 0
criticalPathHotspots[].fanOut	integer	Yes	Defines the fanout value at this contract boundary.	minimum: 0
criticalPathHotspots[].project	string	Yes	Defines the project value at this contract boundary.	—
criticalPathHotspots[].reach	integer	Yes	Defines the reach value at this contract boundary.	minimum: 0
diff	object	Yes	Defines the diff value at this contract boundary.	additionalProperties: true
diff.schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "workspace-model-diff.v1"
diffRef	string	Yes	Defines the diffref value at this contract boundary.	—
fromRef	string	Yes	Defines the fromref value at this contract boundary.	—
generatedAt	string	Yes	Defines the generatedat value at this contract boundary.	format: date-time
schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "workspace-impact.v1"
summary	object	Yes	Defines the summary value at this contract boundary.	additionalProperties: false
summary.affectedProjects	integer	Yes	Defines the affectedprojects value at this contract boundary.	minimum: 0
summary.blastRadius	object	Yes	Defines the blastradius value at this contract boundary.	additionalProperties: false
summary.blastRadius.directlyAffected	integer	Yes	Defines the directlyaffected value at this contract boundary.	minimum: 0
summary.blastRadius.graphEdges	integer	Yes	Defines the graphedges value at this contract boundary.	minimum: 0
summary.blastRadius.maxDistance	integer	Yes	Defines the maxdistance value at this contract boundary.	minimum: 0
summary.blastRadius.transitivelyAffected	integer	Yes	Defines the transitivelyaffected value at this contract boundary.	minimum: 0
summary.changed	boolean	Yes	Defines the changed value at this contract boundary.	—
summary.recommendedCommands	integer	Yes	Defines the recommendedcommands value at this contract boundary.	minimum: 0
summary.risk	enum	Yes	Defines the risk value at this contract boundary.	enum: none, low, medium, high, critical
summary.workspaceItems	integer	Yes	Defines the workspaceitems value at this contract boundary.	minimum: 0
transitiveImpact	array	Yes	Defines the transitiveimpact value at this contract boundary.	—
verificationPlan	array	Yes	Defines the verificationplan value at this contract boundary.	—
workspace	object	Yes	Defines the workspace value at this contract boundary.	additionalProperties: false
workspace.name	string	Yes	Defines the name value at this contract boundary.	—
workspace.profile	string	No	Defines the profile value at this contract boundary.	—
workspace.type	string	Yes	Defines the type value at this contract boundary.	—
workspaceImpact	array	Yes	Defines the workspaceimpact 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-impact.v1.json",
  "title": "Workspai Workspace Impact",
  "type": "object",
  "required": [
    "schemaVersion",
    "generatedAt",
    "fromRef",
    "diffRef",
    "workspace",
    "summary",
    "affectedProjects",
    "transitiveImpact",
    "criticalPathHotspots",
    "workspaceImpact",
    "verificationPlan",
    "agentBrief",
    "diff"
  ],
  "properties": {
    "schemaVersion": {
      "const": "workspace-impact.v1"
    },
    "generatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "fromRef": {
      "type": "string"
    },
    "diffRef": {
      "type": "string"
    },
    "workspace": {
      "type": "object",
      "required": [
        "name",
        "type"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "profile": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "summary": {
      "type": "object",
      "required": [
        "changed",
        "risk",
        "affectedProjects",
        "workspaceItems",
        "recommendedCommands",
        "blastRadius"
      ],
      "properties": {
        "changed": {
          "type": "boolean"
        },
        "risk": {
          "enum": [
            "none",
            "low",
            "medium",
            "high",
            "critical"
          ]
        },
        "affectedProjects": {
          "type": "integer",
          "minimum": 0
        },
        "workspaceItems": {
          "type": "integer",
          "minimum": 0
        },
        "recommendedCommands": {
          "type": "integer",
          "minimum": 0
        },
        "blastRadius": {
          "type": "object",
          "required": [
            "directlyAffected",
            "transitivelyAffected",
            "maxDistance",
            "graphEdges"
          ],
          "properties": {
            "directlyAffected": {
              "type": "integer",
              "minimum": 0
            },
            "transitivelyAffected": {
              "type": "integer",
              "minimum": 0
            },
            "maxDistance": {
              "type": "integer",
              "minimum": 0
            },
            "graphEdges": {
              "type": "integer",
              "minimum": 0
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },
    "affectedProjects": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "transitiveImpact": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "criticalPathHotspots": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "project",
          "fanIn",
          "fanOut",
          "reach",
          "betweenness"
        ],
        "properties": {
          "project": {
            "type": "string"
          },
          "fanIn": {
            "type": "integer",
            "minimum": 0
          },
          "fanOut": {
            "type": "integer",
            "minimum": 0
          },
          "reach": {
            "type": "integer",
            "minimum": 0
          },
          "betweenness": {
            "type": "number",
            "minimum": 0
          }
        },
        "additionalProperties": true
      }
    },
    "workspaceImpact": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "verificationPlan": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "agentBrief": {
      "type": "object",
      "required": [
        "headline",
        "bullets",
        "unsafeAssumptions"
      ],
      "properties": {
        "headline": {
          "type": "string"
        },
        "bullets": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "unsafeAssumptions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "diff": {
      "type": "object",
      "required": [
        "schemaVersion"
      ],
      "properties": {
        "schemaVersion": {
          "const": "workspace-model-diff.v1"
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true
}