External/SnapOtter
1
0
Fork 0
mirror of https://github.com/snapotter-hq/SnapOtter.git synced 2026-08-03 07:46:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

test(api): add integration tests for API docs endpoint

Browse Source 
Also update GitHub Pages REST API doc to link to /api/docs.
This commit is contained in:
Siddharth Kumar Sah
2026-03-27 13:50:03 +08:00
parent 9ed1090651
commit 655398e184
2 changed files with 60 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/docs/api/rest.md
+7 -1
View File
@@ -1,6 +1,12 @@
# REST API
The API server runs on port 1349 by default and serves all endpoints under `/api`. Interactive Swagger documentation is available at `/api/docs` when the server is running.
The API server runs on port 1349 by default and serves all endpoints under `/api`.
::: tip Interactive API Reference
When your Stirling Image instance is running, visit [`/api/docs`](http://localhost:1349/api/docs) for an interactive API reference with full endpoint documentation, request schemas, and response examples.
:::
The reference below covers the key endpoints. For the complete specification, see the interactive docs.
## Authentication