These pages describe the intended behaviour of the gateway. The open-source release and the enterprise edition are being split out; details will be updated when the first release ships.
Core concepts
Targets, routes, credentials and sessions — the vocabulary the rest of these pages use.
Five terms carry most of the configuration. They are defined here once so the rest of the documentation can use them without re-explaining.
All five are managed in the console, not in the configuration file.
Provider
An upstream HTTP service that speaks one of the dialects you use. A provider is identified by a name, a base URL, and the routes it accepts. Providers are added in the console.
Route
A path pattern a provider accepts, such as POST /v1/messages. A route is what makes a
provider reachable — a provider with no matching route is never selected.
Routes do not describe a transformation. They describe where a request may be sent.
Credential
How Solidway authenticates to a provider: a header, a bearer token, or a cloud signature scheme (AWS SigV4, GCP ADC). Credentials are entered in the console and encrypted at rest.
Multiple credentials on one provider form a key pool. The pool is what failover rotates through and what load balancing distributes across.
Target
A concrete (provider, route, credential) triple that a request can be sent to. Every
attempt in a fallback chain is an attempt against one target.
Session
An optional grouping that pins a sequence of requests to the same target. Useful when a provider benefits from locality. Sessions never override health: a held target is skipped even when a session points at it.
How they relate
request ──► route matches ──► provider selected ──► credential chosen
│
▼
target (attempt)
│
failure? ─────┴─────► next target