Documentation
¶
Overview ¶
Package openapigen derives an OpenAPI 3.1 document for one realm from the generic contract (api/openapi.yaml) and the realm's loaded config: its collections with their schemas and features, its enabled authentication methods, its functions, and what its clients can reach.
Index ¶
Constants ¶
View Source
const Version = "1"
Version is the generator's version: it changes when the output format does.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Document ¶
type Document struct {
JSON []byte
Fingerprint string // of the document: what --check and caches compare
}
Document is a generated OpenAPI document.
func Admin ¶
Admin generates the document of the realm's admin API: its administration routes, the data routes past the collections' rules (typed per collection), and every function the administrators may run by hand, internal ones included, with their input and output schemas.
Source Files
Click to show internal directories.
Click to hide internal directories.