Override one shipped string for one language

PUT

/site-text/{key}

• Local development behind nginx (port 8088 by default)

Upserts the override for (key, language).

THE KEY MUST EXIST IN THE SHIPPED CATALOGUE. A key the frontend never renders is refused with 422 naming the key, rather than stored to no effect — ADR 0081 §1’s fail-loud rule. The check is enforced here, not only in the admin UI, because a caller holding system.config.write can reach this endpoint directly.

Requires system.config.write: rewriting the site’s wording is the same kind of act as renaming the site (#718).

Authorizations

• cookieAuth
• bearerAuth

Parameters

Path Parameters

key

required

string

The dotted i18n key, e.g. nav.collections.

Request Body ^required

PUT body for /site-text/{key}. The key rides the path.

object

language

required

string

>= 1 characters

Example

en

value

required

Replacement string. May be empty — an operator blanking a label is a legitimate edit, and is distinct from reverting (DELETE), which restores the shipped text.

string

Example

Libraries

Responses

200

The stored override

object

key

required

The dotted i18n key this override replaces.

string

Example

nav.collections

language

required

Locale code the override applies to.

string

Example

en

value

required

The replacement string. Plain text — it flows through the client’s {var} interpolation and is never rendered as HTML.

string

Example

Libraries

updated_at

string format: date-time

400

Malformed request

object

error

required

Human-readable error summary

string

Example

the request could not be completed

401

Authentication required, missing, or invalid

object

error

required

Human-readable error summary

string

Example

the request could not be completed

Example

{
  "error": "authentication required: sign in and retry with a valid session or API token"
}

403

Authenticated but missing required capabilities

object

error

required

Human-readable error summary

string

Example

the request could not be completed

422

Request shape is valid but the action doesn’t apply (e.g. subtitles on a non-video/audio asset).

object

error

required

Human-readable error summary

string

Example

the request could not be completed