u
This commit is contained in:
@@ -275,6 +275,7 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route
|
||||
| [`routes/unit/list.md`](routes/unit/list.md) | `GET /unit` |
|
||||
| [`routes/unit/upsert.md`](routes/unit/upsert.md) | `PUT /unit` |
|
||||
| [`routes/v1/category.md`](routes/v1/category.md) | `GET /v1/category` |
|
||||
| [`routes/pos/cimage.md`](routes/pos/cimage.md) | `GET /v1/cimage` |
|
||||
| [`routes/pos/client.md`](routes/pos/client.md) | `GET /v1/client` |
|
||||
| [`routes/v1/customer.md`](routes/v1/customer.md) | `GET /v1/customer` |
|
||||
| [`routes/v1/customergroup.md`](routes/v1/customergroup.md) | `GET /v1/customergroup` |
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Dash API Routes Overview (All)
|
||||
|
||||
Overview of all 268 API endpoints across all modules.
|
||||
Overview of all 269 API endpoints across all modules.
|
||||
|
||||
### Notation
|
||||
|
||||
@@ -924,6 +924,9 @@ _none_
|
||||
#### JTL-POS category synchronization — `GET /v1/category`
|
||||
- Params: `query: lastChangedCategory?: str, limit?: int`
|
||||
- Returns: `200 {}[]`
|
||||
#### POS category image delivery — `GET /v1/cimage`
|
||||
- Params: `query: path: str, w?: int, h?: int, format?: str`
|
||||
- Returns: `200 jpeg`
|
||||
#### POS discovery and pairing — `GET /v1/client`
|
||||
- Params: `query: authCode: str, name?: str`
|
||||
- Returns: `200 { authCode: str|null, authToken: str|null, certificateFingerprint: str, certificateSerialNumber: str, mandantId: str, mandantName: str|null, mandantDatabase: str|null, serverFingerprint: str|null, name: str|null, serverTimestamp: str }`
|
||||
|
||||
33
docs/api/routes/pos/cimage.md
Normal file
33
docs/api/routes/pos/cimage.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# `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 with 3:4 portrait ratio.
|
||||
|
||||
|
||||
## Query parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `path` | yes | string | SHA-256 hash of the category image |
|
||||
| `w` | no | integer | Max width |
|
||||
| `h` | no | integer | Max height |
|
||||
| `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`._
|
||||
Reference in New Issue
Block a user