35 lines
982 B
Markdown
35 lines
982 B
Markdown
# `GET /v1/cimage`
|
|
|
|
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
|
|
|
POS category image delivery
|
|
|
|
Returns category image by hash (`path` query param) scaled to preview size (padded to 1:1 with white background).
|
|
|
|
|
|
## Query parameters
|
|
|
|
| Param | Required | Type | Description |
|
|
|-------|----------|------|-------------|
|
|
| `path` | yes | string | SHA-256 hash of the category image |
|
|
| `size` | no | integer | Max dimension (width & height, capped to 200) |
|
|
| `w` | no | integer | Max width (capped to 200) |
|
|
| `h` | no | integer | Max height (capped to 200) |
|
|
| `format` | no | string | Optional target format (defaults to jpeg/png or client Accept preference) |
|
|
|
|
## Response `200`
|
|
|
|
Resized image binary
|
|
|
|
## Errors
|
|
|
|
| Status | Description |
|
|
|--------|-------------|
|
|
| 304 | Image not modified |
|
|
| 400 | Missing required query parameter 'path' |
|
|
| 404 | Image not found |
|
|
|
|
---
|
|
|
|
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|