All contracts

Workspace Intelligence / JSON Schema

Workspace contract verify evidence

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

Schema version
workspace-contract-verify.v1
Contract path
contracts/workspace-intelligence/workspace-contract-verify.v1.json
Publication
embedded-type
Defined fields
10
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.

Produced artifacts

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

Artifact pathSchemaProducer
.workspai/reports/workspace-contract-verify-last-run.jsonworkspace-contract-verify.v1
workspai workspace contract verify --strict --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 pathTypeRequiredMeaningConstraints
checksarrayYesDefines the checks value at this contract boundary.
checks[].idstringYesDefines the id value at this contract boundary.
checks[].messagestringYesDefines the message value at this contract boundary.
checks[].statusenumYesDefines the status value at this contract boundary.enum: passed, failed
contractPathstringYesDefines the contractpath value at this contract boundary.
generatedAtstringYesDefines the generatedat value at this contract boundary.format: date-time
projectCountintegerYesDefines the projectcount value at this contract boundary.minimum: 0
schemaVersionstringYesDefines the schemaversion value at this contract boundary.const: "workspace-contract-verify.v1"
statusenumYesDefines the status value at this contract boundary.enum: passed, failed
violationsarrayYesDefines the violations 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": "http://json-schema.org/draft-07/schema#",
  "$id": "workspace-contract-verify.v1",
  "title": "Workspace contract verify evidence",
  "type": "object",
  "additionalProperties": true,
  "required": [
    "schemaVersion",
    "generatedAt",
    "status",
    "contractPath",
    "projectCount",
    "checks",
    "violations"
  ],
  "properties": {
    "schemaVersion": {
      "const": "workspace-contract-verify.v1"
    },
    "generatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "status": {
      "enum": [
        "passed",
        "failed"
      ]
    },
    "contractPath": {
      "type": "string"
    },
    "projectCount": {
      "type": "integer",
      "minimum": 0
    },
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "status",
          "message"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "status": {
            "enum": [
              "passed",
              "failed"
            ]
          },
          "message": {
            "type": "string"
          }
        }
      }
    },
    "violations": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}