OpenAPI Rune Designer
Runes should be first-class in the OpenAPI Design Center, not hidden YAML that only experts know how to write.
Current Gap
The contract exists:
- schema authors can add
x-gridheim-rune - ThorAPI can emit
@Rune - ValkyrAI can evaluate annotated fields
But the UX is underdeveloped:
- users must remember vendor extension names
- formula fields are not guided by the visual designer
- collection projections such as
paymentTransactions.creditsneed validation - SecureField metadata follows a similar hidden-extension pattern
Design Goals
The designer should let users:
- create a calculated field from the visual schema editor
- edit a Rune formula with syntax support
- validate referenced fields and collections
- preview generated OpenAPI vendor extensions
- see whether a property is calculated, persisted, encrypted, or both
- configure SecureField metadata through guided controls
Recommended Controls
| Control | Purpose |
|---|---|
| Calculated field toggle | Enables x-gridheim-rune on a schema property |
| Formula editor | Edits spreadsheet-style formulas |
| Field picker | Inserts valid schema fields and collection projections |
| Validation panel | Shows missing fields, unsupported formulas, or type mismatches |
| Generated YAML preview | Shows the exact OpenAPI extension output |
| SecureField controls | Adds encryption metadata without manual YAML edits |
Delivery Principle
The visual designer should never obscure the source of truth. Users should see the friendly controls and the generated OpenAPI contract they produce.
Related: