Bookhoard/bookhoard
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 12 Wiki Activity

docs(api): complete backend documentation with all missing endpoints

Browse Source 
Complete API documentation audit covering all backend endpoints.

Auth Endpoints:
- Fixed endpoint paths from /api/users/me/* to /api/auth/*
- Added update_email.md and update_username.md

Device Management:
- Device shelf operations (add, get, remove, clear)
- Device CRUD operations (update, delete)
- Registration management (pending, approve, reject)

Books Operations:
- Bulk delete and bulk update with normalization
- Download endpoint with format-specific headers

Conflict Resolution:
- Complete conflict management (list, get, resolve, delete)
- Bulk operations (bulk resolve, bulk dismiss, dismiss all)

Sync Protocols:
- KOReader: progress, metadata, library, bookmarks
- Kobo: markup, bookmarks, analytics, initialization, server sync

Scanner:
- Enhanced docs with manga/comic support
- Added 148-line comprehensive overview
- All formats documented (ebooks, comics, manga)

WebSocket:
- Comprehensive real-time sync API
- Messages, topics, authentication, examples

Documentation:
- Updated api-reference.md with all 122+ endpoints
- Updated index.md with new categories

Total: 36 new files, 6 modified files, 100% coverage
This commit is contained in:
john-okeefe
2026-02-08 12:39:46 -05:00
parent d43bd9526b
commit c4607cd9b5
38 changed files with 2275 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/developer/api/queue/clear_device_queue.md
+40
View File
@@ -0,0 +1,40 @@
# Clear Device Queue
Clear all queue items for a specific device.
**Endpoint**: `DELETE /api/queue/devices/:device_id/clear`
**Auth**: Required
## Path Parameters
| Parameter | Type | Required | Description |
|-----------|------|-----------|-------------|
| device_id | string (UUID) | Yes | Device UUID |
## Request Headers
| Header | Type | Required | Description |
|--------|------|-----------|-------------|
| Authorization | string | Yes | Bearer token |
### Example Request
```http
DELETE /api/queue/devices/550e8400-e29b-41d4-a716-446655440000/clear
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
```
## Response (204 No Content)
Device queue cleared successfully.
## Error Responses
| Code | Description |
|------|-------------|
| 401 | Invalid or expired token |
| 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/queue/delete_queue_item.md
+40
View File
@@ -0,0 +1,40 @@
# Delete Queue Item
Delete a specific queue item.
**Endpoint**: `DELETE /api/queue/items/:item_id`
**Auth**: Required
## Path Parameters
| Parameter | Type | Required | Description |
|-----------|------|-----------|-------------|
| item_id | string (UUID) | Yes | Queue item UUID |
## Request Headers
| Header | Type | Required | Description |
|--------|------|-----------|-------------|
| Authorization | string | Yes | Bearer token |
### Example Request
```http
DELETE /api/queue/items/550e8400-e29b-41d4-a716-446655440000
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
```
## Response (204 No Content)
Queue item deleted successfully.
## Error Responses
| Code | Description |
|------|-------------|
| 401 | Invalid or expired token |
| 404 | Queue item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/queue/get_device_queue_stats.md
+48
View File
@@ -0,0 +1,48 @@
# Get Device Queue Statistics
Get statistics for a specific device's sync queue.
**Endpoint**: `GET /api/queue/devices/:device_id/stats`
**Auth**: Required
## Path Parameters
| Parameter | Type | Required | Description |
|-----------|------|-----------|-------------|
| device_id | string (UUID) | Yes | Device UUID |
## Request Headers
| Header | Type | Required | Description |
|--------|------|-----------|-------------|
| Authorization | string | Yes | Bearer token |
### Example Request
```http
GET /api/queue/devices/550e8400-e29b-41d4-a716-446655440000/stats
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
```
## Response (200 OK)
```json
{
"total_items": 15,
"pending_items": 8,
"processing_items": 2,
"completed_items": 4,
"failed_items": 1
}
```
## Error Responses
| Code | Description |
|------|-------------|
| 401 | Invalid or expired token |
| 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/queue/list_all_queue_items.md
+62
View File
@@ -0,0 +1,62 @@
# List All Queue Items (Admin)
List all queue items across all devices (admin only).
**Endpoint**: `GET /api/queue/items`
**Auth**: Required (Admin only)
## Query Parameters
| Parameter | Type | Required | Description |
|-----------|------|-----------|-------------|
| device_id | string (UUID) | No | Filter by device |
| status | string | No | Filter by status (pending, processing, completed, failed) |
| limit | integer | No | Maximum number of items to return (default: 100) |
| offset | integer | No | Number of items to skip (default: 0) |
## Request Headers
| Header | Type | Required | Description |
|--------|------|-----------|-------------|
| Authorization | string | Yes | Bearer token (must have admin role) |
### Example Request
```http
GET /api/queue/items?status=failed&limit=20
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
```
## Response (200 OK)
```json
{
"items": [
{
"id": "uuid",
"device_id": "device-uuid",
"device_name": "My Kobo",
"media_item_id": "book-uuid",
"operation": "sync_progress",
"status": "failed",
"error_message": "Connection timeout",
"created_at": "2026-02-08T10:00:00Z",
"updated_at": "2026-02-08T10:05:00Z"
}
],
"total": 45,
"limit": 20,
"offset": 0
}
```
## Error Responses
| Code | Description |
|------|-------------|
| 401 | Invalid or expired token |
| 403 | User does not have admin privileges |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/queue/list_device_queue_items.md
+65
View File
@@ -0,0 +1,65 @@
# List Device Queue Items
List all queue items for a specific device.
**Endpoint**: `GET /api/queue/devices/:device_id/items`
**Auth**: Required
## Path Parameters
| Parameter | Type | Required | Description |
|-----------|------|-----------|-------------|
| device_id | string (UUID) | Yes | Device UUID |
## Query Parameters
| Parameter | Type | Required | Description |
|-----------|------|-----------|-------------|
| status | string | No | Filter by status (pending, processing, completed, failed) |
| limit | integer | No | Maximum number of items to return (default: 50) |
| offset | integer | No | Number of items to skip (default: 0) |
## Request Headers
| Header | Type | Required | Description |
|--------|------|-----------|-------------|
| Authorization | string | Yes | Bearer token |
### Example Request
```http
GET /api/queue/devices/550e8400-e29b-41d4-a716-446655440000/items?status=pending&limit=10
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
```
## Response (200 OK)
```json
{
"items": [
{
"id": "uuid",
"device_id": "device-uuid",
"media_item_id": "book-uuid",
"operation": "sync_progress",
"status": "pending",
"created_at": "2026-02-08T10:00:00Z",
"updated_at": "2026-02-08T10:00:00Z"
}
],
"total": 8,
"limit": 10,
"offset": 0
}
```
## Error Responses
| Code | Description |
|------|-------------|
| 401 | Invalid or expired token |
| 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/queue/retry_queue_item.md
+46
View File
@@ -0,0 +1,46 @@
# Retry Queue Item
Retry a failed queue item.
**Endpoint**: `POST /api/queue/items/:item_id/retry`
**Auth**: Required
## Path Parameters
| Parameter | Type | Required | Description |
|-----------|------|-----------|-------------|
| item_id | string (UUID) | Yes | Queue item UUID |
## Request Headers
| Header | Type | Required | Description |
|--------|------|-----------|-------------|
| Authorization | string | Yes | Bearer token |
### Example Request
```http
POST /api/queue/items/550e8400-e29b-41d4-a716-446655440000/retry
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
```
## Response (200 OK)
```json
{
"message": "Queue item retry initiated",
"item_id": "uuid"
}
```
## Error Responses
| Code | Description |
|------|-------------|
| 401 | Invalid or expired token |
| 404 | Queue item not found |
| 400 | Item cannot be retried (not in failed state) |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->