u
This commit is contained in:
@@ -47,7 +47,7 @@ export function register(app, basePath = '') {
|
||||
* get:
|
||||
* tags: [Brand]
|
||||
* summary: List brands
|
||||
* description: Lists brands for the authenticated user's selected company, sorted by name. Paged; `total` is the unpaged count.
|
||||
* description: Lists brands for the authenticated user's selected company, sorted by name. Paged; `total` is the unpaged count. Small-thumbnail fields are omitted by default. Set `includeSmallThumbs=true` to include each picture's `smallThumbW`, `smallThumbH`, and `smallThumbBinary` (base64-encoded AVIF bytes, resized with a 40px maximum edge).
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* parameters:
|
||||
@@ -66,6 +66,12 @@ export function register(app, basePath = '') {
|
||||
* minimum: 1
|
||||
* maximum: 100
|
||||
* description: Number of brands to return
|
||||
* - in: query
|
||||
* name: includeSmallThumbs
|
||||
* schema:
|
||||
* type: boolean
|
||||
* default: false
|
||||
* description: Include each picture's small thumbnail dimensions and base64 AVIF bytes.
|
||||
* x-markdown: brand/list.md
|
||||
* responses:
|
||||
* 200:
|
||||
@@ -79,7 +85,7 @@ export function register(app, basePath = '') {
|
||||
* brands:
|
||||
* type: array
|
||||
* items:
|
||||
* $ref: '#/components/schemas/Brand'
|
||||
* $ref: '#/components/schemas/BrandList'
|
||||
* total:
|
||||
* type: integer
|
||||
* description: Total number of unpaged brands
|
||||
@@ -90,7 +96,7 @@ export function register(app, basePath = '') {
|
||||
* type: integer
|
||||
* description: Number of brands returned
|
||||
* 400:
|
||||
* description: Invalid offset, invalid limit, or no company selected
|
||||
* description: Invalid offset, invalid limit, invalid includeSmallThumbs, or no company selected
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
@@ -122,6 +128,15 @@ export function register(app, basePath = '') {
|
||||
|
||||
const rawOffset = req.query.offset;
|
||||
const rawLimit = req.query.limit;
|
||||
const rawIncludeSmallThumbs = req.query.includeSmallThumbs;
|
||||
|
||||
if (
|
||||
rawIncludeSmallThumbs !== undefined
|
||||
&& rawIncludeSmallThumbs !== 'true'
|
||||
&& rawIncludeSmallThumbs !== 'false'
|
||||
) {
|
||||
return res.status(400).json({ error: 'includeSmallThumbs must be true or false' });
|
||||
}
|
||||
|
||||
let offset = 0;
|
||||
let limit = 10;
|
||||
@@ -141,7 +156,11 @@ export function register(app, basePath = '') {
|
||||
}
|
||||
|
||||
try {
|
||||
const result = await db.list(req.user.id, { offset, limit });
|
||||
const result = await db.list(req.user.id, {
|
||||
offset,
|
||||
limit,
|
||||
includeSmallThumbs: rawIncludeSmallThumbs === 'true',
|
||||
});
|
||||
res.status(200).json(result);
|
||||
} catch (error) {
|
||||
const status = brandErrorStatus(error);
|
||||
|
||||
Reference in New Issue
Block a user