Files
dashback/docs/api/routes/articleIndex.md
seb 1860f38640 Add delivery and supplier HTTP APIs with expanded response docs.
Wire store-backed CRUD for goods receipts and suppliers, and teach the API doc generator to expand $ref/allOf/array samples so route markdown shows full JSON shapes.
2026-08-06 05:32:48 +02:00

46 lines
832 B
Markdown

# `GET /articleIndex`
Protected. Requires a valid session cookie (`credentials: 'include'`).
List article search index
Returns every article reachable via the company's category tree.
Designed for client-side search / autocomplete preload.
Auth via company access.
## Response `200`
Search index
```json
{
"articles": [
{
"id": 1,
"sku": "…",
"name": "…",
"eans": [
"…"
],
"categoryIds": [
1
]
}
]
}
```
## Errors
| Status | Description |
|--------|-------------|
| 400 | No company selected — `{"error":"…"}` |
| 401 | Unauthorized — `{"error":"…"}` |
| 403 | Not authorized — `{"error":"…"}` |
| 404 | Company not found — `{"error":"…"}` |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._