mirror of
https://github.com/Kpa-clawbot/meshcore-analyzer.git
synced 2026-11-11 11:57:57 +00:00
n30nex
041daecd1e
Partial follow-up to #1670. Six existing read-only diagnostics endpoints lacked usable OpenAPI descriptions: process I/O, SQLite metrics, ingestor write counters, and fleet/node/observer clock skew. This documents their parameters, empty/error behavior and response root shapes. The known-gap list falls from 24 to 18. Descriptions preserve current behavior, including unknown/empty area fallback, the PacketStore cache ratio, stale write-counter snapshots, and the single-node 404. Schemas remain minimal; the existing generator still declares only the generic 200 response, with 404 explained in prose. No runtime handler, authentication, configuration or customizer changes. No added generic response maps. Validation: regression tests exercise the served spec and real router, including missing/malformed data, area selection and fallback, and calibration responses. Full server and ingestor tests pass locally; post-push Chromium verifies the served spec, six routes and Swagger rendering. Three independent reviews passed. Test-only RED `218a3bf3` produced the [six expected documentation failures](https://github.com/Kpa-clawbot/CoreScope/actions/runs/40212159661/job/121225534416). GREEN `1e2d8c08` adds the documentation and [passes CI](https://github.com/Kpa-clawbot/CoreScope/actions/runs/40212678062), including all browser shards and architecture builds.
25 lines
1.2 KiB
JSON
25 lines
1.2 KiB
JSON
{
|
|
"_comment": "Allowlist of /api/ routes registered via HandleFunc in cmd/server/ that are NOT yet documented in cmd/server/openapi.go. This is the 'ratchet' baseline for issue #1670 Phase 1: the TestOpenAPICompleteness gate fails when a NEW handler is added without either documenting it in openapi.go OR appending it here. Phase 2 (the actual backfill of these routes into openapi.go) is tracked in a separate issue per the #1670 triage. Entries should be REMOVED as Phase 2 lands docs for each route — the gate also fails if an entry here is already covered by openapi.go (stale allowlist).",
|
|
"_issue": "https://github.com/Kpa-clawbot/CoreScope/issues/1670",
|
|
"routes": [
|
|
"/api/admin/prune-geo-filter",
|
|
"/api/admin/prune-geo-filter/status",
|
|
"/api/analytics/relay-airtime-share",
|
|
"/api/analytics/roles",
|
|
"/api/config/areas",
|
|
"/api/config/areas/polygons",
|
|
"/api/docs",
|
|
"/api/dropped-packets",
|
|
"/api/healthz",
|
|
"/api/known-channels",
|
|
"/api/nodes/resolve",
|
|
"/api/nodes/{pubkey}/battery",
|
|
"/api/nodes/{pubkey}/reach",
|
|
"/api/nodes/{pubkey}/rx-coverage",
|
|
"/api/paths/inspect",
|
|
"/api/rx-leaderboard",
|
|
"/api/scope-stats",
|
|
"/api/spec"
|
|
]
|
|
}
|