From 947d45a854d649c458db32b01ee1f79f7cddf5fc Mon Sep 17 00:00:00 2001 From: damocles Date: Sun, 2 Aug 2026 21:41:14 +0200 Subject: [PATCH] hive-c0re: fix stale ApiDoc doc comment claiming routes are undocumented Follow-up from #2872: the comment said 'the rest of the (much larger) route table below is undocumented for now' -- that was true when the annotation sweep started, not anymore. Trimmed to state the current fact plainly instead of narrating the sweep's history (mara: is that level of detail relevant here) -- this is a plain rustdoc comment on ApiDoc, not part of the actual OpenAPI JSON (that comes from the separate #[openapi(info(description = ...))] attribute below it), so keeping it terse and mechanical is the right call. --- hive-c0re/src/dashboard/mod.rs | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/hive-c0re/src/dashboard/mod.rs b/hive-c0re/src/dashboard/mod.rs index 463ce242..f3b3c563 100644 --- a/hive-c0re/src/dashboard/mod.rs +++ b/hive-c0re/src/dashboard/mod.rs @@ -20,15 +20,10 @@ use crate::lifecycle; /// Root of the auto-generated `OpenAPI` spec, served raw at /// `/api/openapi.json` — see [`utoipa`]. Swagger UI itself (browsable at -/// `/api/docs`) is nginx-hosted straight from the nix store now (see -/// `nix/host-modules/hive-gateway/vhosts.nix`'s `swaggerUiLocations`); -/// c0re only needs to serve the JSON this route generates, not the whole -/// vendored UI. Only routes carrying a -/// `#[utoipa::path(...)]` annotation show up; the rest of the (much -/// larger) route table below is undocumented for now. Deliberately -/// incremental: an unannotated route just doesn't appear in the spec, -/// nothing breaks, so routes get annotated as a series of small -/// follow-ups rather than one mega-diff. +/// `/api/docs`) is nginx-hosted from the nix store (see +/// `nix/host-modules/hive-gateway/vhosts.nix`'s `swaggerUiLocations`). +/// Only routes carrying a `#[utoipa::path(...)]` annotation show up in +/// the spec — an unannotated route just doesn't appear, nothing breaks. #[derive(OpenApi)] #[openapi( info(