Documentation
DocumentationAPI reference
DOCS / UWA V1 RELEASE CONTRACT SELF-HOSTED GATEWAY

API reference

Ten protected capability routes and four operational endpoints verified against router.go and OpenAPI.

ONE GATEWAYCoordinates → eligible provider → canonical responseWhy UWA
On this page 4 sections

#Authentication

All ten capability routes require an appropriately scoped gateway key via X-API-Key or Authorization: Bearer. On GET /v1/datasets, the caller must hold the scope for every requested dataset before any dataset handler executes.

#Product endpoints (10 routes)

#Operational endpoints

PathAccessPurpose
GET /healthPublic probeProcess health (bypasses client rate limit)
GET /readinessPublic probeDependency & configured capability readiness (fails if required Redis is down)
GET /livenessPublic probeProcess liveness
GET /metricsLoopback + Bearer tokenPrometheus metrics (disabled by default; requires APP_METRICS_MODE=loopback and APP_METRICS_TOKEN >=32 chars)

#Contract sources

Source-of-truth files: docs/openapi.yaml (default lean_v1 contract), docs/openapi.experimental.yaml (full_experimental contract), internal/routing/router.go, internal/routing/datasets.go and per-product handlers in internal/capability/.

Canonical contracts: docs/openapi.yaml (lean_v1) and docs/openapi.experimental.yaml · Verify against your build before production use.

Search local documentation. No external requests.

↑↓ to move · Enter to openESC to close