Remove dedicated POST /category/:id/move route.
Dropping the standalone move endpoint; category relocation is now covered by PATCH /category/:id via parentId (merged with name rename). Removes the move route docs and regenerates API docs.
This commit is contained in:
seb
@@ -54,7 +54,6 @@ That writes `docs/api/openapi.json` and per-route Markdown under `docs/api/route
|
|||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `PATCH` | `/api/category/:id` | `category.rename` und/oder `category.move` (Name+Slug und/oder Verschieben unter neuen Eltern) |
|
| `PATCH` | `/api/category/:id` | `category.rename` und/oder `category.move` (Name+Slug und/oder Verschieben unter neuen Eltern) |
|
||||||
| `PUT` | `/api/category/order` | `category.order` (Geschwister-Sortierung unter einem Elternteil) |
|
| `PUT` | `/api/category/order` | `category.order` (Geschwister-Sortierung unter einem Elternteil) |
|
||||||
| `POST` | `/api/category/:id/move` | `category.move` (Kategorie unter neues Elternteil verschieben) |
|
|
||||||
|
|
||||||
## Users
|
## Users
|
||||||
|
|
||||||
|
|||||||
@@ -55,7 +55,6 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route
|
|||||||
| [`routes/category/delete.md`](routes/category/delete.md) | `DELETE /category/{id}` |
|
| [`routes/category/delete.md`](routes/category/delete.md) | `DELETE /category/{id}` |
|
||||||
| [`routes/category/update.md`](routes/category/update.md) | `PATCH /category/{id}` |
|
| [`routes/category/update.md`](routes/category/update.md) | `PATCH /category/{id}` |
|
||||||
| [`routes/category/articles.md`](routes/category/articles.md) | `GET /category/{id}/articles` |
|
| [`routes/category/articles.md`](routes/category/articles.md) | `GET /category/{id}/articles` |
|
||||||
| [`routes/category/move.md`](routes/category/move.md) | `POST /category/{id}/move` |
|
|
||||||
| [`routes/company/list.md`](routes/company/list.md) | `GET /company` |
|
| [`routes/company/list.md`](routes/company/list.md) | `GET /company` |
|
||||||
| [`routes/company/create.md`](routes/company/create.md) | `POST /company` |
|
| [`routes/company/create.md`](routes/company/create.md) | `POST /company` |
|
||||||
| [`routes/company/delete.md`](routes/company/delete.md) | `DELETE /company/{id}` |
|
| [`routes/company/delete.md`](routes/company/delete.md) | `DELETE /company/{id}` |
|
||||||
|
|||||||
@@ -1433,127 +1433,6 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"/category/{id}/move": {
|
|
||||||
"post": {
|
|
||||||
"tags": [
|
|
||||||
"Category"
|
|
||||||
],
|
|
||||||
"summary": "Move category to a new parent",
|
|
||||||
"description": "Moves a category to a new parent. Both source and target must be in\nthe same authorized company. Moving into itself or into a descendant\n(cycle) fails with `Invalid parent`. The moved category gets the next\nsibling `sort` under the new parent.\n",
|
|
||||||
"security": [
|
|
||||||
{
|
|
||||||
"cookieAuth": []
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"x-markdown": "category/move.md",
|
|
||||||
"parameters": [
|
|
||||||
{
|
|
||||||
"in": "path",
|
|
||||||
"name": "id",
|
|
||||||
"required": true,
|
|
||||||
"schema": {
|
|
||||||
"type": "integer"
|
|
||||||
},
|
|
||||||
"description": "Category id to move"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"requestBody": {
|
|
||||||
"required": true,
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"type": "object",
|
|
||||||
"required": [
|
|
||||||
"parentId"
|
|
||||||
],
|
|
||||||
"properties": {
|
|
||||||
"parentId": {
|
|
||||||
"type": "integer",
|
|
||||||
"description": "New parent category id"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"example": {
|
|
||||||
"parentId": 3
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"responses": {
|
|
||||||
"200": {
|
|
||||||
"description": "Moved category",
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"category": {
|
|
||||||
"type": "object",
|
|
||||||
"required": [
|
|
||||||
"id",
|
|
||||||
"parentId",
|
|
||||||
"sort"
|
|
||||||
],
|
|
||||||
"properties": {
|
|
||||||
"id": {
|
|
||||||
"type": "integer"
|
|
||||||
},
|
|
||||||
"parentId": {
|
|
||||||
"type": "integer"
|
|
||||||
},
|
|
||||||
"sort": {
|
|
||||||
"type": "integer"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"400": {
|
|
||||||
"description": "Invalid parent",
|
|
||||||
"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": "Category not found",
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/components/schemas/Error"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"/brand": {
|
"/brand": {
|
||||||
"get": {
|
"get": {
|
||||||
"tags": [
|
"tags": [
|
||||||
|
|||||||
@@ -1,48 +0,0 @@
|
|||||||
# `POST /category/{id}/move`
|
|
||||||
|
|
||||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
|
||||||
|
|
||||||
Move category to a new parent
|
|
||||||
|
|
||||||
Moves a category to a new parent. Both source and target must be in
|
|
||||||
the same authorized company. Moving into itself or into a descendant
|
|
||||||
(cycle) fails with `Invalid parent`. The moved category gets the next
|
|
||||||
sibling `sort` under the new parent.
|
|
||||||
|
|
||||||
|
|
||||||
## Path parameters
|
|
||||||
|
|
||||||
| Param | Required | Type | Description |
|
|
||||||
|-------|----------|------|-------------|
|
|
||||||
| `id` | yes | integer | Category id to move |
|
|
||||||
|
|
||||||
## Body (JSON)
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"parentId": 3
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Response `200`
|
|
||||||
|
|
||||||
Moved category
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"category": { … }
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Errors
|
|
||||||
|
|
||||||
| Status | Description |
|
|
||||||
|--------|-------------|
|
|
||||||
| 400 | Invalid parent — `{"error":"…"}` |
|
|
||||||
| 401 | Unauthorized — `{"error":"…"}` |
|
|
||||||
| 403 | Not authorized — `{"error":"…"}` |
|
|
||||||
| 404 | Category not found — `{"error":"…"}` |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
|
||||||
@@ -530,102 +530,4 @@ export function register(app, basePath = '') {
|
|||||||
res.status(status).json({ error: error.message });
|
res.status(status).json({ error: error.message });
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
/**
|
|
||||||
* @openapi
|
|
||||||
* /category/{id}/move:
|
|
||||||
* post:
|
|
||||||
* tags: [Category]
|
|
||||||
* summary: Move category to a new parent
|
|
||||||
* description: |
|
|
||||||
* Moves a category to a new parent. Both source and target must be in
|
|
||||||
* the same authorized company. Moving into itself or into a descendant
|
|
||||||
* (cycle) fails with `Invalid parent`. The moved category gets the next
|
|
||||||
* sibling `sort` under the new parent.
|
|
||||||
* security:
|
|
||||||
* - cookieAuth: []
|
|
||||||
* x-markdown: category/move.md
|
|
||||||
* parameters:
|
|
||||||
* - in: path
|
|
||||||
* name: id
|
|
||||||
* required: true
|
|
||||||
* schema:
|
|
||||||
* type: integer
|
|
||||||
* description: Category id to move
|
|
||||||
* requestBody:
|
|
||||||
* required: true
|
|
||||||
* content:
|
|
||||||
* application/json:
|
|
||||||
* schema:
|
|
||||||
* type: object
|
|
||||||
* required: [parentId]
|
|
||||||
* properties:
|
|
||||||
* parentId:
|
|
||||||
* type: integer
|
|
||||||
* description: New parent category id
|
|
||||||
* example:
|
|
||||||
* parentId: 3
|
|
||||||
* responses:
|
|
||||||
* 200:
|
|
||||||
* description: Moved category
|
|
||||||
* content:
|
|
||||||
* application/json:
|
|
||||||
* schema:
|
|
||||||
* type: object
|
|
||||||
* properties:
|
|
||||||
* category:
|
|
||||||
* type: object
|
|
||||||
* required: [id, parentId, sort]
|
|
||||||
* properties:
|
|
||||||
* id:
|
|
||||||
* type: integer
|
|
||||||
* parentId:
|
|
||||||
* type: integer
|
|
||||||
* sort:
|
|
||||||
* type: integer
|
|
||||||
* 400:
|
|
||||||
* description: Invalid parent
|
|
||||||
* 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: Category not found
|
|
||||||
* content:
|
|
||||||
* application/json:
|
|
||||||
* schema:
|
|
||||||
* $ref: '#/components/schemas/Error'
|
|
||||||
*/
|
|
||||||
app.post(`${basePath}/category/:id/move`, async (req, res) => {
|
|
||||||
const id = Number(req.params.id);
|
|
||||||
if (!Number.isInteger(id) || id <= 0) {
|
|
||||||
return res.status(400).json({ error: 'id is required' });
|
|
||||||
}
|
|
||||||
|
|
||||||
const parentId = Number(req.body?.parentId);
|
|
||||||
if (!Number.isInteger(parentId) || parentId <= 0) {
|
|
||||||
return res.status(400).json({ error: 'parentId is required' });
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
const category = await db.move({ googleAuthId: req.user.id, id, parentId });
|
|
||||||
res.status(200).json({ category });
|
|
||||||
} catch (error) {
|
|
||||||
const status = categoryErrorStatus(error);
|
|
||||||
if (status === 500) console.error('Move category failed:', error);
|
|
||||||
res.status(status).json({ error: error.message });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user