This commit is contained in:
seb
2026-10-14 00:08:11 +02:00
parent 11f6a8fc0f
commit 74b24686bc
14 changed files with 962 additions and 12 deletions

View File

@@ -88,6 +88,8 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route
| [`routes/auth/logout.md`](routes/auth/logout.md) | `POST /auth/logout` |
| [`routes/auth/me.md`](routes/auth/me.md) | `GET /auth/me` |
| [`routes/auth/selected-company.md`](routes/auth/selected-company.md) | `PUT /auth/selected-company` |
| [`routes/backup.md`](routes/backup.md) | `GET /backup` |
| [`routes/backup/run.md`](routes/backup/run.md) | `POST /backup/run` |
| [`routes/brand/list.md`](routes/brand/list.md) | `GET /brand` |
| [`routes/brand/create.md`](routes/brand/create.md) | `POST /brand` |
| [`routes/brand/delete.md`](routes/brand/delete.md) | `DELETE /brand/{id}` |

View File

@@ -1,6 +1,6 @@
# Dash API Routes Overview (All)
Overview of all 229 API endpoints across all modules.
Overview of all 231 API endpoints across all modules.
### Notation
@@ -249,6 +249,15 @@ _none_
- Params: `body: { companyId: int }`
- Returns: `200 { user: T41 }`
### Section: /backup
#### List backups and service status — `GET /backup`
_none_
- Returns: `200 { status: {}, backups: {} }`
#### Trigger manual backup — `POST /backup/run`
_none_
- Returns: `200 {}`
### Section: /brand
#### List brands — `GET /brand`

View File

@@ -1,6 +1,6 @@
# Dash API Routes Overview
Overview of all 182 API endpoints across all modules.
Overview of all 184 API endpoints across all modules.
### Notation
@@ -232,6 +232,15 @@ _none_
_none_
- Returns: `200 { message: str }`
### Section: /backup
#### List backups and service status — `GET /backup`
_none_
- Returns: `200 { status: {}, backups: {} }`
#### Trigger manual backup — `POST /backup/run`
_none_
- Returns: `200 {}`
### Section: /brand
#### List brands — `GET /brand`

28
docs/api/routes/backup.md Normal file
View File

@@ -0,0 +1,28 @@
# `GET /backup`
Protected. Requires a valid session cookie (`credentials: 'include'`).
List backups and service status
Retrieves the current status of the internal backup service and lists available hourly, daily, and monthly backups.
## Response `200`
Backup service status and listing
```json
{
"status": {},
"backups": {}
}
```
## Errors
| Status | Description |
|--------|-------------|
| 500 | Internal error |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._

View File

@@ -0,0 +1,25 @@
# `POST /backup/run`
Protected. Requires a valid session cookie (`credentials: 'include'`).
Trigger manual backup
Immediately triggers an on-demand backup snapshot of VFS, storage, and SQLite database.
## Response `200`
Backup triggered successfully
```json
{}
```
## Errors
| Status | Description |
|--------|-------------|
| 500 | Backup execution failure |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._