api documentation (#876)

* api documentation

* utoipa openapi docs generator

---------

Co-authored-by: Andrej Walilko <awalilko@liquidweb.com>
This commit is contained in:
Andrej Walilko
2026-02-16 19:41:15 -05:00
committed by GitHub
parent 9d50db40b9
commit 9b6c4cee0b
22 changed files with 542 additions and 15 deletions

5
doc/api-docs.md Normal file
View File

@@ -0,0 +1,5 @@
# REST API Documentation
The rayhunter daemon has [REST API documentation](./api-docs/) available in the interactive swagger-ui.
>**Note:** API endpoints are subject to change as needs arise, though we will try to keep them as stable as possible and notify about breaking changes in the changelogs for new versions.