Liking cljdoc? Tell your friends :D

com.blockether.vis.internal.config-spec

The executable contract for the YAML representation of Vis configuration.

YAMLStar returns maps with string keys. This namespace validates that exact representation: snake_case string keys ONLY (kebab-case is rejected), no recursive keywordization, and no acceptance of keyword-keyed lookalikes. Maps are closed unless their keys are deliberately user-defined (environment variables, headers, toggle ids, MCP server names, pricing/model tables, and provider request bodies).

Security consumers derive their internal policy maps through the adapters at the end of this namespace, so validation and enforcement share one contract.

The executable contract for the YAML representation of Vis configuration.

YAMLStar returns maps with string keys. This namespace validates that exact
representation: snake_case string keys ONLY (kebab-case is rejected), no
recursive keywordization, and no acceptance of keyword-keyed lookalikes.
Maps are closed unless their keys are
deliberately user-defined (environment variables, headers, toggle ids, MCP
server names, pricing/model tables, and provider request bodies).

Security consumers derive their internal policy maps through the adapters at
the end of this namespace, so validation and enforcement share one contract.
raw docstring

assert-config!clj

(assert-config! config)
(assert-config! config source)

Return a string-keyed YAML config when it satisfies the complete contract.

Return a string-keyed YAML config when it satisfies the complete contract.
sourceraw docstring

assert-process-jail-config!clj

(assert-process-jail-config! policy)

Validate and return the exact internal policy consumed by process-jail.

Validate and return the exact internal policy consumed by process-jail.
sourceraw docstring

budget-keysclj

source

budget-schemaclj

source

config-keysclj

source

config-schemaclj

source

db-keysclj

source

db-schemaclj

source

explain-dataclj

(explain-data config)
source

explain-problemsclj

(explain-problems config)

Best-effort, model-readable reasons a string-keyed YAML config fails the contract — one line per offending TOP-LEVEL key: a non-string key, an unknown key (config is closed), or a value the section schema rejects. Returns [] for a valid or nil map, so a caller surfaces a config_error hint ONLY when the live config is actually denied. This points a fix straight at the key rather than dumping the whole opaque spec problem.

Best-effort, model-readable reasons a string-keyed YAML `config` fails the
contract — one line per offending TOP-LEVEL key: a non-string key, an unknown
key (config is closed), or a value the section schema rejects. Returns [] for
a valid or nil map, so a caller surfaces a `config_error` hint ONLY when the
live config is actually denied. This points a fix straight at the key rather
than dumping the whole opaque spec problem.
sourceraw docstring

jail-filesystem-keysclj

source

jail-filesystem-schemaclj

source

jail-keysclj

source

jail-schemaclj

source

mcp-auth-schemaclj

source

mcp-keysclj

source

mcp-schemaclj

source

mcp-server-keysclj

source

mcp-server-schemaclj

source

message-queue-keysclj

source

message-queue-schemaclj

source

model-keysclj

source

model-schemaclj

source

network-configclj

(network-config config)

Derive the keyword-keyed internal egress policy from validated YAML config. Egress filtering is one facet of the process jail: jail.enabled is the single gate. When the jail is off the policy is empty (egress open); when on, the jail.network block (allowed/denied/exclude domains, allow_private, rules) is enforced alongside the filesystem and inbound-port confinement.

Derive the keyword-keyed internal egress policy from validated YAML config.
Egress filtering is one facet of the process jail: `jail.enabled` is the single
gate. When the jail is off the policy is empty (egress open); when on, the
`jail.network` block (allowed/denied/exclude domains, `allow_private`, rules)
is enforced alongside the filesystem and inbound-port confinement.
sourceraw docstring

network-keysclj

source

network-rule-allow-keysclj

source

network-rule-allow-schemaclj

source

network-rule-keysclj

source

network-rule-schemaclj

source

network-schemaclj

source

process-jail-configclj

(process-jail-config config)

Derive the internal process-jail policy from validated string-keyed config. The workspace.filesystem catalog is the single source of roots. When the jail is DISABLED (the default) nothing is confined, so every catalog root is available and the allow list is ignored. When ENABLED, jail.filesystem.allow selects which catalog ids enter the OS jail (deny-by-omission). Each admitted entry's access sets RW vs read-only and search: false marks it out of the default search sweep.

Derive the internal process-jail policy from validated string-keyed config.
The `workspace.filesystem` catalog is the single source of roots. When the
jail is DISABLED (the default) nothing is confined, so every catalog root is
available and the `allow` list is ignored. When ENABLED,
`jail.filesystem.allow` selects which catalog ids enter the OS jail
(deny-by-omission). Each admitted entry's `access` sets RW vs read-only and
`search: false` marks it out of the default search sweep.
sourceraw docstring

process-jail-config-keysclj

source

prompt-keysclj

source

prompt-schemaclj

source

provider-keysclj

source

provider-schemaclj

source

python-keysclj

source

python-schemaclj

source

rate-limit-keysclj

source

rate-limit-schemaclj

source

router-keysclj

source

router-network-keysclj

source

router-network-schemaclj

source

router-schemaclj

source

search-keysclj

source

search-schemaclj

source

token-keysclj

source

token-schemaclj

source

tui-keysclj

source

tui-schemaclj

source

valid?clj

(valid? config)
source

workspace-access-valuesclj

source

workspace-entry-keysclj

source

workspace-entry-schemaclj

source

workspace-keysclj

source

workspace-schemaclj

source

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close