All contracts

Diagnostics and remediation / JSON Schema

Doctor Workspace Cache V2

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
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 pathTypeRequiredMeaningConstraints
generatedAtstringYesDefines the generatedat value at this contract boundary.format: date-time
projectsarrayYesDefines the projects value at this contract boundary.
projects[].coreInstalledbooleanYesDefines the coreinstalled value at this contract boundary.
projects[].depsInstalledbooleanYesDefines the depsinstalled value at this contract boundary.
projects[].fixCommandsarrayNoDefines the fixcommands value at this contract boundary.
projects[].issuesarrayYesDefines the issues value at this contract boundary.
projects[].namestringYesDefines the name value at this contract boundary.minLength: 1
projects[].pathstringYesDefines the path value at this contract boundary.minLength: 1
projects[].probesarrayNoDefines the probes value at this contract boundary.
projects[].projectKindstringNoDefines the projectkind value at this contract boundary.
projects[].runtimeFamilystringNoDefines the runtimefamily value at this contract boundary.
projects[].venvActivebooleanYesDefines the venvactive value at this contract boundary.
schemaVersionstringYesDefines the schemaversion value at this contract boundary.const: "doctor-workspace-cache-v2"
signaturestringYesDefines 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",
  "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
}