Files
dashback/docs/api/routes/category/add-image.md
2026-09-29 13:44:14 +02:00

1.3 KiB
Raw Blame History

POST /category/{id}/image

Protected. Requires a valid session cookie (credentials: 'include').

Add category image

Accepts a full-size AVIF body (Content-Type: image/avif) or WebP body (Content-Type: image/webp). WebP images are automatically converted to AVIF on the server. Full: stored as-is when already AVIF and ≤1000×1000; otherwise scaled to max 1000×1000. Thumb always scaled to max 200×200. Stores hash/thumbhash, links categorypic. Auth like GET /category/tree — user must be authorized for the category's company.

Path parameters

Param Required Type Description
id yes integer Category id

Body

Raw binary (image/avif).

Raw binary (image/webp).

Signals

On success, emits SSE signal: category (see GET /events).

Response 201

Image stored and linked

{
  "category": {
    "id": 1,
    "thumbW": 1,
    "thumbH": 1,
    "thumbHash": "…"
  }
}

Errors

Status Description
400 Missing body or invalid image — {"error":"…"}
401 Unauthorized — {"error":"…"}
403 Not authorized — {"error":"…"}
404 Category not found — {"error":"…"}

Generated from @openapi JSDoc. Do not edit by hand — run npm run docs:api.