docs: update comprehensive API documentation and project guides
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
This commit is contained in:
@@ -18,31 +18,31 @@ See [Library API documentation](../libraries/) for more details.
|
||||
|
||||
## Request Body
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
|--------|------|-----------|-------------|
|
||||
| library_id | string (UUID) | Yes | Library UUID to add the media item to |
|
||||
| title | string | Yes | Media item title (1-500 characters) |
|
||||
| author | string | No | Author name |
|
||||
| isbn | string | No | ISBN number |
|
||||
| description | string | No | Description or summary |
|
||||
| file_path | string | Yes | Path to the media file |
|
||||
| file_size | integer | Yes | Size of the file in bytes |
|
||||
| mime_type | string | Yes | MIME type of the file |
|
||||
| cover_image_path | string | No | Path to the cover image |
|
||||
| series | string | No | Series name |
|
||||
| series_number | integer | No | Number in the series |
|
||||
| tags | array of strings | No | Tags (auto-normalized) |
|
||||
| asin | string | No | Amazon ASIN |
|
||||
| date_published | string | No | Publication date |
|
||||
| publisher | string | No | Publisher name |
|
||||
| contributors | array of strings | No | Contributors (auto-normalized) |
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------- | ---------------- | -------- | ------------------------------------- |
|
||||
| library_id | string (UUID) | Yes | Library UUID to add the media item to |
|
||||
| title | string | Yes | Media item title (1-500 characters) |
|
||||
| author | string | No | Author name |
|
||||
| isbn | string | No | ISBN number |
|
||||
| description | string | No | Description or summary |
|
||||
| file_path | string | Yes | Path to the media file |
|
||||
| file_size | integer | Yes | Size of the file in bytes |
|
||||
| mime_type | string | Yes | MIME type of the file |
|
||||
| cover_image_path | string | No | Path to the cover image |
|
||||
| series | string | No | Series name |
|
||||
| series_number | integer | No | Number in the series |
|
||||
| tags | array of strings | No | Tags (auto-normalized) |
|
||||
| asin | string | No | Amazon ASIN |
|
||||
| date_published | string | No | Publication date |
|
||||
| publisher | string | No | Publisher name |
|
||||
| contributors | array of strings | No | Contributors (auto-normalized) |
|
||||
|
||||
## Tag/Contributor Normalization
|
||||
|
||||
Tags and contributors are automatically normalized:
|
||||
|
||||
- **Tags**: Titlecased, punctuation preserved, case-insensitive deduplication
|
||||
- **Contributors**: Original casing and punctuation preserved, case-insensitive deduplication
|
||||
- **Contributors**: Original casing and punctuation preserved, case-insensitive deduplication
|
||||
- **Search fields**: Auto-generated for case-insensitive search
|
||||
|
||||
### Example Request
|
||||
@@ -92,12 +92,12 @@ Tags and contributors are automatically normalized:
|
||||
|
||||
## Error Responses
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 400 | Invalid request data OR library has no folders |
|
||||
| 401 | Invalid or expired token |
|
||||
| 403 | User is not an admin |
|
||||
| 404 | Library not found |
|
||||
| Code | Description |
|
||||
| ---- | ---------------------------------------------- |
|
||||
| 400 | Invalid request data OR library has no folders |
|
||||
| 401 | Invalid or expired token |
|
||||
| 403 | User is not an admin |
|
||||
| 404 | Library not found |
|
||||
|
||||
### 400 - Library Has No Folders
|
||||
|
||||
|
||||
Reference in New Issue
Block a user