Platform contracts / JSON Schema

Workspai Ingestion Result v1

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

Schema version: workspai.ingestion-result.v1
Contract path: contracts/ingestion-result.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
plan	reference	Yes	Defines the plan value at this contract boundary.	ref: https://workspai.dev/contracts/ingestion-plan.v1.json
projectPath	string	No	Defines the projectpath value at this contract boundary.	minLength: 1
registered	boolean	Yes	Defines the registered value at this contract boundary.	—
schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "workspai.ingestion-result.v1"
status	enum	Yes	Defines the status value at this contract boundary.	enum: passed, preview, failed
verified	boolean	Yes	Defines the verified value at this contract boundary.	—
warnings	array	Yes	Defines the warnings value at this contract boundary.	—
workspacePath	string	No	Defines the workspacepath value at this contract boundary.	minLength: 1
writtenFiles	array	Yes	Defines the writtenfiles 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/ingestion-result.v1.json",
  "title": "Workspai Ingestion Result v1",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "schemaVersion",
    "status",
    "plan",
    "writtenFiles",
    "registered",
    "verified",
    "warnings"
  ],
  "properties": {
    "schemaVersion": {
      "const": "workspai.ingestion-result.v1"
    },
    "status": {
      "enum": [
        "passed",
        "preview",
        "failed"
      ]
    },
    "plan": {
      "$ref": "https://workspai.dev/contracts/ingestion-plan.v1.json"
    },
    "workspacePath": {
      "type": "string",
      "minLength": 1
    },
    "projectPath": {
      "type": "string",
      "minLength": 1
    },
    "writtenFiles": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "uniqueItems": true
    },
    "registered": {
      "type": "boolean"
    },
    "verified": {
      "type": "boolean"
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}