All contracts

Workspace Intelligence / JSON Schema

Workspai Verified Goal Status

The durable progress and evidence-derived terminal state of a Workspai verified goal.

Schema version
workspai.verified-goal-status.v1
Contract path
contracts/workspace-intelligence/verified-goal-status.v1.json
Publication
json-schema, embedded-type
Defined fields
27
Artifact bindings
1

Why this contract exists

Architecture role

Defines a versioned interoperability boundary used by Workspai and contract-aware consumers.

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.

Produced artifacts

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

Artifact pathSchemaProducer
.workspai/reports/verified-goal-last-run.jsonworkspai.verified-goal-status.v1
workspai workspace goal plan
workspai workspace goal verify

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
$defs.measurement.evidencePathsarrayYesDefines the evidencepaths value at this contract boundary.
$defs.measurement.measuredAtstringYesDefines the measuredat value at this contract boundary.format: date-time
$defs.measurement.messagestringYesDefines the message value at this contract boundary.minLength: 1
$defs.measurement.statusenumYesDefines the status value at this contract boundary.enum: satisfied, unsatisfied, unavailable
$defs.measurement.targetnumber | nullYesDefines the target value at this contract boundary.
$defs.measurement.unitenumYesDefines the unit value at this contract boundary.enum: percent, blocking-vulnerabilities, gates, unknown
$defs.measurement.valuenumber | nullYesDefines the value value at this contract boundary.
artifactPathstringYesDefines the artifactpath value at this contract boundary.minLength: 1
attemptintegerYesDefines the attempt value at this contract boundary.minimum: 0
blockingReasonsarrayYesDefines the blockingreasons value at this contract boundary.
checksarrayYesDefines the checks value at this contract boundary.
checks[].actualstringYesDefines the actual value at this contract boundary.minLength: 1
checks[].evidencePathstringNoDefines the evidencepath value at this contract boundary.minLength: 1
checks[].expectedstringYesDefines the expected value at this contract boundary.minLength: 1
checks[].idstringYesDefines the id value at this contract boundary.minLength: 1
checks[].labelstringYesDefines the label value at this contract boundary.minLength: 1
checks[].messagestringYesDefines the message value at this contract boundary.minLength: 1
checks[].statusenumYesDefines the status value at this contract boundary.enum: passed, failed, blocked, missing, skipped
evidencePathsarrayYesDefines the evidencepaths value at this contract boundary.
goalFingerprintstringYesDefines the goalfingerprint value at this contract boundary.pattern: ^[a-f0-9]{64}$
goalIdstringYesDefines the goalid value at this contract boundary.minLength: 8
nextActionsarrayYesDefines the nextactions value at this contract boundary.
progressreferenceYesDefines the progress value at this contract boundary.ref: #/$defs/measurement
schemaVersionstringYesDefines the schemaversion value at this contract boundary.const: "workspai.verified-goal-status.v1"
stateenumYesDefines the state value at this contract boundary.enum: planned, active, blocked, verified, failed, cancelled
updatedAtstringYesDefines the updatedat value at this contract boundary.format: date-time
workspacePathstringYesDefines the workspacepath 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/workspace-intelligence/verified-goal-status.v1.json",
  "title": "Workspai Verified Goal Status",
  "description": "The durable progress and evidence-derived terminal state of a Workspai verified goal.",
  "type": "object",
  "required": [
    "schemaVersion",
    "goalId",
    "goalFingerprint",
    "workspacePath",
    "updatedAt",
    "state",
    "attempt",
    "progress",
    "checks",
    "blockingReasons",
    "evidencePaths",
    "nextActions",
    "artifactPath"
  ],
  "properties": {
    "schemaVersion": {
      "const": "workspai.verified-goal-status.v1"
    },
    "goalId": {
      "type": "string",
      "minLength": 8
    },
    "goalFingerprint": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$"
    },
    "workspacePath": {
      "type": "string",
      "minLength": 1
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "state": {
      "enum": [
        "planned",
        "active",
        "blocked",
        "verified",
        "failed",
        "cancelled"
      ]
    },
    "attempt": {
      "type": "integer",
      "minimum": 0
    },
    "progress": {
      "$ref": "#/$defs/measurement"
    },
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "label",
          "status",
          "expected",
          "actual",
          "message"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "label": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "enum": [
              "passed",
              "failed",
              "blocked",
              "missing",
              "skipped"
            ]
          },
          "expected": {
            "type": "string",
            "minLength": 1
          },
          "actual": {
            "type": "string",
            "minLength": 1
          },
          "evidencePath": {
            "type": "string",
            "minLength": 1
          },
          "message": {
            "type": "string",
            "minLength": 1
          }
        },
        "additionalProperties": false
      }
    },
    "blockingReasons": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "evidencePaths": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "uniqueItems": true
    },
    "nextActions": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "artifactPath": {
      "type": "string",
      "minLength": 1
    }
  },
  "$defs": {
    "measurement": {
      "type": "object",
      "required": [
        "measuredAt",
        "value",
        "target",
        "unit",
        "status",
        "evidencePaths",
        "message"
      ],
      "properties": {
        "measuredAt": {
          "type": "string",
          "format": "date-time"
        },
        "value": {
          "type": [
            "number",
            "null"
          ]
        },
        "target": {
          "type": [
            "number",
            "null"
          ]
        },
        "unit": {
          "enum": [
            "percent",
            "blocking-vulnerabilities",
            "gates",
            "unknown"
          ]
        },
        "status": {
          "enum": [
            "satisfied",
            "unsatisfied",
            "unavailable"
          ]
        },
        "evidencePaths": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          },
          "uniqueItems": true
        },
        "message": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}