Skip to content

Settings registry (S15)

/settings is a shell: its navigation is generated from a registry, filtered by what the user's role may open. Every ticket that manages something in Settings adds its own page without touching SettingsLayout.

Contract

web/src/features/settings/registry.ts:

registerSettingsPage({
  id: "webhooks",                 // unique
  titleKey: "webhooks.nav",       // i18n key (es and en)
  path: "webhooks",               // /settings/webhooks
  permission: "webhook:manage",   // API permission, or "admin" (Owner or Admin); omit: everyone
  component: WebhooksPage,
  enterprise: false,              // «Enterprise» label
  order: 50,                      // position in the navigation
});
  1. Write the page and a register.ts that calls registerSettingsPage(...).
  2. Add one line importing it to web/src/features/settings/pages.ts.
  3. Pages of the commercial edition register from web/src/ee/index.ts (registerEePages), which only the ee build loads.

A page the user's role may not open is hidden from the navigation, and its URL shows «not available»; the API still answers 403, which is the real control.

Pages

Page Path Permission Ticket
Members and roles members member:manage T49
API keys api-keys apikey:manage T49
SSO and SCIM (ee) sso org:manage T49
Models and providers (policies, BYOK, effective policy per node) models project:manage T49
Model catalog model-catalog project:read T49
Retention and deletion retention admin T50
Audit audit audit:read T50

T27 (webhooks), T31 (connectors) and T51 (usage and billing) add theirs the same way. The registry is tested in web/src/features/settings/organization.test.tsx and the T57 example page (web/src/ee/index.ts) shows the contract from the commercial edition.