vinzenz/hyperhive
vinzenz/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

hive-c0re: drop redundant METHOD/path prefixes from OpenAPI summaries

Browse source 
Swagger UI's endpoint-list row already shows the HTTP method badge +
path for every row, so restating `METHOD /path` at the start of a
handler's own summary is pure duplication. Strips that self-referential
prefix from every summary that has it and re-capitalizes what follows
as a standalone sentence.

Left two false positives untouched: misc_api.rs's operator-inbox
summary cross-references a *different* sibling endpoint
(mark-all-read) for context, and topology.rs's SetParentForm struct
doc happens to mention its endpoint's path but isn't a handler summary
line. Both are legitimate, not redundant.
This commit is contained in:
iris 2026-08-02 21:03:33 +02:00 • committed by mara
commit ec30277a90
16 changed files with 49 additions and 49 deletions
Download patch file Download diff file Expand all files Collapse all files

14
hive-c0re/src/dashboard/build_logs.rs
View file

@ -29,7 +29,7 @@ pub(super) struct BuildLogsAllQuery {
limit: Option<usize>,
}
/// `GET /api/build-logs?limit=N` — most-recent build log headers across
/// Most-recent build log headers across
/// all agents, newest first.
///
/// Same JSON shape as the per-agent endpoint.
@ -62,7 +62,7 @@ pub(super) struct BuildLogsQuery {
limit: Option<usize>,
}
/// `GET /api/build-logs/{agent}?limit=N` — most-recent build log
/// Most-recent build log
/// headers for one agent, newest first.
///
/// Returns `Vec<BuildLogHeader>` (JSON). Backs the per-agent log chip
@ -103,7 +103,7 @@ pub(super) async fn get_build_logs_agent(
}
}
/// `GET /api/build-logs/id/{id}` — full build log row (stdout +
/// Full build log row (stdout +
/// stderr concatenated) by id.
///
/// Returns `BuildLogFull` (JSON), or HTTP 404 when the id doesn't
@ -131,7 +131,7 @@ pub(super) async fn get_build_log_full(
}
}
/// `GET /api/build-log/{node_id}` — the build log for a **queue node**,
/// The build log for a **queue node**,
/// resolved node id → log-row id → full log.
///
/// Same `BuildLogFull` JSON (`stdout` / `stderr` + header) as
@ -166,7 +166,7 @@ pub(super) async fn get_build_log_for_node(
}
}
/// `GET /api/build-log/{node_id}/raw` — the node's build log as `text/plain`
/// The node's build log as `text/plain`
/// for download (delegates to `get_build_log_raw` after resolving the node id).
#[utoipa::path(
get,
@ -206,7 +206,7 @@ struct BuildLogFrame {
done: bool,
}
/// `GET /api/build-logs/id/{id}/stream` — SSE stream that delivers
/// SSE stream that delivers
/// incremental stdout/stderr as a build runs.
///
/// The client connects when it opens a running-build panel; the
@ -314,7 +314,7 @@ pub(super) async fn get_build_log_stream(
Sse::new(ReceiverStream::new(rx)).keep_alive(KeepAlive::default())
}
/// `GET /api/build-logs/id/{id}/raw` — full log as `text/plain` for
/// Full log as `text/plain` for
/// download.
///
/// Stdout and stderr are concatenated with a `--- stderr ---`