Developer reference
Liberty Next → Document → Developer reference describes the running installation from the inside: its tables, its settings and its API routes, read from the code and the configuration in force. It is for the people who support the install — superusers only — and changes nothing.
The page has three tabs; it opens on Configuration and then on the last tab used.
At a glance
Data model
The tables of the framework, then the tables each connector declares, grouped by connector, each with its number of columns. A search finds a table, a column or a label.
A table shows its physical table, its key, the queries that read it and what uses it — screens, dashboards, charts, jobs, Explorer models —, its related tables, then its columns: Column, Label (from the dictionary), Type, References, Screens, Description.
Configuration
Every setting of the install, by section, with its type, its default and its description.
| Column | Meaning |
|---|---|
| Key, Label, Type, Default | The setting. |
| Edited in | The page that edits it — Administer → App → Sign-in —, or File / environment only with the reason, or Not in the UI. |
| Read by | The places in the code that use it. |
The header counts the settings edited in a screen, those set in the file or the environment only, and those missing from the interface; the status filter keeps one kind. A click on a row opens its detail, with the code that reads it.
API
Every route of the server, by module: Method, Path, Summary, Module and Access — public, any signed-in user, superuser, a permission or a role, read from the code. A click on a route opens its parameters, its request and its response, and the place of its handler. The buttons in the header open the interactive API documentation of the server.
The search runs across every module and shows, per group, the number of matches.
Related
- Documentation reports — the same knowledge as a PDF document.
- REST API — the main routes, explained.