jan/racecraft
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: fix endpoint count (28), correct track endpoint paths

Browse source
This commit is contained in:
Jan-Peter von Hunnius 2026-06-24 09:46:42 +02:00
parent 7bda8b4af1
commit c6bcab486c
2 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

2
AGENTS.md
View file

@ -46,7 +46,7 @@ Use the `joplin_get_note` tool with note ID `6c0dcb2a567348fd9796f50c790082e4` t
## API Communication ## API Communication
Racecraft communicates exclusively with the rusty-telemetry REST API (23 endpoints). In development, Vite proxies `/api/*` to `http://127.0.0.1:8080`. See the rusty-telemetry README for full endpoint documentation. Racecraft communicates exclusively with the rusty-telemetry REST API (28 endpoints). In development, Vite proxies `/api/*` to `http://127.0.0.1:8080`. See the rusty-telemetry README for full endpoint documentation.
## Features ## Features

6
README.md
View file

@ -169,7 +169,7 @@ racecraft/
## API Contract ## API Contract
Racecraft consumes the rusty-telemetry REST API (23 endpoints). See the [rusty-telemetry README](https://codeberg.org/jhunnius/rusty-telemetry) for full endpoint documentation. Racecraft consumes the rusty-telemetry REST API (28 endpoints). See the [rusty-telemetry README](https://codeberg.org/jhunnius/rusty-telemetry) for full endpoint documentation.
Key endpoints used: Key endpoints used:
- `GET /api/live` — polled every 250ms–1000ms for live telemetry - `GET /api/live` — polled every 250ms–1000ms for live telemetry
@ -179,8 +179,8 @@ Key endpoints used:
- `GET /api/sessions/{id}/analysis` — retrieve analysis results - `GET /api/sessions/{id}/analysis` — retrieve analysis results
- `GET /api/characteristics/cars` — aggregated car shift-point profiles - `GET /api/characteristics/cars` — aggregated car shift-point profiles
- `GET /api/characteristics/cars/{car}` — detailed per-gear data for a car - `GET /api/characteristics/cars/{car}` — detailed per-gear data for a car
- `GET /api/tracks` / `GET /api/tracks/{track}` — track model list and detail - `GET /api/tracks` / `GET /api/tracks/{game}/{track_name}` — track model list and detail
- `POST /api/sessions/{id}/build-track-model` — build track model from session - `POST /api/tracks/build` — build track model from completed session
## License ## License