mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
docs: comprehensive API sync and documentation audit
- Rewrite OpenAPI spec to match actual code (988 lines changed):
- Fix ToolResponse schema (add previewUrl, savedFileId)
- Fix Error schema shape ({error, details} not {statusCode, error, message})
- Fix POST /api/auth/register URL (was /api/auth/users)
- Fix login/session responses (7 missing user fields + expiresAt)
- Fix 8 endpoints returning 204 → 200 with {ok: true}
- Fix pipeline execute field name (steps → pipeline)
- Fix API keys response key (keys → apiKeys)
- Fix settings response wrapper, teams UUID type
- Rewrite 7 major tool response schemas (info, barcode-read,
find-duplicates, compare, remove-background, upscale, ocr, blur-faces)
- Fix files/save-result (JSON → multipart), files/upload (201 + array)
- Fix SSE progress schema (integers not arrays)
- Add 422/501 error responses to AI and processing tools
- Fix settings required → optional on 29 tool endpoints
- Add 5 missing color adjustment fields to alias endpoints
- Rewrite rest.md tool parameter descriptions (12 tools fixed)
- Add Tool Sub-Routes section to rest.md (11 endpoints)
- Fix file library, settings, pipeline, auth docs in rest.md
- Fix API key hashing description (SHA-256 → scrypt)
- Fix "GitHub Pages" → "Cloudflare Pages" in architecture + deployment docs
- Fix tool count "45+" → "47" across all doc surfaces
- Fix branding endpoint paths in rest.md (/branding/logo → /settings/logo)
This commit is contained in:
@@ -148,6 +148,7 @@ RUN for i in 1 2 3; do apt-get -o Acquire::Retries=3 update && break || sleep $(
|
||||
apt-get install -y --no-install-recommends \
|
||||
tini \
|
||||
imagemagick \
|
||||
libmagickcore-6.q16-7-extra \
|
||||
libraw-dev \
|
||||
libopenexr-dev \
|
||||
potrace \
|
||||
|
||||
@@ -25,6 +25,18 @@ if [ ! -d "$AI_VENV" ] && [ -d "/opt/venv" ]; then
|
||||
echo "AI venv ready at $AI_VENV"
|
||||
fi
|
||||
|
||||
print_banner() {
|
||||
RST='\033[0m'
|
||||
printf '\n'
|
||||
printf ' \033[1;36m🦦 SnapOtter%b\n' "$RST"
|
||||
printf ' \033[2m────────────────────────────────────────%b\n' "$RST"
|
||||
printf '\n'
|
||||
printf ' \033[32m➜%b Open \033[1;4mhttp://localhost:%s%b\n' "$RST" "${PORT:-1349}" "$RST"
|
||||
printf ' \033[33m➜%b Login \033[1m%s%b / \033[1m%s%b\n' "$RST" "${DEFAULT_USERNAME}" "$RST" "${DEFAULT_PASSWORD}" "$RST"
|
||||
printf ' \033[36m➜%b Docs \033[2mhttps://docs.snapotter.com%b\n' "$RST" "$RST"
|
||||
printf '\n'
|
||||
}
|
||||
|
||||
# Fix ownership of mounted volumes so the non-root snapotter user can write.
|
||||
# This runs as root, fixes permissions, then drops to snapotter via gosu.
|
||||
if [ "$(id -u)" = "0" ]; then
|
||||
@@ -68,8 +80,10 @@ if [ "$(id -u)" = "0" ]; then
|
||||
chown -R snapotter:snapotter /data /tmp/workspace 2>&1 || \
|
||||
echo "WARNING: Could not fix volume permissions. Use named volumes (not Windows bind mounts) to avoid this. See docs for details." >&2
|
||||
|
||||
print_banner
|
||||
exec gosu snapotter "$@"
|
||||
fi
|
||||
|
||||
# Already running as snapotter (e.g. Kubernetes runAsUser)
|
||||
print_banner
|
||||
exec "$@"
|
||||
|
||||
Reference in New Issue
Block a user