Workspace contract v1
Workspace contract v1
Section titled “Workspace contract v1”This page is generated from the canonical JSON Schema. Edit the schema and run
npm run docs:generate; do not edit the generated tables directly.
The generated UI contract is a versioned boundary between backend generation and frontend consumption.
- Schema ID:
https://efp.dev/contracts/workspace.v1.schema.json - Source:
packages/contracts/schemas/workspace.v1.schema.json - Root required properties:
id,title
Properties
Section titled “Properties”| Path | Type | Required | Default | Description and constraints |
|---|---|---|---|---|
version |
string | integer | No | — |
id |
string | Yes | — | pattern: ^[a-z0-9_\-]+$ |
title |
string | Yes | — | — |
description |
string | null | No | — |
navigation |
object | No | — | — |
navigation.route |
string | No | — | URL of this workspace. Defaults to /workspaces/{id} when omitted. pattern: ^/ |
navigation.label |
string | No | — | — |
navigation.icon |
string | null | No | — |
navigation.group |
string | null | No | — |
navigation.order |
number | null | No | — |
navigation.visible |
boolean | No | — | — |
permissions |
object | No | — | — |
layout |
object | No | — | — |
toolbar |
object | No | — | — |
pages |
array | No | — | — |
sections |
array | No | — | — |