hive-c0re: drop redundant METHOD/path prefixes from OpenAPI summaries
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:
parent
071dbd774c
commit
ec30277a90
16 changed files with 49 additions and 49 deletions
|
|
@ -28,7 +28,7 @@ use utoipa::ToSchema;
|
|||
|
||||
use crate::host_stats::ServerWarning;
|
||||
|
||||
/// `GET /health/live` — liveness. Always `200`; no further checks.
|
||||
/// Liveness. Always `200`; no further checks.
|
||||
#[utoipa::path(
|
||||
get,
|
||||
path = "/health/live",
|
||||
|
|
@ -49,7 +49,7 @@ struct ReadyBody {
|
|||
warnings: Vec<ServerWarning>,
|
||||
}
|
||||
|
||||
/// `GET /health/ready` — readiness.
|
||||
/// Readiness.
|
||||
///
|
||||
/// `200` with `{"status":"ok", "warnings": [...]}` unless a `crit`-level
|
||||
/// warning is currently set in [`crate::warnings::snapshot`], in which
|
||||
|
|
|
|||
Loading…
Reference in a new issue