Docs
This commit is contained in:
15
README.md
15
README.md
@@ -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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user