docs: auto-generate API route documentation

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 7a0a009ced
Signed by: NotAShelf
GPG key ID: 29D95B64378DB4BF
40 changed files with 17444 additions and 1 deletions

86
docs/api/transcode.md Normal file
View file

@ -0,0 +1,86 @@
# Transcode
Video transcoding sessions
## Endpoints
### POST /api/v1/media/{id}/transcode
**Authentication:** Required (Bearer JWT)
#### Parameters
| Name | In | Required | Description |
|------|----|----------|-------------|
| `id` | path | Yes | Media item ID |
#### Request Body
`Content-Type: application/json`
See `docs/api/openapi.json` for the full schema.
#### Responses
| Status | Description |
|--------|-------------|
| 200 | Transcode job submitted |
| 400 | Bad request |
| 401 | Unauthorized |
| 500 | Internal server error |
---
### GET /api/v1/transcode
**Authentication:** Required (Bearer JWT)
#### Responses
| Status | Description |
|--------|-------------|
| 200 | List of transcode sessions |
| 401 | Unauthorized |
---
### GET /api/v1/transcode/{id}
**Authentication:** Required (Bearer JWT)
#### Parameters
| Name | In | Required | Description |
|------|----|----------|-------------|
| `id` | path | Yes | Transcode session ID |
#### Responses
| Status | Description |
|--------|-------------|
| 200 | Transcode session details |
| 401 | Unauthorized |
| 404 | Not found |
---
### DELETE /api/v1/transcode/{id}
**Authentication:** Required (Bearer JWT)
#### Parameters
| Name | In | Required | Description |
|------|----|----------|-------------|
| `id` | path | Yes | Transcode session ID |
#### Responses
| Status | Description |
|--------|-------------|
| 200 | Transcode session cancelled |
| 401 | Unauthorized |
| 404 | Not found |
---