Workspace operations / JSON Schema

Workspace Share Bundle V1

Defines the versioned workspace share bundle v1 boundary used by Workspai and its consumers.

Schema version: https://getrapidkit.com/schemas/workspace-share-bundle.v1.json
Contract path: contracts/workspace-share-bundle.v1.json
Publication: synced-supporting-contract
Defined fields: 7
Artifact bindings: 1

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.

workspai workspace share

Produced artifacts

These durable files are emitted by registered commands and validated against this contract.

Artifact path	Schema	Producer
.workspai/reports/share-bundle.json	1.1	workspai workspace share

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
generated_at	string	Yes	Defines the generated at value at this contract boundary.	format: date-time
generated_by	string	Yes	Defines the generated by value at this contract boundary.	const: "workspai"
projects	array	Yes	Defines the projects value at this contract boundary.	—
reports	object	Yes	Defines the reports value at this contract boundary.	—
schema_version	string	Yes	Defines the schema version value at this contract boundary.	const: "1.1"
summary	object	Yes	Defines the summary value at this contract boundary.	—
workspace	object	Yes	Defines the workspace 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://getrapidkit.com/schemas/workspace-share-bundle.v1.json",
  "type": "object",
  "required": [
    "schema_version",
    "generated_at",
    "generated_by",
    "workspace",
    "summary",
    "reports",
    "projects"
  ],
  "properties": {
    "schema_version": {
      "const": "1.1"
    },
    "generated_at": {
      "type": "string",
      "format": "date-time"
    },
    "generated_by": {
      "const": "workspai"
    },
    "workspace": {
      "type": "object"
    },
    "summary": {
      "type": "object"
    },
    "reports": {
      "type": "object"
    },
    "projects": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  },
  "additionalProperties": true
}