Openapi

OpenAPI Configuration

Root OpenAPI settings (extensible for future OpenAPI features)

This configuration provides defaults for OpenAPI documentation endpoints across all channels (REST, Observe). Channel-specific UI configs inherit from openapi.ui.

openapi.enabled

Master switch for OpenAPI doc endpoints When false, disables all OpenAPI spec endpoints (JSON/YAML/UI) across all channels. Note: This does NOT disable the actual REST API endpoints (e.g., /api/entries/*), only the documentation endpoints.

Priority: SCRIBE_OPENAPI_ENABLED > config

Property	Value
Default	`true`
Override	`SCRIBE_OPENAPI_ENABLED` (optional)

openapi.enabled = true
openapi.enabled = ${?SCRIBE_OPENAPI_ENABLED}

openapi.ui

Scalar UI defaults (inherited by channels.rest.ui and monitoring.observe.ui) Scalar provides a modern, interactive API documentation UI. By default, assets are bundled with the app (offline-safe, no external network). Settings marked AUTO resolve based on app.mode:

Dev/test/local: developer-friendly (show tools, enable requests)
Production/staging: production-safe (hide tools, disable requests)

openapi.ui.asset

External asset configuration (CDN override). By default, Scalar assets are bundled with the app. If configured, both url and sri are required. SRI (Subresource Integrity) hash prevents supply-chain attacks.

openapi.ui.asset.sri

Subresource Integrity hash for the asset URL.

Example: "sha384-..."

Property	Value
Default	`null`

openapi.ui.asset.sri = null

openapi.ui.asset.url

CDN URL for Scalar standalone JavaScript bundle.

Example: "https://cdn.jsdelivr.net/npm/@scalar/api-reference@1.43.1/dist/browser/standalone.min.js"

Property	Value
Default	`null`

openapi.ui.asset.url = null

openapi.ui.dark-mode

Enable dark mode by default

Property	Value
Default	`false`

openapi.ui.dark-mode = false

openapi.ui.enabled

Enable OpenAPI UI (Scalar API Reference)

auto = enabled in dev/test, disabled in prod (prod-safe default)

true = always enabled, false = always disabled

Priority: SCRIBE_OPENAPI_UI_ENABLED > config

Property	Value
Default	`"auto"`
Override	`SCRIBE_OPENAPI_UI_ENABLED` (optional)

openapi.ui.enabled = "auto"
openapi.ui.enabled = ${?SCRIBE_OPENAPI_UI_ENABLED}

openapi.ui.force-dark-mode-state

Force dark mode state Options: “dark”, “light”, null (auto-detect from system preference)

Property	Value
Default	`null`

openapi.ui.force-dark-mode-state = null

openapi.ui.hide-dark-mode-toggle

Hide the dark mode toggle

Property	Value
Default	`false`

openapi.ui.hide-dark-mode-toggle = false

openapi.ui.hide-test-request-button

Hide test request button

auto = hide in prod, show in dev

true = always hide, false = always show

Property	Value
Default	`"auto"`

openapi.ui.hide-test-request-button = "auto"

openapi.ui.layout

Layout mode

Options: “modern”, “classic”

Property	Value
Default	`"modern"`

openapi.ui.layout = "modern"

openapi.ui.search-hot-key

Search hotkey (keyboard shortcut)

Default: “k”

Property	Value
Default	`"k"`

openapi.ui.search-hot-key = "k"

openapi.ui.show-developer-tools

Show developer tools

auto = show in dev, hide in prod

true = always show, false = never show

Property	Value
Default	`"auto"`

openapi.ui.show-developer-tools = "auto"

Show sidebar navigation

Property	Value
Default	`true`

openapi.ui.show-sidebar = true

openapi.ui.theme

Scalar theme (appearance)

Options: “alternate”, “default”, “moon”, “purple”, “solarized”, “bluePlanet”, “saturn”, “kepler”, “mars”, “deepSpace”, “laserwave”, “none”

Property	Value
Default	`"default"`

openapi.ui.theme = "default"