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

docs: replace localhost links with generic path references in API docs

Browse Source 
Clickable localhost:1349 links are misleading on the GitHub Pages site
since users may not have Stirling Image running locally. Use plain path
references instead so it is clear these live on their own instance.
This commit is contained in:
Siddharth Kumar Sah
2026-04-06 11:33:50 +08:00
parent 2eb74f242e
commit fe80287cb4
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/docs/api/rest.md
+2 -2
View File
@@ -3,7 +3,7 @@
The API server runs on port 1349 by default and serves all endpoints under `/api`.
::: tip Full API Reference
When your Stirling Image instance is running, visit [`/api/docs`](http://localhost:1349/api/docs) for the complete interactive API reference with all 67 endpoints, request/response schemas, and examples.
Your Stirling Image instance includes a complete interactive API reference at `/api/docs` (e.g. `http://your-host:1349/api/docs`) with all 67 endpoints, request/response schemas, and examples.
:::
::: info LLM-friendly docs
@@ -56,7 +56,7 @@ Send a multipart request with:
| **Layout** | `collage`, `split`, `border` |
| **Format** | `svg-to-raster`, `vectorize`, `gif-tools` |
Each tool's specific settings are documented in the [interactive API reference](http://localhost:1349/api/docs).
Each tool's specific settings are documented in the interactive API reference at `/api/docs` on your running instance.
## Batch processing