Skip to content

Read site-text overrides

GET
/site-text

Returns the saved UI-text overrides for every language.

No sign-in is needed, even when public mode is off. The response is an overrides map keyed by language, then by i18n key. With no overrides it’s {"overrides":{}}, and languages without rows are left out. Every saved override is returned, including wording for signed-in and admin screens. There’s no language filter or pagination.

The web client loads this map at startup and keeps a local copy. For the active locale it tries the override, then the bundled translation, then the English override, then bundled English, and finally the key itself. An empty override deliberately gives an empty label. {name} placeholders are filled in only when the caller supplies a matching value; otherwise they stay visible. Overrides are treated as text, not HTML.

The server caches the whole map. Writes clear this app instance’s copy and try to notify other instances, but a missed notification or an older read that finishes late can leave stale values. Open browsers keep their own copies until they refresh. If the database read fails on a cache miss, you get an error, not an empty map.

The complete language-to-key override map; overrides is an empty object when no rows exist.

Saved UI-text replacements for all languages, in an overrides map. The bundled catalogue isn’t included.

object
overrides
required

Language → dotted key → replacement text. Empty when there are no rows, and a language with no saved rows is left out. The map isn’t filtered by caller or language.

object
key
additional properties
object
key
additional properties
string
Example
{
"en": {
"nav.collections": "Libraries"
}
}