Platform contracts / JSON Schema

Workspai Ingestion Plan v1

Defines the versioned ingestion plan v1 boundary used by Workspai and its consumers.

Schema version: workspai.ingestion-plan.v1
Contract path: contracts/ingestion-plan.v1.json
Publication: json-schema
Defined fields: 11
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
action	enum	Yes	Defines the action value at this contract boundary.	enum: adopt-project, import-project, connect-workspace, import-workspace, hydrate-workspace
destination	string	No	Defines the destination value at this contract boundary.	minLength: 1
mode	enum	Yes	Defines the mode value at this contract boundary.	enum: link, copy, clone, hydrate
ownership	enum	Yes	Defines the ownership value at this contract boundary.	enum: external, workspace-owned, materialized
projectGrounding	enum	No	Defines the projectgrounding value at this contract boundary.	enum: managed, local, off
registration	enum	Yes	Defines the registration value at this contract boundary.	enum: project, workspace, none
resourceKind	enum	Yes	Defines the resourcekind value at this contract boundary.	enum: project, workspace
schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "workspai.ingestion-plan.v1"
source	string	Yes	Defines the source value at this contract boundary.	minLength: 1
sourceKind	enum	Yes	Defines the sourcekind value at this contract boundary.	enum: local-folder, git-url, archive
targetWorkspace	string	No	Defines the targetworkspace 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/contracts/ingestion-plan.v1.json",
  "title": "Workspai Ingestion Plan v1",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "schemaVersion",
    "action",
    "resourceKind",
    "sourceKind",
    "mode",
    "ownership",
    "registration",
    "source"
  ],
  "properties": {
    "schemaVersion": {
      "const": "workspai.ingestion-plan.v1"
    },
    "action": {
      "enum": [
        "adopt-project",
        "import-project",
        "connect-workspace",
        "import-workspace",
        "hydrate-workspace"
      ]
    },
    "resourceKind": {
      "enum": [
        "project",
        "workspace"
      ]
    },
    "sourceKind": {
      "enum": [
        "local-folder",
        "git-url",
        "archive"
      ]
    },
    "mode": {
      "enum": [
        "link",
        "copy",
        "clone",
        "hydrate"
      ]
    },
    "ownership": {
      "enum": [
        "external",
        "workspace-owned",
        "materialized"
      ]
    },
    "registration": {
      "enum": [
        "project",
        "workspace",
        "none"
      ]
    },
    "source": {
      "type": "string",
      "minLength": 1
    },
    "targetWorkspace": {
      "type": "string",
      "minLength": 1
    },
    "destination": {
      "type": "string",
      "minLength": 1
    },
    "projectGrounding": {
      "enum": [
        "managed",
        "local",
        "off"
      ]
    }
  }
}