NotAShelf/pinakes
1
0
Fork 0
Code Issues 6 Pull requests Projects Releases Packages Wiki Activity Actions

docs: auto-generate API route documentation

Browse source 
Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: Id0d1f9769b7ccdbf83d5fa78adef62e46a6a6964
This commit is contained in:
raf 2026-03-21 02:18:48 +03:00
commit 934691c0f9
Signed by: NotAShelf
GPG key ID: 29D95B64378DB4BF
40 changed files with 17444 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

99
docs/api/integrity.md Normal file
View file

@ -0,0 +1,99 @@
# Integrity
Library integrity checks and repairs
## Endpoints
### POST /api/v1/admin/integrity/orphans/detect
**Authentication:** Required (Bearer JWT)
#### Responses
| Status | Description |
|--------|-------------|
| 200 | Orphan detection job submitted |
| 401 | Unauthorized |
| 403 | Forbidden |
| 500 | Internal server error |
---
### POST /api/v1/admin/integrity/orphans/resolve
**Authentication:** Required (Bearer JWT)
#### Request Body
`Content-Type: application/json`
See `docs/api/openapi.json` for the full schema.
#### Responses
| Status | Description |
|--------|-------------|
| 200 | Orphans resolved |
| 401 | Unauthorized |
| 403 | Forbidden |
| 500 | Internal server error |
---
### POST /api/v1/admin/integrity/thumbnails/cleanup
**Authentication:** Required (Bearer JWT)
#### Responses
| Status | Description |
|--------|-------------|
| 200 | Thumbnail cleanup job submitted |
| 401 | Unauthorized |
| 403 | Forbidden |
| 500 | Internal server error |
---
### POST /api/v1/admin/integrity/thumbnails/generate
**Authentication:** Required (Bearer JWT)
#### Request Body
`Content-Type: application/json`
See `docs/api/openapi.json` for the full schema.
#### Responses
| Status | Description |
|--------|-------------|
| 200 | Thumbnail generation job submitted |
| 401 | Unauthorized |
| 403 | Forbidden |
| 500 | Internal server error |
---
### POST /api/v1/admin/integrity/verify
**Authentication:** Required (Bearer JWT)
#### Request Body
`Content-Type: application/json`
See `docs/api/openapi.json` for the full schema.
#### Responses
| Status | Description |
|--------|-------------|
| 200 | Integrity verification job submitted |
| 401 | Unauthorized |
| 403 | Forbidden |
| 500 | Internal server error |
---