hive-c0re: annotate remaining dashboard routes with utoipa
This commit is contained in:
parent
8ebefeb0d5
commit
582ebe5eee
21 changed files with 738 additions and 45 deletions
|
|
@ -291,6 +291,21 @@ where
|
|||
/// minutes.
|
||||
const CRASH_WARNING_WINDOW: std::time::Duration = std::time::Duration::from_mins(10);
|
||||
|
||||
/// `GET /api/state` — cold-load snapshot of the whole dashboard: roster,
|
||||
/// approvals (+ history), questions (+ history), tombstones, job queue,
|
||||
/// meta inputs, and more. Live clients then follow `/api/dashboard/stream`
|
||||
/// (SSE) for incremental updates keyed off `seq`.
|
||||
// `StateSnapshot` is a large tree of nested view types (`ContainerView`,
|
||||
// `ApprovalView`, `QuestionView`, ...) with no `ToSchema` anywhere in that
|
||||
// graph; wiring it up is a schema-modelling project of its own, well past
|
||||
// "annotate what's reachable". `serde_json::Value` placeholder for now —
|
||||
// see the batch report.
|
||||
#[utoipa::path(
|
||||
get,
|
||||
path = "/api/state",
|
||||
responses((status = 200, description = "full dashboard snapshot", body = serde_json::Value)),
|
||||
tag = "state_snapshot"
|
||||
)]
|
||||
pub(super) async fn api_state(
|
||||
headers: HeaderMap,
|
||||
State(state): State<AppState>,
|
||||
|
|
|
|||
Loading…
Reference in a new issue