Expand description
check: validate the app, its models and its configuration without
starting a server or opening a database.
check returns every CheckIssue it finds. The checks, by id prefix:
| Prefix | Checks |
|---|---|
config | a default database exists when models are managed; database URLs parse and name a known scheme |
models | duplicate tables, models and columns; a primary key; foreign-key and many-to-many targets are registered models |
migrations | migration files load; the dependency graph is sound; model changes not yet in a migration |
openapi | the OpenAPI document generates (duplicate operations and ids) |
backend | the models fit the capabilities of the default database’s backend |
Issue messages never contain database URLs.
Structs§
- Check
Issue - One problem found by
check.
Enums§
- Check
Level - How serious a
CheckIssueis.
Functions§
- check
- Run every check.
- check_
build - Check that
appcan be turned into a router, which catches duplicate routes and malformed path templates that the OpenAPI check does not see (for example hidden endpoints). Consumes the app: call it on a fresh one. - has_
errors - Whether any of
issuesis an error.