From 16db75f41ccc4c86fcd268a2834a9a8892be2eb1 Mon Sep 17 00:00:00 2001 From: nick Date: Tue, 9 Jun 2026 15:20:56 -0600 Subject: [PATCH] docs: fix api v1 audit false positives --- docs/api-v1-audit.md | 62 ++++++++++++++++++++++++++++++-------------- 1 file changed, 42 insertions(+), 20 deletions(-) diff --git a/docs/api-v1-audit.md b/docs/api-v1-audit.md index 37fa784..14ef871 100644 --- a/docs/api-v1-audit.md +++ b/docs/api-v1-audit.md @@ -2,26 +2,48 @@ Generated: 2026-06-09 -This audit checks for legacy `/api/...` references that should likely use `/api/v1/...`. +This audit checks for legacy `/api/...` references that should use `/api/v1/...`. + +Valid `/api/v1/...` references are intentionally ignored. ## 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 | +| File | Line | Matched legacy path | Content | +|------|------|---------------------|---------| +| `tests/test_http_api_contract.py` | 31 | `/api/v1{match.group` | (f"/api/v1{match.group(1)}", match.group(2) or "ANY") | +| `tests/test_http_api_contract.py` | 82 | `/api/v1` | assert 'const API_BASE="/api/v1";' in source | +| `docs/project-state.md` | 192 | `/api/v1` | Active dashboard communication is WiFi/HTTP using `/api/v1`. | +| `docs/HARDWARE.md` | 148 | `/api/v1` | Active dashboard communication is WiFi/HTTP using `/api/v1`. | +| `docs/ARCHITECTURE.md` | 200 | `/api/v1` | Active dashboard communication is WiFi/HTTP using `/api/v1`. | +| `docs/API.md` | 14 | `/api/v1` | /api/v1 | +| `docs/API.md` | 60 | `/api/v1` | Pre-versioned root routes remain registered as compatibility aliases for existing local clients. New clients should use `/api/v1`. | +| `docs/API.md` | 837 | `/api/v1` | Current stable API prefix is `/api/v1`, for example `GET /api/v1/status`. | +| `docs/CHATGPT_HANDOFF.md` | 49 | `/api/v1` | - HTTP API base path is `/api/v1`. | +| `docs/CHATGPT_HANDOFF.md` | 67 | `/api/v1` | New clients should use `/api/v1`. | +| `docs/CHATGPT_HANDOFF.md` | 98 | `/api/v1` | - The project recently standardized current HTTP routes under `/api/v1`. | +| `docs/CHATGPT_HANDOFF.md` | 100 | `/api/v1` | - The embedded WebUI uses `const API_BASE="/api/v1";`. | +| `docs/CHATGPT_HANDOFF.md` | 136 | `/api/v1` | Active dashboard communication is WiFi/HTTP using `/api/v1`. | +| `docs/api-v1-audit.md` | 5 | `/api/...` | This audit checks for legacy `/api/...` references that should likely use `/api/v1/...`. | +| `docs/api-v1-audit.md` | 11 | `/api/v1{match.group` | \| `tests/test_http_api_contract.py` \| 31 \| (f"/api/v1{match.group(1)}", match.group(2) or "ANY") \| | +| `docs/api-v1-audit.md` | 12 | `/api/v1` | \| `tests/test_http_api_contract.py` \| 82 \| assert 'const API_BASE="/api/v1";' in source \| | +| `docs/api-v1-audit.md` | 13 | `/api/v1` | \| `docs/project-state.md` \| 192 \| Active dashboard communication is WiFi/HTTP using `/api/v1`. \| | +| `docs/api-v1-audit.md` | 14 | `/api/v1` | \| `docs/HARDWARE.md` \| 148 \| Active dashboard communication is WiFi/HTTP using `/api/v1`. \| | +| `docs/api-v1-audit.md` | 15 | `/api/v1` | \| `docs/ARCHITECTURE.md` \| 200 \| Active dashboard communication is WiFi/HTTP using `/api/v1`. \| | +| `docs/api-v1-audit.md` | 16 | `/api/v1` | \| `docs/API.md` \| 14 \| /api/v1 \| | +| `docs/api-v1-audit.md` | 17 | `/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/api-v1-audit.md` | 18 | `/api/v1` | \| `docs/CHATGPT_HANDOFF.md` \| 49 \| - HTTP API base path is `/api/v1`. \| | +| `docs/api-v1-audit.md` | 19 | `/api/v1` | \| `docs/CHATGPT_HANDOFF.md` \| 67 \| New clients should use `/api/v1`. \| | +| `docs/api-v1-audit.md` | 20 | `/api/v1` | \| `docs/CHATGPT_HANDOFF.md` \| 98 \| - The project recently standardized current HTTP routes under `/api/v1`. \| | +| `docs/api-v1-audit.md` | 21 | `/api/v1` | \| `docs/CHATGPT_HANDOFF.md` \| 100 \| - The embedded WebUI uses `const API_BASE="/api/v1";`. \| | +| `docs/api-v1-audit.md` | 22 | `/api/v1` | \| `docs/CHATGPT_HANDOFF.md` \| 136 \| Active dashboard communication is WiFi/HTTP using `/api/v1`. \| | +| `docs/api-v1-audit.md` | 23 | `/api/v1` | \| `docs/dashboard-esp32s3.md` \| 161 \| Active dashboard communication is WiFi/HTTP using `/api/v1`. \| | +| `docs/api-v1-audit.md` | 24 | `/api/v1` | \| `docs/roadmap.md` \| 135 \| Active dashboard communication is WiFi/HTTP using `/api/v1`. \| | +| `docs/api-v1-audit.md` | 25 | `/api/v1` | \| `docs/UART_PROTOCOL.md` \| 281 \| Active dashboard communication is WiFi/HTTP using `/api/v1`. \| | +| `docs/api-v1-audit.md` | 26 | `/api/v1` | \| `firmware/esp32/overland-controller/overland-controller.ino` \| 664 \| const API_BASE="/api/v1"; \| | +| `docs/api-v1-audit.md` | 27 | `/api/v1` | \| `firmware/esp32/overland-controller/overland-controller.ino` \| 1342 \| #define API_V1(path) "/api/v1" path \| | +| `docs/dashboard-esp32s3.md` | 161 | `/api/v1` | Active dashboard communication is WiFi/HTTP using `/api/v1`. | +| `docs/README.md` | 55 | `/api/v1` | - `api-v1-audit.md` - Audit of legacy API paths vs `/api/v1` namespace. | +| `docs/roadmap.md` | 135 | `/api/v1` | Active dashboard communication is WiFi/HTTP using `/api/v1`. | +| `docs/UART_PROTOCOL.md` | 281 | `/api/v1` | Active dashboard communication is WiFi/HTTP using `/api/v1`. | +| `firmware/esp32/overland-controller/overland-controller.ino` | 664 | `/api/v1` | const API_BASE="/api/v1"; | +| `firmware/esp32/overland-controller/overland-controller.ino` | 1342 | `/api/v1` | #define API_V1(path) "/api/v1" path |