mirror of
https://github.com/Kpa-clawbot/meshcore-analyzer.git
synced 2026-11-22 13:47:03 +00:00
Partial fix for #1670. Document the two public area configuration endpoints with reusable array response schemas. The descriptions distinguish labeled summaries from geometry entries, specify latitude/longitude order, and explain omitted fields and preserved zero bounds. Known route-description gaps decrease from 15 to 13. This changes generated API metadata only. Handler behavior, authentication, configuration and packet processing are unchanged; no new customizer settings or dependencies. Validation: - Tests-only RED `8f27f8ff0` builds and [fails the intended documentation assertions](https://github.com/Kpa-clawbot/CoreScope/actions/runs/43828097551/job/133166654496). - GREEN `5966b8021` passes the byte-unchanged tests; [final CI passes](https://github.com/Kpa-clawbot/CoreScope/actions/runs/43830879045). - Handler fixtures cover absent/empty config, labeled/unlabeled and underscore keys, whitespace labels, normal/short/empty polygons, partial bounds and zero values without assuming entry order. - All 26 focused checks pass on final GREEN. Full native server/ingestor suites passed at `e19c49e26` (158.088s/160.279s); the final amendment only clarifies four descriptions, and final CI includes both suites. - Parent browser validation rendered both operations in Swagger UI and executed their actual public GETs, checking coordinate shape, omissions and zero values. - Three independent reviews completed with no remaining findings; parent read every report. The remaining 13 route-description gaps and broader parameter/schema work stay open under #1670. --------- Co-authored-by: n30nex <6686206+n30nex@users.noreply.github.com>
19 lines
1.0 KiB
JSON
19 lines
1.0 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/docs",
|
|
"/api/dropped-packets",
|
|
"/api/nodes/{pubkey}/reach",
|
|
"/api/nodes/{pubkey}/rx-coverage",
|
|
"/api/paths/inspect",
|
|
"/api/rx-leaderboard",
|
|
"/api/scope-stats",
|
|
"/api/spec"
|
|
]
|
|
}
|