Expand description
A bounded, versioned snapshot of an application’s metadata: the framework version, compiled features, database aliases with their backend kinds, registered models, documented routes and the OpenAPI document.
The snapshot is built from compiled metadata only (no connection is
opened) and is safe to hand to tools: database URLs are never included
(only alias names and backend kinds), every string of the OpenAPI
document and the app description is redacted, and no row data exists
to leak. Each section says whether it is complete; anything left out
to respect Limits is reported, never silently dropped.
Structs§
- AppInfo
- The app’s OpenAPI metadata.
- Completeness
- Completeness of each section.
- Database
Info - A configured database alias. The URL is never included.
- Framework
- The framework that produced the snapshot.
- Limits
- Size bounds of a snapshot.
- Section
- Whether a section holds everything, and why not.
- Snapshot
- The snapshot (the
dataof asnapshotenvelope).
Constants§
- FORMAT
- The
formatof a snapshot. - FORMAT_
VERSION - Bumped only for breaking changes of the snapshot shape.
Functions§
- snapshot
- Build the snapshot of
app, its registeredmodelsandsettingswithinlimits.