Configuration Schema Reference

This is the schema shipped by the current documentation release. Use the Dashboard reference when you need the contract reported by a running Router.

Release contractv0.3

Contractvllm-sr/config-schema/v1

View canonical JSON ↗

Filter contract

Selected contract

Global

global

ShapeobjectThis object accepts the fields below.

Fields

5

routerobject

servicesobject

storesobject

integrationsobject

model_catalogobject

Progressive discovery

The Router API and CLI expose the same contract without requiring clients or agents to load the full schema first:

vllm-sr config schema
vllm-sr config schema --section providers.models
vllm-sr config schema --section routing.decisions.modelRefs
vllm-sr config schema --section routing --expanded
vllm-sr config schema --surface algorithm:multi_factor
vllm-sr config schema --full

Against a running Router, GET /api/v1/config/schema returns the compact index. Use view=section&path=... for a compact field directory or view=surface&kind=...&name=... for one registered routing surface. Add expanded=true to a section request only when a self-contained JSON Schema is required; use view=full for the complete schema.

Ask for the narrowest section that answers the current edit. The default field directory links to its child paths, so agents do not need to load every nested algorithm, plugin, signal, and projection. For a new file, use vllm-sr config init; the template shows the required provider, Model Card, and decision-reference relationship without loading the full schema.

Section views preserve their real shape: list sections such as listeners, entrypoints, and recipes expose their item fields, while version is shown as the fixed scalar value. Bootstrap-only Dashboard state such as setup.mode is deliberately outside this steady-state Router contract.

For API discovery beyond configuration, use the generated Router OpenAPI Reference. Agents query both contracts directly from the Router; the Website and Dashboard only visualize them.