Expand description
The Sill adapter format.
An adapter answers two questions about one upstream: where does the credential live in a request, and what must never come back out in a response. Everything else about the request — path, method, body — is passed through untouched.
The format is published and contributable, which is why it lives in the MIT tree. The CLI validates adapters and the relay executes them from this same crate, so the two cannot drift in their reading of a file.
schema_version = 1
[adapter.railway]
upstream = "backboard.railway.com"
[[adapter.railway.auth]]
location = "header"
name = "authorization"
scheme = "Bearer"
[adapter.railway.response]
redact = ["$.data.token"]§Why this parser is strict
Unknown fields are rejected. A misspelled redact key that parsed successfully would
silently disable response redaction, and the adapter would look like it was enforcing
something it was not. In a credential broker that failure mode is indistinguishable
from working until an incident, so every typo is a hard error.
Structs§
- Adapter
- Where a credential lives for one upstream, and what must not come back.
- Adapter
File - A parsed adapter file. One file may define several upstreams.
- Auth
Slot - Capture
- Where a response hands back a credential that did not exist before.
- Response
Policy - Slot
Path - A parsed path to one position in a JSON document.
Enums§
- Adapter
Error - Protocol
- The wire protocol an upstream speaks.
- Slot
Location - A place a credential can be carried.
- Slot
Path Error - Slot
Segment - Streaming
Policy
Constants§
- SCHEMA_
VERSION - The only schema version this crate understands.