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: audit all 157 tool pages against live schemas

Browse Source 
Reconcile every tool page's parameters, defaults, and response shape against the tool's Zod settings schema and executionHint in code. Notable fixes: color-palette (add count + format params, hex output, median-cut algorithm), favicon (add 5 params, was documented as having none), qr-generate (add logoDataUri), convert (add ppm/eps/tga formats), video-loudnorm (-16 LUFS not -14), smart-crop (async 202 not sync 200), images-to-video (1080x1080 square), and several output-filename and behavior-note corrections.

Also normalize API endpoint paths to /api/v1/tools/<id> (no modality segment) and standardize curl examples on the Docker API port 1349. Verified with a clean docs build.
This commit is contained in:
SnapOtter
2026-06-18 14:12:28 +08:00
parent d24e244af4
commit 8532f3227b
160 changed files with 518 additions and 441 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/docs/tools/pdf/compress-pdf.md
+4 -4
View File
@@ -8,7 +8,7 @@ Reduce PDF file size by downsampling embedded images. Choose between a quality s
## API Endpoint
`POST /api/v1/tools/pdf/compress-pdf`
`POST /api/v1/tools/compress-pdf`
Accepts multipart form data with a PDF file and a JSON `settings` field.
@@ -17,7 +17,7 @@ Accepts multipart form data with a PDF file and a JSON `settings` field.
| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| mode | string | No | `"quality"` | Compression mode: `quality` or `targetSize` |
| quality | integer | No | - | Compression quality, 1-100 (higher = less compression). Used in `quality` mode |
| quality | integer | No | `75` | Compression quality, 1-100 (higher = less compression). Used in `quality` mode |
| targetSizeKb | number | No | - | Target file size in kilobytes. Used in `targetSize` mode |
## Example Request
@@ -25,7 +25,7 @@ Accepts multipart form data with a PDF file and a JSON `settings` field.
Compress by quality:
```bash
curl -X POST http://localhost:1349/api/v1/tools/pdf/compress-pdf \
curl -X POST http://localhost:1349/api/v1/tools/compress-pdf \
-H "Authorization: Bearer si_your-api-key" \
-F "file=@document.pdf" \
-F 'settings={"mode": "quality", "quality": 60}'
@@ -34,7 +34,7 @@ curl -X POST http://localhost:1349/api/v1/tools/pdf/compress-pdf \
Compress to a target size:
```bash
curl -X POST http://localhost:1349/api/v1/tools/pdf/compress-pdf \
curl -X POST http://localhost:1349/api/v1/tools/compress-pdf \
-H "Authorization: Bearer si_your-api-key" \
-F "file=@document.pdf" \
-F 'settings={"mode": "targetSize", "targetSizeKb": 500}'