john-okeefe
4d321528b2
This commit updates all documentation files throughout the project: - Updated IMPLEMENTATION_PLAN.md with new implementation details - Updated PROJECT_GUIDELINES.md with coding standards and practices - Updated README.md with current project information - Updated SCREENSHOT_AUTOMATION.md with new automation details - Added TEST_DATA.md with test fixtures data - Updated cover_image_serving_plan.md with static URL patterns Documentation API updates: - Updated API reference documentation for all endpoints including: - Authentication (login, logout, register, refresh_token) - Book matching (auto_link, bulk_link, link_book, search) - Collections (CRUD operations, shelf mappings, auto-assign rules) - Conflicts (bulk operations, resolve/dismiss) - Devices (registration, approval, shelf management) - Highlights (create, update, delete, get) - Kobo sync (bookmark, markup, initialization, sync) - KOReader sync (library, metadata, bookmarks, progress) - Libraries (CRUD, folders, media items, stats) - Media items (bulk operations, CRUD) - Notes (CRUD operations) - OPDS (acquisition, feeds, publication) - Progress (reading progress tracking) - Queue (device queue management) - Ratings (star ratings) - Scanner (watch mode, scan operations) - Sync protocols (Kobo, KOReader) - Users (profile, password, admin operations) - WebSocket protocols - Updated user guides (admin, dashboard, settings, sync) - Updated device setup guides (Kobo, KOReader) - Updated developer guides (testing, contributing, operations) - Updated scripts/README.md
97 lines
3.1 KiB
Markdown
97 lines
3.1 KiB
Markdown
# Create Collection
|
|
|
|
Create a new collection.
|
|
|
|
**Endpoint**: `POST /api/collections`
|
|
**Auth**: Required
|
|
**Content-Type**: `application/json`
|
|
|
|
## Request Body
|
|
|
|
| Field | Type | Required | Description |
|
|
| ----------------- | ------ | -------- | -------------------------------- |
|
|
| name | string | Yes | Collection name (max 255 chars) |
|
|
| description | string | No | Collection description |
|
|
| color | string | No | Hex color code (e.g., "#FF5733") |
|
|
| icon | string | No | Emoji icon (e.g., "🚀", "📖") |
|
|
| auto_assign_rules | array | No | Array of rule objects |
|
|
| view_settings | object | No | Per-device display preferences |
|
|
|
|
### Auto-Assign Rule Object
|
|
|
|
| Field | Type | Required | Description |
|
|
| -------- | ------------- | -------- | ----------------------------------------------------------------------------------------------------------------- |
|
|
| field | string | Yes | Field to match on (genre, author, series, language, publisher, copyright_year, tags) |
|
|
| operator | string | Yes | Comparison operator (equals, not_equals, contains, not_contains, starts_with, ends_with, greater_than, less_than) |
|
|
| value | string/number | Yes | Value to compare against |
|
|
| priority | integer | No | Rule priority (1 = highest, default: 1) |
|
|
| enabled | boolean | No | Whether rule is active (default: true) |
|
|
|
|
### Example Request
|
|
|
|
```json
|
|
{
|
|
"name": "To Read",
|
|
"description": "Books I want to read soon",
|
|
"color": "#00FF00",
|
|
"icon": "📖",
|
|
"auto_assign_rules": [
|
|
{
|
|
"field": "tags",
|
|
"operator": "contains",
|
|
"value": "to-read",
|
|
"priority": 1,
|
|
"enabled": true
|
|
}
|
|
],
|
|
"view_settings": {
|
|
"kobo": {
|
|
"view_mode": "grid"
|
|
},
|
|
"koreader": {
|
|
"view_mode": "list"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## Response (201 Created)
|
|
|
|
```json
|
|
{
|
|
"id": "550e8400-e29b-41d4-a716-446655440000",
|
|
"name": "To Read",
|
|
"description": "Books I want to read soon",
|
|
"color": "#00FF00",
|
|
"icon": "📖",
|
|
"auto_assign_rules": [
|
|
{
|
|
"field": "tags",
|
|
"operator": "contains",
|
|
"value": "to-read",
|
|
"priority": 1,
|
|
"enabled": true
|
|
}
|
|
],
|
|
"view_settings": {
|
|
"kobo": {
|
|
"view_mode": "grid"
|
|
},
|
|
"koreader": {
|
|
"view_mode": "list"
|
|
}
|
|
},
|
|
"created_at": "2026-02-01T10:00:00Z"
|
|
}
|
|
```
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
| ---- | ----------------------------------- |
|
|
| 400 | Invalid request (validation failed) |
|
|
| 401 | Authentication required |
|
|
| 500 | Internal server error |
|
|
|
|
## Try It Out
|