Platform contracts / JSON Schema

Workspai Adopt Effects v1

Defines the versioned adopt effects v1 boundary used by Workspai and its consumers.

Schema version: workspai.adopt-effects.v1
Contract path: contracts/adopt-effects.v1.json
Publication: json-schema
Defined fields: 9
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
• Contract-aware integrations

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
projectMetadataFiles	array	Yes	Defines the projectmetadatafiles value at this contract boundary.	—
repositoryControlFiles	array	Yes	Defines the repositorycontrolfiles value at this contract boundary.	—
repositoryControlFiles[].action	string	Yes	Defines the action value at this contract boundary.	const: "reconcile"
repositoryControlFiles[].condition	string	Yes	Defines the condition value at this contract boundary.	minLength: 1
repositoryControlFiles[].path	string	Yes	Defines the path value at this contract boundary.	minLength: 1
schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "workspai.adopt-effects.v1"
sourceCodeModified	boolean	Yes	Defines the sourcecodemodified value at this contract boundary.	const: false
sourceMode	string	Yes	Defines the sourcemode value at this contract boundary.	const: "linked"
workspaceOperations	array	Yes	Defines the workspaceoperations 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/contracts/adopt-effects.v1.json",
  "title": "Workspai Adopt Effects v1",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "schemaVersion",
    "sourceMode",
    "sourceCodeModified",
    "projectMetadataFiles",
    "repositoryControlFiles",
    "workspaceOperations"
  ],
  "properties": {
    "schemaVersion": {
      "const": "workspai.adopt-effects.v1"
    },
    "sourceMode": {
      "const": "linked"
    },
    "sourceCodeModified": {
      "const": false
    },
    "projectMetadataFiles": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "uniqueItems": true
    },
    "repositoryControlFiles": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "path",
          "action",
          "condition"
        ],
        "properties": {
          "path": {
            "type": "string",
            "minLength": 1
          },
          "action": {
            "const": "reconcile"
          },
          "condition": {
            "type": "string",
            "minLength": 1
          }
        }
      }
    },
    "workspaceOperations": {
      "type": "array",
      "items": {
        "enum": [
          "register-project",
          "sync-contract",
          "rebuild-model",
          "rebuild-graph",
          "sync-agent-grounding"
        ]
      },
      "uniqueItems": true
    }
  }
}