mirror of
https://github.com/Kpa-clawbot/meshcore-analyzer.git
synced 2026-11-11 12:37:33 +00:00
n30nexandn30nex
ef17d78909
Partial follow-up to #1670; the broader documentation issue stays open. Documents the existing node-prefix resolution and node battery-history GET APIs: parameters, normalization and lookup rules, defaults, ambiguity/visibility, ordered samples, nullable latest values and error media types. The generator now has concrete success schemas for both. Error statuses remain documented in prose under its existing convention. Removes exactly these two entries from the known-gap list: 18 → 16, with 115 of 131 routes described. No handler, query, configuration or dependency changes. [RED CI](https://github.com/Kpa-clawbot/CoreScope/actions/runs/40426035729/job/121931981058) reaches the missing-documentation assertions. GREEN `521fb3ef` passes both full native CGO suites and focused OpenAPI/real-handler contract tests. Parent browser acceptance passed 28 checks through the rendered Swagger UI and actual endpoints, including defaults, errors and empty/null history. All three independent review roles passed. [Final CI](https://github.com/Kpa-clawbot/CoreScope/actions/runs/40427081025) passes on this exact head, including all browser shards and the two-architecture image check. --------- Co-authored-by: n30nex <6686206+n30nex@users.noreply.github.com>
23 lines
1.1 KiB
JSON
23 lines
1.1 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/{pubkey}/reach",
|
|
"/api/nodes/{pubkey}/rx-coverage",
|
|
"/api/paths/inspect",
|
|
"/api/rx-leaderboard",
|
|
"/api/scope-stats",
|
|
"/api/spec"
|
|
]
|
|
}
|