Spec

Spec models a type specification and the metadata slots.

Spec qname as ref identifier

Simple name of spec

Qualified name of spec formatted as lib::Type[.slot]

Spec reference - always sys::Lib

Parent library

Parent spec for member specs

Base type of inheritance or null for sys::Obj

Value type

Map of children slot and global members

Map of children slot members

Map of children global members

Abstract types cannot be implemented directly by instance data

Indicates an asynchronous operation or function call

Indicates an immutable value

Documentation formatted as xetodoc

Indicates a global slot that defines a shape for all types that might override

Annotates a slot as a fixed value that must be equal to val.

Inverse query to run against parent

String key; used in enums to define normalized string identifier

Applied to strings and lists to specify inclusive maximum length

Inclusive maximum value for numbers

Indicates an optional type

Applied to strings and lists to specify inclusive minimum length

Inclusive minimum value for numbers

Indicates a mixin that adds meta/slots to an existing type

Applied to Choices to allow multiple selections

Indicates a constructor function

Marks spec as undocumented and not officially supported

Do not include source code in documentation

Marks a function or operation as having no side effects. The function may or may not be pure in that calling it multiple times with the same arguments always evaluates to the same result. HTTP operations with this tag may be called with a GET, otherwise a POST is required.

Indicates a meta tag that is not inherited into subtypes

Applied to strings to require value is non-empty when trimmed of whitespace

Item type for parameterized Collection/Query; target type for Ref/MultiRef

Types used in compound types like And and Or

Marks a function as an operation published to the generated OpenAPI schema. All functions are callable over HTTP; this marks the ones which are part of the documented API surface.

Marks an op whose request grid is passed whole as its single parameter when the request arrives as a grid, rather than mapping the first row's cells to arguments by name. Used by batch and tabular ops which carry semantics in grid meta and multiple rows.

Regex pattern for scalar string encoding

Restrict number or unit enum to specific quantity

Indicates a readonly value that may not be written (but may mutate)

Sealed types cannot be extended outside of their own lib. If used on a interface slot, the slot cannot be overridden in a subtype.

Marks a function as having side effects that modify observable state or invoke external actions (writes, commits, notifications, etc). Agent harnesses use this marker to require confirmation before evaluation, or to raise an error in plan mode. This marker is the dual of noSideEffects; unmarked functions are assumed to be safe.

Indicates a spec level slot versus an instance level slot

Sugar marks a spec as a convenience name for its nominal anchor type plus a set of structural tag constraints - see docs.

Mark data as summary level for display in summarized tables and other views

Indicates data which should not be persisted

Restrict number or unit enum to specific unit

Restrict a number to have no unit

Default value for this slot

Marks a func as the check for a ValidateRule. The func is called as 'func(spec, val)' where val is the value at the position the rule fired on: the instance itself for a rule registered on a dict type, or the slot value for one registered on a value type.

Return null or an empty list when the value is ok. Otherwise return a dict per problem, or a list of them. An empty dict reports the rule at its own position; a 'slot' tag reports it against that tag of the dict instead, and any other tags are msg template args.

// ok, or flag the min tag of the instance if (val->min > val->max) {slot:"min"}

Named path to traverse to execute query

Used on a interface non-static slot to indicate it can be overridden subtypes