Schema DSL

Overview

The schema DSL describes ObjectTypes, LinkTypes, properties, enumerations, and actions in version-controlled TypeScript. Compile the schema before deployment so contract errors are caught locally.

Main concepts

Concept	Purpose
ObjectType	Business object and its typed properties
LinkType	Typed relationship between ObjectTypes
Enum	Closed set of accepted values
Action	Governed operation with inputs, preconditions, risk, and execution mode

Primitive property types include string, number, boolean, date, datetime, arrays, and references. Modifiers define required, indexed, unique, default, and semantic behavior.

Safe workflow

1. Define the schema in TypeScript.
2. Compile it into a manifest.
3. Review the generated differences.
4. Deploy to the selected workspace.
5. Regenerate client types.

See Plans and actions and Error codes.