API

Browsable reference for the dashboard-api, remote-dashboard-api and mailer REST endpoints, generated straight from the handler annotations in the Go code — always in sync with what’s actually deployed. Endpoints are grouped by service, then by domain (miners, alerts, audit, configuration…).

>_ Terminal

$ make swagger
>>> Regenerating OpenAPI spec...
cd server && go tool swag init -g cmd/dashboard-api/main.go -o docs/swagger --outputTypes json,yaml --parseInternal
...
create swagger.json at docs/swagger/swagger.json
create swagger.yaml at docs/swagger/swagger.yaml
cp server/docs/swagger/swagger.json docs/assets/api/swagger.json
>>> Done. See server/docs/swagger/swagger.yaml and docs/assets/api/swagger.json

Open full-screen →

Raw spec, for importing into another tool: swagger.yaml / swagger.json.