Docs
Some checks failed
CI / Native Windows Build And Tests (push) Failing after 7s
CI / React UI Build (push) Has been cancelled
CI / Windows Release Package (push) Has been cancelled

This commit is contained in:
2026-05-03 12:11:53 +10:00
parent eeb8f294bf
commit cccb7a3aa3
7 changed files with 74 additions and 7 deletions

View File

@@ -143,7 +143,20 @@ The local REST control API is documented as an OpenAPI/Swagger spec:
docs/openapi.yaml
```
Load that file in Swagger UI, Redoc, or another OpenAPI viewer to inspect the `/api/state`, layer control, stack preset, and reload endpoints. Live state updates are also sent over the `/ws` WebSocket.
When the control server is running, the same spec is also served at:
```text
http://127.0.0.1:<serverPort>/docs/openapi.yaml
http://127.0.0.1:<serverPort>/openapi.yaml
```
A Swagger UI page is available at:
```text
http://127.0.0.1:<serverPort>/docs
```
Use those docs to inspect the `/api/state`, layer control, stack preset, and reload endpoints. Live state updates are also sent over the `/ws` WebSocket.
## Shader Packages