seb/dashback
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

u

Browse Source
This commit is contained in:
seb
2026-09-29 20:10:46 +02:00
parent 79b48c5d47
commit 1de802fbaa
8 changed files with 805 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api/README.md
View File

@@ -37,6 +37,8 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route
| [`routes/article/delete.md`](routes/article/delete.md) | `DELETE /article/{sku}` |
| [`routes/article/get.md`](routes/article/get.md) | `GET /article/{sku}` |
| [`routes/article/update.md`](routes/article/update.md) | `PATCH /article/{sku}` |
| [`routes/article/_sku/articlelist.get.md`](routes/article/_sku/articlelist.get.md) | `GET /article/{sku}/articlelist` |
| [`routes/article/_sku/articlelist.put.md`](routes/article/_sku/articlelist.put.md) | `PUT /article/{sku}/articlelist` |
| [`routes/article/_sku/attributevalue.get.md`](routes/article/_sku/attributevalue.get.md) | `GET /article/{sku}/attributevalue` |
| [`routes/article/_sku/attributevalue.put.md`](routes/article/_sku/attributevalue.put.md) | `PUT /article/{sku}/attributevalue` |
| [`routes/article/set-brand.md`](routes/article/set-brand.md) | `PUT /article/{sku}/brand` |
@@ -50,6 +52,8 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route
| [`routes/article/add-image.md`](routes/article/add-image.md) | `POST /article/{sku}/image` |
| [`routes/article/delete-image.md`](routes/article/delete-image.md) | `DELETE /article/{sku}/image/{fullHash}` |
| [`routes/article/order-images.md`](routes/article/order-images.md) | `PUT /article/{sku}/images/order` |
| [`routes/article/_sku/optionslist.get.md`](routes/article/_sku/optionslist.get.md) | `GET /article/{sku}/optionslist` |
| [`routes/article/_sku/optionslist.put.md`](routes/article/_sku/optionslist.put.md) | `PUT /article/{sku}/optionslist` |
| [`routes/article/set-prices.md`](routes/article/set-prices.md) | `PUT /article/{sku}/prices` |
| [`routes/article/_sku/print.md`](routes/article/_sku/print.md) | `POST /article/{sku}/print` |
| [`routes/article/_sku/property.get.md`](routes/article/_sku/property.get.md) | `GET /article/{sku}/property` |

313
docs/api/openapi.json
View File

@@ -12947,6 +12947,319 @@
}
}
},
"/article/{sku}/articlelist": {
"get": {
"summary": "Get Stückliste (bundle items) for an article",
"description": "Returns the list of component items for a Stückliste article.",
"tags": [
"Article"
],
"security": [
{
"cookieAuth": []
}
],
"parameters": [
{
"in": "path",
"name": "sku",
"required": true,
"schema": {
"type": "string"
},
"description": "Article SKU"
}
],
"responses": {
"200": {
"description": "List of bundle items",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"articleId": {
"type": "integer"
},
"sku": {
"type": "string"
},
"name": {
"type": "string"
},
"count": {
"type": "integer"
},
"sort": {
"type": "integer"
}
}
}
}
}
}
}
}
},
"404": {
"description": "Article not found"
}
}
},
"put": {
"summary": "Set Stückliste (bundle items) for an article",
"description": "Configures the article as a Stückliste covering a list of count * article. An article that is a father or has options cannot be a Stückliste. Pass an empty array to remove the Stückliste.",
"tags": [
"Article"
],
"security": [
{
"cookieAuth": []
}
],
"parameters": [
{
"in": "path",
"name": "sku",
"required": true,
"schema": {
"type": "string"
},
"description": "Article SKU"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"articleId": {
"type": "integer"
},
"sku": {
"type": "string"
},
"count": {
"type": "integer",
"default": 1
},
"sort": {
"type": "integer"
}
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Updated Stückliste items",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
}
}
},
"400": {
"description": "Article is a father, has options, or contains itself"
},
"404": {
"description": "Article or component article not found"
}
}
}
},
"/article/{sku}/optionslist": {
"get": {
"summary": "Get options list for an article",
"description": "Returns the available options for an article.",
"tags": [
"Article"
],
"security": [
{
"cookieAuth": []
}
],
"parameters": [
{
"in": "path",
"name": "sku",
"required": true,
"schema": {
"type": "string"
},
"description": "Article SKU"
}
],
"responses": {
"200": {
"description": "List of options",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"articleId": {
"type": "integer"
},
"sku": {
"type": "string"
},
"name": {
"type": "string"
},
"count": {
"type": "integer"
},
"sort": {
"type": "integer"
},
"mandated": {
"type": "boolean"
}
}
}
}
}
}
}
}
},
"404": {
"description": "Article not found"
}
}
},
"put": {
"summary": "Set options list for an article",
"description": "Configures options for an article. Some options can be mandated (come with the article in any case). An article that is a father or a Stückliste cannot have options. Pass an empty array to remove options.",
"tags": [
"Article"
],
"security": [
{
"cookieAuth": []
}
],
"parameters": [
{
"in": "path",
"name": "sku",
"required": true,
"schema": {
"type": "string"
},
"description": "Article SKU"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"options"
],
"properties": {
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"articleId": {
"type": "integer"
},
"sku": {
"type": "string"
},
"count": {
"type": "integer",
"default": 1
},
"sort": {
"type": "integer"
},
"mandated": {
"type": "boolean",
"default": false
}
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Updated options list",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"options": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
}
}
},
"400": {
"description": "Article is a father, a Stückliste, or contains itself"
},
"404": {
"description": "Article or option article not found"
}
}
}
},
"/auth/selected-company": {
"put": {
"tags": [

42
docs/api/routes/article/_sku/articlelist.get.md Normal file
View File

@@ -0,0 +1,42 @@
# `GET /article/{sku}/articlelist`
Protected. Requires a valid session cookie (`credentials: 'include'`).
Get Stückliste (bundle items) for an article
Returns the list of component items for a Stückliste article.
## Path parameters
| Param | Required | Type | Description |
|-------|----------|------|-------------|
| `sku` | yes | string | Article SKU |
## Response `200`
List of bundle items
```json
{
"items": [
{
"id": 1,
"articleId": 1,
"sku": "…",
"name": "…",
"count": 1,
"sort": 1
}
]
}
```
## Errors
| Status | Description |
|--------|-------------|
| 404 | Article not found |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._

51
docs/api/routes/article/_sku/articlelist.put.md Normal file
View File

@@ -0,0 +1,51 @@
# `PUT /article/{sku}/articlelist`
Protected. Requires a valid session cookie (`credentials: 'include'`).
Set Stückliste (bundle items) for an article
Configures the article as a Stückliste covering a list of count * article. An article that is a father or has options cannot be a Stückliste. Pass an empty array to remove the Stückliste.
## Path parameters
| Param | Required | Type | Description |
|-------|----------|------|-------------|
| `sku` | yes | string | Article SKU |
## Body (JSON)
```json
{
"items": [
{
"articleId": 1,
"sku": "…",
"count": 1,
"sort": 1
}
]
}
```
## Response `200`
Updated Stückliste items
```json
{
"items": [
{}
]
}
```
## Errors
| Status | Description |
|--------|-------------|
| 400 | Article is a father, has options, or contains itself |
| 404 | Article or component article not found |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._

43
docs/api/routes/article/_sku/optionslist.get.md Normal file
View File

@@ -0,0 +1,43 @@
# `GET /article/{sku}/optionslist`
Protected. Requires a valid session cookie (`credentials: 'include'`).
Get options list for an article
Returns the available options for an article.
## Path parameters
| Param | Required | Type | Description |
|-------|----------|------|-------------|
| `sku` | yes | string | Article SKU |
## Response `200`
List of options
```json
{
"options": [
{
"id": 1,
"articleId": 1,
"sku": "…",
"name": "…",
"count": 1,
"sort": 1,
"mandated": true
}
]
}
```
## Errors
| Status | Description |
|--------|-------------|
| 404 | Article not found |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._

52
docs/api/routes/article/_sku/optionslist.put.md Normal file
View File

@@ -0,0 +1,52 @@
# `PUT /article/{sku}/optionslist`
Protected. Requires a valid session cookie (`credentials: 'include'`).
Set options list for an article
Configures options for an article. Some options can be mandated (come with the article in any case). An article that is a father or a Stückliste cannot have options. Pass an empty array to remove options.
## Path parameters
| Param | Required | Type | Description |
|-------|----------|------|-------------|
| `sku` | yes | string | Article SKU |
## Body (JSON)
```json
{
"options": [
{
"articleId": 1,
"sku": "…",
"count": 1,
"sort": 1,
"mandated": true
}
]
}
```
## Response `200`
Updated options list
```json
{
"options": [
{}
]
}
```
## Errors
| Status | Description |
|--------|-------------|
| 400 | Article is a father, a Stückliste, or contains itself |
| 404 | Article or option article not found |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._