Files

T

john-okeefe 4d321528b2 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

2026-02-27 17:06:22 -05:00

1.4 KiB

Raw Blame History

Bulk Link Books

Link multiple books to media items at once.

Endpoint: POST /api/sync/bulk-link-books Auth: Required Content-Type: application/json

Request Body

Field	Type	Required	Description
links	array	Yes	Array of book-media link objects

Each link object contains:

Field	Type	Required	Description
device_id	string (UUID)	Yes	Device UUID
book_id	string (UUID)	Yes	Book ID from device
media_item_id	string (UUID)	Yes	Media item UUID to link to

Example Request

{
  "links": [
    {
      "device_id": "550e8400-e29b-41d4-a716-446655440000",
      "book_id": "book-123",
      "media_item_id": "660e8400-e29b-41d4-a716-446655440001"
    },
    {
      "device_id": "550e8400-e29b-41d4-a716-446655440000",
      "book_id": "book-456",
      "media_item_id": "770e8400-e29b-41d4-a716-446655440002"
    }
  ]
}

Response (200 OK)

{
  "message": "Books linked successfully",
  "linked_count": 2,
  "failed_count": 0
}

Error Responses

Code	Description
400	Invalid request data
401	Invalid or expired token
404	Device, book, or media item not found

1.4 KiB Raw Blame History