Workspace specification

Workspace specification

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 workspace specification is the authoring format for navigation, pages, sections, forms, tables, and actions.

• Schema ID: https://schemas.efp.dev/mettada/workspace.schema.json
• Source: packages/backend-laravel/src/DSL/schemas/workspace.schema.json
• Root required properties: workspace

Properties

Path	Type	Required	Default	Description and constraints
version	integer	No	1	min: 1
workspace	object	Yes	—	—
workspace.id	string	Yes	—	Stable workspace identifier.
workspace.title	string	Yes	—	Workspace display title.
workspace.description	string	null	No	—
workspace.module	string	No	—	—
workspace.navigation	object	No	—	—
workspace.navigation.route	string	No	—	Absolute application route. pattern: ^/
workspace.navigation.label	string	No	—	—
workspace.navigation.icon	string	null	No	—
workspace.navigation.group	string	null	No	—
workspace.navigation.order	number	null	No	—
workspace.navigation.visible	boolean	No	true	—
workspace.permissions	object	No	—	—
workspace.layout	object	No	—	—
workspace.layout.type	string	No	—	Layout presentation strategy.
workspace.layout.default_section	string	No	—	—
workspace.layout.responsive	boolean	No	—	—
workspace.layout.sidebar	object	No	—	—
workspace.layout.sidebar.enabled	boolean	No	—	—
workspace.layout.sidebar.collapsible	boolean	No	—	—
workspace.toolbar	object	No	—	—
workspace.toolbar.actions	array	No	—	—
workspace.toolbar.search	object	No	—	—
workspace.toolbar.search.enabled	boolean	No	—	—
workspace.sections	array	No	—	—
workspace.pages	array	No	—	—