Workspace Intelligence / JSON Schema

Workspai Change Operation Result

Defines the versioned change operation result v1 boundary used by Workspai and its consumers.

Schema version: workspai.change-operation-result.v1
Contract path: contracts/workspace-intelligence/change-operation-result.v1.json
Publication: json-schema
Defined fields: 7
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 path	Type	Required	Meaning	Constraints
artifacts	object	Yes	Defines the artifacts value at this contract boundary.	—
capsule	reference	Yes	Defines the capsule value at this contract boundary.	ref: proof-carrying-change-capsule.v1.json
changeId	string	Yes	Defines the changeid value at this contract boundary.	pattern: ^change-[a-z0-9][a-z0-9-]{7,95}$
nextActions	array	Yes	Defines the nextactions value at this contract boundary.	—
operation	enum	Yes	Defines the operation value at this contract boundary.	enum: begin, predict, authorize, resume, effect-record, verification-record, status, verify, explain, abort, capsule-validate, capsule-export
schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "workspai.change-operation-result.v1"
state	string	Yes	Defines the state 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/change-operation-result.v1.json",
  "title": "Workspai Change Operation Result",
  "type": "object",
  "required": [
    "schemaVersion",
    "operation",
    "changeId",
    "state",
    "capsule",
    "artifacts",
    "nextActions"
  ],
  "properties": {
    "schemaVersion": {
      "const": "workspai.change-operation-result.v1"
    },
    "operation": {
      "enum": [
        "begin",
        "predict",
        "authorize",
        "resume",
        "effect-record",
        "verification-record",
        "status",
        "verify",
        "explain",
        "abort",
        "capsule-validate",
        "capsule-export"
      ]
    },
    "changeId": {
      "type": "string",
      "pattern": "^change-[a-z0-9][a-z0-9-]{7,95}$"
    },
    "state": {
      "type": "string",
      "minLength": 1
    },
    "capsule": {
      "$ref": "proof-carrying-change-capsule.v1.json"
    },
    "artifacts": {
      "type": "object",
      "additionalProperties": {
        "type": [
          "string",
          "null"
        ]
      }
    },
    "nextActions": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      }
    }
  },
  "additionalProperties": false
}