All contracts

Workspace Intelligence / JSON Schema

Workspai Proof-Carrying Change List

Defines the versioned proof carrying change list v1 boundary used by Workspai and its consumers.

Schema version
workspai.proof-carrying-change-list.v1
Contract path
contracts/workspace-intelligence/proof-carrying-change-list.v1.json
Publication
json-schema
Defined fields
26
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
changesarrayYesDefines the changes value at this contract boundary.
changes[].assuranceobjectYesDefines the assurance value at this contract boundary.additionalProperties: false
changes[].assurance.passedintegerYesDefines the passed value at this contract boundary.minimum: 0
changes[].assurance.totalintegerYesDefines the total value at this contract boundary.minimum: 0
changes[].blockersarrayYesDefines the blockers value at this contract boundary.
changes[].capsuleArtifactstringYesDefines the capsuleartifact value at this contract boundary.minLength: 1
changes[].changeIdstringYesDefines the changeid value at this contract boundary.pattern: ^change-[a-z0-9][a-z0-9-]{7,95}$
changes[].createdAtanyYesDefines the createdat value at this contract boundary.
changes[].errorsarrayYesDefines the errors value at this contract boundary.
changes[].goalIdstring | nullYesDefines the goalid value at this contract boundary.
changes[].scopeanyYesDefines the scope value at this contract boundary.
changes[].statestring | nullYesDefines the state value at this contract boundary.
changes[].statusenumYesDefines the status value at this contract boundary.enum: open, blocked, verified, sealed, aborted, invalid
changes[].updatedAtanyYesDefines the updatedat value at this contract boundary.
changes[].validbooleanYesDefines the valid value at this contract boundary.
generatedAtstringYesDefines the generatedat value at this contract boundary.format: date-time
schemaVersionstringYesDefines the schemaversion value at this contract boundary.const: "workspai.proof-carrying-change-list.v1"
summaryobjectYesDefines the summary value at this contract boundary.additionalProperties: false
summary.abortedintegerYesDefines the aborted value at this contract boundary.minimum: 0
summary.blockedintegerYesDefines the blocked value at this contract boundary.minimum: 0
summary.invalidintegerYesDefines the invalid value at this contract boundary.minimum: 0
summary.openintegerYesDefines the open value at this contract boundary.minimum: 0
summary.sealedintegerYesDefines the sealed value at this contract boundary.minimum: 0
summary.totalintegerYesDefines the total value at this contract boundary.minimum: 0
workspaceobjectYesDefines the workspace value at this contract boundary.additionalProperties: false
workspace.namestringYesDefines the name 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/proof-carrying-change-list.v1.json",
  "title": "Workspai Proof-Carrying Change List",
  "type": "object",
  "required": [
    "schemaVersion",
    "generatedAt",
    "workspace",
    "changes",
    "summary"
  ],
  "properties": {
    "schemaVersion": {
      "const": "workspai.proof-carrying-change-list.v1"
    },
    "generatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "workspace": {
      "type": "object",
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "changes": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "changeId",
          "goalId",
          "state",
          "status",
          "createdAt",
          "updatedAt",
          "scope",
          "assurance",
          "blockers",
          "capsuleArtifact",
          "valid",
          "errors"
        ],
        "properties": {
          "changeId": {
            "type": "string",
            "pattern": "^change-[a-z0-9][a-z0-9-]{7,95}$"
          },
          "goalId": {
            "type": [
              "string",
              "null"
            ]
          },
          "state": {
            "type": [
              "string",
              "null"
            ]
          },
          "status": {
            "enum": [
              "open",
              "blocked",
              "verified",
              "sealed",
              "aborted",
              "invalid"
            ]
          },
          "createdAt": {
            "oneOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ]
          },
          "updatedAt": {
            "oneOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ]
          },
          "scope": {
            "oneOf": [
              {
                "$ref": "decision-event.v1.json#/$defs/scope"
              },
              {
                "type": "null"
              }
            ]
          },
          "assurance": {
            "type": "object",
            "required": [
              "passed",
              "total"
            ],
            "properties": {
              "passed": {
                "type": "integer",
                "minimum": 0
              },
              "total": {
                "type": "integer",
                "minimum": 0
              }
            },
            "additionalProperties": false
          },
          "blockers": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "capsuleArtifact": {
            "type": "string",
            "minLength": 1
          },
          "valid": {
            "type": "boolean"
          },
          "errors": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1
            }
          }
        },
        "additionalProperties": false
      }
    },
    "summary": {
      "type": "object",
      "required": [
        "total",
        "open",
        "blocked",
        "sealed",
        "aborted",
        "invalid"
      ],
      "properties": {
        "total": {
          "type": "integer",
          "minimum": 0
        },
        "open": {
          "type": "integer",
          "minimum": 0
        },
        "blocked": {
          "type": "integer",
          "minimum": 0
        },
        "sealed": {
          "type": "integer",
          "minimum": 0
        },
        "aborted": {
          "type": "integer",
          "minimum": 0
        },
        "invalid": {
          "type": "integer",
          "minimum": 0
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}