All contracts

Workspace Intelligence / JSON Schema

Workspai Goal Lifecycle Result

Defines the versioned goal lifecycle result v1 boundary used by Workspai and its consumers.

Schema version
workspai.goal-lifecycle-result.v1
Contract path
contracts/workspace-intelligence/goal-lifecycle-result.v1.json
Publication
json-schema
Defined fields
33
Artifact bindings
0

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.

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
$defs.goalEntry.agentHandoffstringYesDefines the agenthandoff value at this contract boundary.
$defs.goalEntry.categoryenumYesDefines the category value at this contract boundary.enum: release-readiness, dependency-security, test-coverage, defect-repair, feature-change, refactor, performance, documentation, system-understanding
$defs.goalEntry.createdAtstringYesDefines the createdat value at this contract boundary.format: date-time
$defs.goalEntry.fingerprintstringYesDefines the fingerprint value at this contract boundary.pattern: ^[a-f0-9]{64}$
$defs.goalEntry.goalPackstringYesDefines the goalpack value at this contract boundary.
$defs.goalEntry.idstringYesDefines the id value at this contract boundary.
$defs.goalEntry.lifecycleenumYesDefines the lifecycle value at this contract boundary.enum: planned, active, cancelled, verification-ready, verified, failed
$defs.goalEntry.objectivestringYesDefines the objective value at this contract boundary.minLength: 1
$defs.goalEntry.repairTransactionIdstringNoDefines the repairtransactionid value at this contract boundary.
$defs.goalEntry.scopeobjectYesDefines the scope value at this contract boundary.additionalProperties: false
$defs.goalEntry.scope.kindenumYesDefines the kind value at this contract boundary.enum: workspace, project, project-set
$defs.goalEntry.scope.projectsarrayYesDefines the projects value at this contract boundary.minItems: 1
$defs.goalEntry.scope.resolutionenumNoDefines the resolution value at this contract boundary.enum: selected, selection-required
$defs.goalEntry.scope.selectionSourceenumYesDefines the selectionsource value at this contract boundary.enum: workspace, single-project-workspace, invocation-project, explicit, interactive
$defs.goalEntry.stateenumYesDefines the state value at this contract boundary.enum: ready-to-plan, needs-confirmation, needs-evidence, blocked
$defs.goalEntry.updatedAtstringYesDefines the updatedat value at this contract boundary.format: date-time
$defs.goalEntry.verificationReceiptobjectNoDefines the verificationreceipt value at this contract boundary.additionalProperties: false
$defs.goalEntry.verificationReceipt.attemptintegerYesDefines the attempt value at this contract boundary.minimum: 1
$defs.goalEntry.verificationReceipt.graphFingerprintstringYesDefines the graphfingerprint value at this contract boundary.pattern: ^[a-f0-9]{64}$
$defs.goalEntry.verificationReceipt.graphFingerprintSemanticsenumYesDefines the graphfingerprintsemantics value at this contract boundary.enum: workspace-knowledge-graph-inputs-v1, canonical-json-v1
$defs.goalEntry.verificationReceipt.modelHashstringYesDefines the modelhash value at this contract boundary.pattern: ^[a-f0-9]{64}$
$defs.goalEntry.verificationReceipt.recordedAtstringYesDefines the recordedat value at this contract boundary.format: date-time
$defs.goalEntry.verificationReceipt.statusHashstringYesDefines the statushash value at this contract boundary.pattern: ^[a-f0-9]{64}$
$defs.goalEntry.verificationReceipt.verifiedGoalIdstringYesDefines the verifiedgoalid value at this contract boundary.minLength: 1
$defs.goalEntry.verifiedGoalIdstringNoDefines the verifiedgoalid value at this contract boundary.
activeGoalIdstring | nullYesDefines the activegoalid value at this contract boundary.
goalanyYesDefines the goal value at this contract boundary.
goalPackanyYesDefines the goalpack value at this contract boundary.
goalsarrayYesDefines the goals value at this contract boundary.
operationenumYesDefines the operation value at this contract boundary.enum: status, list, activate, cancel, prepare, verify
schemaVersionstringYesDefines the schemaversion value at this contract boundary.const: "workspai.goal-lifecycle-result.v1"
verificationobject | nullYesDefines the verification value at this contract boundary.
verifiedGoalIdstring | nullYesDefines the verifiedgoalid 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/goal-lifecycle-result.v1.json",
  "title": "Workspai Goal Lifecycle Result",
  "type": "object",
  "required": [
    "schemaVersion",
    "operation",
    "activeGoalId",
    "goal",
    "goals",
    "goalPack",
    "verifiedGoalId",
    "verification"
  ],
  "properties": {
    "schemaVersion": {
      "const": "workspai.goal-lifecycle-result.v1"
    },
    "operation": {
      "enum": [
        "status",
        "list",
        "activate",
        "cancel",
        "prepare",
        "verify"
      ]
    },
    "activeGoalId": {
      "type": [
        "string",
        "null"
      ]
    },
    "goal": {
      "anyOf": [
        {
          "$ref": "#/$defs/goalEntry"
        },
        {
          "type": "null"
        }
      ]
    },
    "goals": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/goalEntry"
      }
    },
    "goalPack": {
      "anyOf": [
        {
          "type": "object",
          "required": [
            "schemaVersion",
            "id",
            "fingerprint",
            "state"
          ],
          "properties": {
            "schemaVersion": {
              "const": "workspai.goal-pack.v1"
            },
            "id": {
              "type": "string"
            },
            "fingerprint": {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            },
            "state": {
              "enum": [
                "ready-to-plan",
                "needs-confirmation",
                "needs-evidence",
                "blocked"
              ]
            }
          }
        },
        {
          "type": "null"
        }
      ]
    },
    "verifiedGoalId": {
      "type": [
        "string",
        "null"
      ]
    },
    "verification": {
      "type": [
        "object",
        "null"
      ]
    }
  },
  "$defs": {
    "goalEntry": {
      "type": "object",
      "required": [
        "id",
        "fingerprint",
        "objective",
        "category",
        "state",
        "lifecycle",
        "scope",
        "createdAt",
        "updatedAt",
        "goalPack",
        "agentHandoff"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "fingerprint": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        "objective": {
          "type": "string",
          "minLength": 1
        },
        "category": {
          "enum": [
            "release-readiness",
            "dependency-security",
            "test-coverage",
            "defect-repair",
            "feature-change",
            "refactor",
            "performance",
            "documentation",
            "system-understanding"
          ]
        },
        "state": {
          "enum": [
            "ready-to-plan",
            "needs-confirmation",
            "needs-evidence",
            "blocked"
          ]
        },
        "lifecycle": {
          "enum": [
            "planned",
            "active",
            "cancelled",
            "verification-ready",
            "verified",
            "failed"
          ]
        },
        "scope": {
          "type": "object",
          "required": [
            "kind",
            "projects",
            "selectionSource"
          ],
          "properties": {
            "kind": {
              "enum": [
                "workspace",
                "project",
                "project-set"
              ]
            },
            "projects": {
              "type": "array",
              "minItems": 1,
              "items": {
                "type": "string",
                "minLength": 1
              },
              "uniqueItems": true
            },
            "selectionSource": {
              "enum": [
                "workspace",
                "single-project-workspace",
                "invocation-project",
                "explicit",
                "interactive"
              ]
            },
            "resolution": {
              "enum": [
                "selected",
                "selection-required"
              ]
            }
          },
          "allOf": [
            {
              "if": {
                "properties": {
                  "kind": {
                    "const": "project"
                  }
                }
              },
              "then": {
                "properties": {
                  "projects": {
                    "type": "array",
                    "maxItems": 1
                  }
                }
              }
            },
            {
              "if": {
                "properties": {
                  "kind": {
                    "const": "project-set"
                  }
                }
              },
              "then": {
                "properties": {
                  "projects": {
                    "type": "array",
                    "minItems": 2
                  }
                }
              }
            },
            {
              "if": {
                "properties": {
                  "resolution": {
                    "const": "selection-required"
                  }
                },
                "required": [
                  "resolution"
                ]
              },
              "then": {
                "properties": {
                  "kind": {
                    "const": "workspace"
                  },
                  "selectionSource": {
                    "const": "workspace"
                  }
                }
              }
            }
          ],
          "additionalProperties": false
        },
        "createdAt": {
          "type": "string",
          "format": "date-time"
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time"
        },
        "goalPack": {
          "type": "string"
        },
        "agentHandoff": {
          "type": "string"
        },
        "verifiedGoalId": {
          "type": "string"
        },
        "repairTransactionId": {
          "type": "string"
        },
        "verificationReceipt": {
          "type": "object",
          "required": [
            "verifiedGoalId",
            "attempt",
            "statusHash",
            "modelHash",
            "graphFingerprint",
            "graphFingerprintSemantics",
            "recordedAt"
          ],
          "properties": {
            "verifiedGoalId": {
              "type": "string",
              "minLength": 1
            },
            "attempt": {
              "type": "integer",
              "minimum": 1
            },
            "statusHash": {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            },
            "modelHash": {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            },
            "graphFingerprint": {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            },
            "graphFingerprintSemantics": {
              "enum": [
                "workspace-knowledge-graph-inputs-v1",
                "canonical-json-v1"
              ]
            },
            "recordedAt": {
              "type": "string",
              "format": "date-time"
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}