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.8 KiB

Raw Blame History

Sync Progress

Sync reading progress from KOReader device.

Endpoint: POST /api/sync/koreader/progress Auth: Required (Device authentication)

Device Authentication

This endpoint requires device authentication (not user JWT). Devices authenticate using their device credentials.

Request Body

Field	Type	Required	Description
device_id	string (UUID)	Yes	Device UUID
progress	array	Yes	Array of progress objects

Progress Object

Field	Type	Required	Description
book	string	Yes	Book identifier (filename or UUID)
percent	float	Yes	Progress percentage (0-100)
page	integer	No	Current page number
total_pages	integer	No	Total pages in document
date_read	string	No	ISO 8601 timestamp of last read
updated_at	string	Yes	ISO 8601 timestamp

Example Request

{
  "device_id": "550e8400-e29b-41d4-a716-446655440000",
  "progress": [
    {
      "book": "book.epub",
      "percent": 75.5,
      "page": 150,
      "total_pages": 200,
      "date_read": "2026-02-08T10:00:00Z",
      "updated_at": "2026-02-08T10:00:00Z"
    }
  ]
}

Response (200 OK)

{
  "message": "Progress synced successfully",
  "synced_count": 1
}

Error Responses

Code	Description
401	Device authentication failed
400	Invalid request data
404	Device not found

1.8 KiB Raw Blame History