Diagnostics and remediation / JSON Schema

Workspai Doctor Workspace Cache

Defines the versioned doctor workspace cache v2 boundary used by Workspai and its consumers.

Schema version: doctor-workspace-cache-v2
Contract path: contracts/doctor-workspace-cache.v2.json
Publication: json-schema
Defined fields: 14
Artifact bindings: 1

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.

workspai doctor workspace

Produced artifacts

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

Artifact path	Schema	Producer
.workspai/reports/doctor-workspace-cache.json	doctor-workspace-cache-v2	workspai doctor workspace

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
generatedAt	string	Yes	Defines the generatedat value at this contract boundary.	format: date-time
projects	array	Yes	Defines the projects value at this contract boundary.	—
projects[].coreInstalled	boolean	Yes	Defines the coreinstalled value at this contract boundary.	—
projects[].depsInstalled	boolean	Yes	Defines the depsinstalled value at this contract boundary.	—
projects[].fixCommands	array	No	Defines the fixcommands value at this contract boundary.	—
projects[].issues	array	Yes	Defines the issues value at this contract boundary.	—
projects[].name	string	Yes	Defines the name value at this contract boundary.	minLength: 1
projects[].path	string	Yes	Defines the path value at this contract boundary.	minLength: 1
projects[].probes	array	No	Defines the probes value at this contract boundary.	—
projects[].projectKind	string	No	Defines the projectkind value at this contract boundary.	—
projects[].runtimeFamily	string	No	Defines the runtimefamily value at this contract boundary.	—
projects[].venvActive	boolean	Yes	Defines the venvactive value at this contract boundary.	—
schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "doctor-workspace-cache-v2"
signature	string	Yes	Defines the signature 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://workspai.dev/schemas/doctor-workspace-cache.v2.json",
  "title": "Workspai Doctor Workspace Cache",
  "type": "object",
  "required": [
    "schemaVersion",
    "signature",
    "generatedAt",
    "projects"
  ],
  "properties": {
    "schemaVersion": {
      "const": "doctor-workspace-cache-v2"
    },
    "signature": {
      "type": "string",
      "minLength": 1
    },
    "generatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "projects": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name",
          "path",
          "venvActive",
          "depsInstalled",
          "coreInstalled",
          "issues"
        ],
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "path": {
            "type": "string",
            "minLength": 1
          },
          "venvActive": {
            "type": "boolean"
          },
          "depsInstalled": {
            "type": "boolean"
          },
          "coreInstalled": {
            "type": "boolean"
          },
          "issues": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "fixCommands": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "runtimeFamily": {
            "type": "string"
          },
          "projectKind": {
            "type": "string"
          },
          "probes": {
            "type": "array",
            "items": {
              "type": "object"
            }
          }
        },
        "additionalProperties": true
      }
    }
  },
  "additionalProperties": true
}