Workspace Intelligence / JSON Schema
Workspai Doctor JSON Summary
Defines the versioned doctor summary v1 boundary used by Workspai and its consumers.
- Schema version
workspai.doctor-summary.v1- Contract path
contracts/workspace-intelligence/doctor-summary.v1.json- Publication
- json-schema
- Defined fields
- 31
- Artifact bindings
- 0
Why this contract exists
Architecture role
Carries structured evidence, findings, and verdicts across governance boundaries.
Consumption boundary
- • Workspai CLI
- • CI and release automation
- • Developers
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 |
|---|---|---|---|---|
| affectedProjects | array | No | Defines the affectedprojects value at this contract boundary. | — |
| affectedProjects[].advisoryFindings | integer | Yes | Defines the advisoryfindings value at this contract boundary. | minimum: 0 |
| affectedProjects[].blockingCauses | integer | Yes | Defines the blockingcauses value at this contract boundary. | minimum: 0 |
| affectedProjects[].name | string | Yes | Defines the name value at this contract boundary. | — |
| affectedProjects[].path | string | Yes | Defines the path value at this contract boundary. | — |
| affectedProjects[].runtimeFamily | string | Yes | Defines the runtimefamily value at this contract boundary. | — |
| affectedProjects[].unknownFindings | integer | Yes | Defines the unknownfindings value at this contract boundary. | minimum: 0 |
| affectedProjects[].verdict | enum | Yes | Defines the verdict value at this contract boundary. | enum: passed, attention, blocked |
| artifacts | object | No | Defines the artifacts value at this contract boundary. | — |
| blockers | array | No | Defines the blockers value at this contract boundary. | — |
| blockers[].capabilityId | string | No | Defines the capabilityid value at this contract boundary. | — |
| blockers[].id | string | Yes | Defines the id value at this contract boundary. | — |
| blockers[].issueClass | string | Yes | Defines the issueclass value at this contract boundary. | — |
| blockers[].repairDisposition | enum | Yes | Defines the repairdisposition value at this contract boundary. | enum: automatic, approval-required, manual, unavailable, not-needed |
| blockers[].symptom | string | Yes | Defines the symptom value at this contract boundary. | — |
| counts | reference | Yes | Defines the counts value at this contract boundary. | ref: doctor-receipt.v1.json#/$defs/counts |
| freshness | reference | No | Defines the freshness value at this contract boundary. | ref: doctor-receipt.v1.json#/$defs/freshness |
| generatedAt | string | Yes | Defines the generatedat value at this contract boundary. | format: date-time |
| nextActions | array | No | Defines the nextactions value at this contract boundary. | — |
| project | object | No | Defines the project value at this contract boundary. | additionalProperties: false |
| project.framework | string | Yes | Defines the framework value at this contract boundary. | — |
| project.name | string | Yes | Defines the name value at this contract boundary. | — |
| project.path | string | Yes | Defines the path value at this contract boundary. | — |
| project.runtimeFamily | string | Yes | Defines the runtimefamily value at this contract boundary. | — |
| schemaVersion | string | Yes | Defines the schemaversion value at this contract boundary. | const: "workspai.doctor-summary.v1" |
| scope | enum | Yes | Defines the scope value at this contract boundary. | enum: system, workspace, project |
| system | object | No | Defines the system value at this contract boundary. | — |
| verdict | enum | Yes | Defines the verdict value at this contract boundary. | enum: passed, attention, blocked |
| workspace | object | null | No | Defines the workspace value at this contract boundary. | additionalProperties: false |
| workspace.name | string | Yes | Defines the name value at this contract boundary. | — |
| workspace.path | string | Yes | Defines the path 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://workspai.dev/schemas/workspace-intelligence/doctor-summary.v1.json",
"title": "Workspai Doctor JSON Summary",
"type": "object",
"required": [
"schemaVersion",
"generatedAt",
"scope",
"verdict",
"counts"
],
"properties": {
"schemaVersion": {
"const": "workspai.doctor-summary.v1"
},
"generatedAt": {
"type": "string",
"format": "date-time"
},
"scope": {
"enum": [
"system",
"workspace",
"project"
]
},
"verdict": {
"enum": [
"passed",
"attention",
"blocked"
]
},
"counts": {
"$ref": "doctor-receipt.v1.json#/$defs/counts"
},
"freshness": {
"$ref": "doctor-receipt.v1.json#/$defs/freshness"
},
"workspace": {
"type": [
"object",
"null"
],
"required": [
"name",
"path"
],
"properties": {
"name": {
"type": "string"
},
"path": {
"type": "string"
}
},
"additionalProperties": false
},
"project": {
"type": "object",
"required": [
"name",
"path",
"runtimeFamily",
"framework"
],
"properties": {
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"runtimeFamily": {
"type": "string"
},
"framework": {
"type": "string"
}
},
"additionalProperties": false
},
"affectedProjects": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"path",
"runtimeFamily",
"verdict",
"blockingCauses",
"advisoryFindings",
"unknownFindings"
],
"properties": {
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"runtimeFamily": {
"type": "string"
},
"verdict": {
"enum": [
"passed",
"attention",
"blocked"
]
},
"blockingCauses": {
"type": "integer",
"minimum": 0
},
"advisoryFindings": {
"type": "integer",
"minimum": 0
},
"unknownFindings": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
}
},
"blockers": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"issueClass",
"symptom",
"repairDisposition"
],
"properties": {
"id": {
"type": "string"
},
"issueClass": {
"type": "string"
},
"symptom": {
"type": "string"
},
"repairDisposition": {
"enum": [
"automatic",
"approval-required",
"manual",
"unavailable",
"not-needed"
]
},
"capabilityId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"system": {
"type": "object",
"additionalProperties": {
"type": "object",
"required": [
"status",
"message"
],
"properties": {
"status": {
"enum": [
"ok",
"warn",
"error"
]
},
"message": {
"type": "string"
}
},
"additionalProperties": false
}
},
"artifacts": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"nextActions": {
"type": "array",
"items": {
"type": "string"
}
}
},
"allOf": [
{
"if": {
"properties": {
"scope": {
"const": "workspace"
}
}
},
"then": {
"required": [
"workspace",
"affectedProjects",
"freshness",
"artifacts"
]
}
},
{
"if": {
"properties": {
"scope": {
"const": "project"
}
}
},
"then": {
"required": [
"workspace",
"project",
"blockers",
"freshness",
"artifacts"
]
}
},
{
"if": {
"properties": {
"scope": {
"const": "system"
}
}
},
"then": {
"required": [
"system",
"nextActions"
]
}
}
],
"additionalProperties": false
}