Schema model

The API reference describes the contract one endpoint at a time. This is the same contract seen from the other side: every component schema it defines, and how they refer to one another.

The model is drawn as a UML class diagram and kept in step with contract/openapi.yaml — a schema renamed or added in the contract is renamed or added here in the same change, which is why it is worth reading next to the reference rather than instead of it.

The model

Loading the schema model…

Reading it:

• The lanes group the schemas by what they serve. core is the admin schema itself — resources, views, fields, filters, actions and the menu. preferences, search, results, uploads and aggregations & dashboard are the areas built on top of it.
• Boxes marked «enumeration» are the closed value sets of the contract: ViewType, FieldType, FieldFormatType, ActionType, RequestMethodType, ColorType. A backend that sends a value outside one of these is sending something the frontend has no component for.
• The arrows are the references between schemas, labelled with the property that holds them.

Where it fits

The schema endpoints return instances of these schemas — see How it works for which endpoint returns which level of detail, and the API reference for the exact fields of each one.

The diagram belongs to the contract, so it is versioned with it: what you see here is the model of the contract this documentation is showing. Which contract a library release speaks is named in the bar above every library page.