export

docs/api/README.md

@@ -31,6 +31,7 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route
 | File | Endpoint |
 |------|----------|
 | [`routes/article/create.md`](routes/article/create.md) | `POST /article` |
+| [`routes/article/export.zip.md`](routes/article/export.zip.md) | `GET /article/export.zip` |
 | [`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}` |

docs/api/openapi.json

@@ -2645,6 +2645,84 @@
         }
       }
     },
+    "/article/export.zip": {
+      "get": {
+        "tags": [
+          "Article"
+        ],
+        "summary": "Export articles as ZIP",
+        "description": "Builds an `artikel.zip` for the authenticated user's selected company.\n`categoryId` (optional) restricts the export to that category and below;\nit must be reachable via the company's root category. Defaults to the\nwhole company root tree.\nThe ZIP contains `artikel.csv` (semicolon-separated, Windows-1252)\nplus one AVIF entry per article image, named `<fullHash>.avif`\n(content-addressed, so shared hashes are deduplicated).\n",
+        "security": [
+          {
+            "cookieAuth": []
+          }
+        ],
+        "parameters": [
+          {
+            "in": "query",
+            "name": "categoryId",
+            "required": false,
+            "schema": {
+              "type": "integer"
+            },
+            "description": "Restrict export to this category subtree"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "ZIP archive",
+            "content": {
+              "application/zip": {
+                "schema": {
+                  "type": "string",
+                  "format": "binary"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "No company selected",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Not authorized",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Company not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/article/{sku}": {
       "get": {
         "tags": [

docs/api/routes/article/export.zip.md

@@ -0,0 +1,37 @@
+# `GET /article/export.zip`
+
+Protected. Requires a valid session cookie (`credentials: 'include'`).
+
+Export articles as ZIP
+
+Builds an `artikel.zip` for the authenticated user's selected company.
+`categoryId` (optional) restricts the export to that category and below;
+it must be reachable via the company's root category. Defaults to the
+whole company root tree.
+The ZIP contains `artikel.csv` (semicolon-separated, Windows-1252)
+plus one AVIF entry per article image, named `<fullHash>.avif`
+(content-addressed, so shared hashes are deduplicated).
+
+
+## Query parameters
+
+| Param | Required | Type | Description |
+|-------|----------|------|-------------|
+| `categoryId` | no | integer | Restrict export to this category subtree |
+
+## Response `200`
+
+ZIP archive
+
+## 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`._