Expand description
Admin / operator HTTP surface (hypercall-admin crate).
Every admin and operator endpoint is registered through admin_router over
the narrow state::AdminState. These endpoints are protected by
ADMIN_API_KEY and excluded from the public OpenAPI spec via the Monitoring
and Admin hidden tags. The auth layer is NOT applied here; the server
applies a single auth::monitoring_auth_middleware layer over this router,
which is the entire admin surface.
This crate depends only on stable lower crates (hypercall-runtime-api,
hypercall-types, hypercall-db, …) plus the admin-local
state::AdminState. It does NOT depend on hypercall-api, and
hypercall-api does NOT depend on it; they are siblings composed at the root.
The competition admin handlers call hypercall_competition::CompetitionService
directly; the business logic lives in that crate and the public competition
read routes stay in hypercall-api.
Modules§
- auth
- Authentication middleware for the admin/operator HTTP surface.
- competition
- Competition admin endpoints.
- lifecycle
- Standby promotion + drain lifecycle admin endpoints.
- monitoring
- Observability and operator endpoints served under the
/monitoring/*and/recovery-safetyURL prefixes. The submodule layout mirrors those routes. Observability and operator endpoints served under the/monitoring/*and/recovery-safetyURL prefixes. - pm_
settlement - Portfolio-margin settlement pool admin endpoints.
- rfq
- RFQ quote-provider admin endpoints.
- state
- Narrow application state for the admin/operator HTTP surface.
- testnet
- Testnet-only admin endpoints (feature
test-endpoints).
Structs§
- Admin
ApiDoc - OpenAPI document for the admin/operator surface.
- Test
Endpoints 🔒ApiDoc
Functions§
- admin_
openapi - Returns the admin OpenAPI document.
- admin_
router - Build the admin router over the narrow
AdminState.