docs: auto-generate API route documentation
Signed-off-by: NotAShelf <raf@notashelf.dev> Change-Id: Id0d1f9769b7ccdbf83d5fa78adef62e46a6a6964
This commit is contained in:
parent
9d58927cb4
commit
934691c0f9
40 changed files with 17444 additions and 1 deletions
27
docs/api/backup.md
Normal file
27
docs/api/backup.md
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
# Backup
|
||||
|
||||
Database backup
|
||||
|
||||
## Endpoints
|
||||
|
||||
### POST /api/v1/admin/backup
|
||||
|
||||
Create a database backup and return it as a downloadable file.
|
||||
POST /api/v1/admin/backup
|
||||
|
||||
For `SQLite`: creates a backup via VACUUM INTO and returns the file.
|
||||
For `PostgreSQL`: returns unsupported error (use `pg_dump` instead).
|
||||
|
||||
**Authentication:** Required (Bearer JWT)
|
||||
|
||||
#### Responses
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 200 | Backup file download |
|
||||
| 401 | Unauthorized |
|
||||
| 403 | Forbidden |
|
||||
| 500 | Internal server error |
|
||||
|
||||
---
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue