nick/overland-controller
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: audit api v1 namespace usage

Browse Source
This commit is contained in:
nick
2026-06-09 15:20:16 -06:00
parent c166b38730
commit d3e9dca615
2 changed files with 29 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api-v1-audit.md
+27
View File
@@ -0,0 +1,27 @@
# API v1 Audit
Generated: 2026-06-09
This audit checks for legacy `/api/...` references that should likely use `/api/v1/...`.
## Potential Legacy References
| File | Line | Content |
|------|------|---------|
| `tests/test_http_api_contract.py` | 31 | (f"/api/v1{match.group(1)}", match.group(2) or "ANY") |
| `tests/test_http_api_contract.py` | 82 | assert 'const API_BASE="/api/v1";' in source |
| `docs/project-state.md` | 192 | Active dashboard communication is WiFi/HTTP using `/api/v1`. |
| `docs/HARDWARE.md` | 148 | Active dashboard communication is WiFi/HTTP using `/api/v1`. |
| `docs/ARCHITECTURE.md` | 200 | Active dashboard communication is WiFi/HTTP using `/api/v1`. |
| `docs/API.md` | 14 | /api/v1 |
| `docs/API.md` | 60 | Pre-versioned root routes remain registered as compatibility aliases for existing local clients. New clients should use `/api/v1`. |
| `docs/CHATGPT_HANDOFF.md` | 49 | - HTTP API base path is `/api/v1`. |
| `docs/CHATGPT_HANDOFF.md` | 67 | New clients should use `/api/v1`. |
| `docs/CHATGPT_HANDOFF.md` | 98 | - The project recently standardized current HTTP routes under `/api/v1`. |
| `docs/CHATGPT_HANDOFF.md` | 100 | - The embedded WebUI uses `const API_BASE="/api/v1";`. |
| `docs/CHATGPT_HANDOFF.md` | 136 | Active dashboard communication is WiFi/HTTP using `/api/v1`. |
| `docs/dashboard-esp32s3.md` | 161 | Active dashboard communication is WiFi/HTTP using `/api/v1`. |
| `docs/roadmap.md` | 135 | Active dashboard communication is WiFi/HTTP using `/api/v1`. |
| `docs/UART_PROTOCOL.md` | 281 | Active dashboard communication is WiFi/HTTP using `/api/v1`. |
| `firmware/esp32/overland-controller/overland-controller.ino` | 664 | const API_BASE="/api/v1"; |
| `firmware/esp32/overland-controller/overland-controller.ino` | 1342 | #define API_V1(path) "/api/v1" path |