Skip to content

docs: close RC1 reference gaps for [targets] and switchyard-server options #295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
eric-liu-nvidia wants to merge 2 commits into
base: main
Choose a base branch
from
+20 −0
Open

docs: close RC1 reference gaps for [targets] and switchyard-server options #295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a8fd6fb
docs(reference): document the required [targets] table for noop configs
eric-liu-nvidia Aug 5, 2026
b65ab36
docs(cli): add missing switchyard-server options to the reference table
eric-liu-nvidia Aug 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/cli_reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,9 @@ When built from the repository, invoke it as
| `--host HOST` | `0.0.0.0` | Address on which the server listens. |
| `-p, --port PORT` | `4000` | Port on which the server listens. |
| `--backlog BACKLOG` | `65535` | TCP listen backlog configured before accepting traffic. |
| `--shutdown-timeout SHUTDOWN_TIMEOUT` | `30s` | Maximum time active requests may drain during shutdown. |
| `--dry-run` | Off | Validate the deployment without binding a socket. |
| `--routing-log-file PATH` | None | Append durable per-request routing records to this JSONL file. |
| `--tls-cert PATH` | None | PEM certificate path; requires `--tls-key`. |
| `--tls-key PATH` | None | PEM private-key path; requires `--tls-cert`. |
| `-h, --help` | — | Print command help. |
Expand Down
18 changes: 18 additions & 0 deletions docs/reference/toml_schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ target = "strong"
`schema_version` must be `1`. Table names under `llm_clients`, `targets`, and
`routes` are local references; clients send the route's `id` as the model name.

`schema_version`, `[targets]`, and `[routes]` must all be present, even when a
route reaches no upstream. A file without a `[targets]` table is rejected with
`missing field targets`; an empty `[targets]` table satisfies it.
`[llm_clients]` defaults to empty and may be omitted.

## `[llm_clients.<name>]`

| Key | Required | Default | Meaning |
Expand Down Expand Up @@ -70,6 +75,19 @@ Every route takes the common keys below, plus the keys for its type.
Returns a buffered assistant response containing `OK` without calling an
upstream model. Use it for local smoke tests.

A noop-only deployment reaches no upstream but still needs the `[targets]`
table, which can be empty:

```toml
schema_version = 1

[targets]

[routes.smoke]
id = "noop-route"
type = "noop"
```

### `passthrough`

Sends every request to one target.
Expand Down
Loading