Expand description
What a workflow offers to do: operations, their arguments, and examples of each.
An OperationSpec is built once per view with a builder, so a field added later
breaks nobody’s code. Its arguments come from a typed arguments struct, and each can
be given labels, a source and a shape. Examples show a message and the arguments it
carries, or the arguments it leaves out; OperationSpec::validate checks every
example against the arguments type when the registry is built, so an example cannot
go stale unnoticed.
Structs§
- Argument
Label - A word people use for an argument, optionally only in one language.
- Argument
Spec - One argument of an operation.
- Date
Error - Why a date expression names no date.
- Glossary
Term - A word a workflow’s users say, and what it means there.
- Money
- An amount of money in minor units:
1050euro cents is 10.50 EUR. - Money
Error - Why a decimal string is not an amount of money.
- Operation
Catalog - The operations offered to a turn, by key. A duplicate key is refused, never shadowed.
- Operation
Example - A message and what it means for one operation, shown to the model as an example.
- Operation
Spec - One operation a workflow offers in a view.
- Operation
Spec Error - Why an operation’s declaration cannot be used.
Enums§
- Argument
Source - Where an argument’s value comes from.
- Date
Direction - Which way a date without a year points.
- Date
Expr - A date as the user said it, for code to evaluate.
- Date
Period - A calendar period.
- Date
Unit - A unit of
DateExpr::Relative. - DayOf
Week - A day of the week.
- Period
Occurrence - Which period.
- Value
Shape - The shape a model gives an argument’s value, derived from its JSON Schema.
- Weekday
Occurrence - Which occurrence of a weekday.
Functions§
- shape_
of - Derives the shape of one property of an arguments schema.