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

Raw Permalink Blame History

Get Metadata

Get metadata for a book from KOReader device.

Endpoint: GET /api/sync/koreader/metadata/:uuid Auth: Required (Device authentication)

Path Parameters

Parameter	Type	Required	Description
uuid	string (UUID)	Yes	Book UUID

Device Authentication

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

Request Headers

Header	Type	Required	Description
X-Device-ID	string	Yes	Device UUID
X-Device-Key	string	Yes	Device authentication key

Example Request

GET /api/sync/koreader/metadata/550e8400-e29b-41d4-a716-446655440000
X-Device-ID: 550e8400-e29b-41d4-a716-446655440000
X-Device-Key: device-auth-key

Response (200 OK)

{
  "id": "uuid",
  "title": "Book Title",
  "authors": ["Author Name"],
  "path": "/path/to/book.epub",
  "file_size": 1234567,
  "modified_at": "2026-02-08T10:00:00Z"
}

Error Responses

Code	Description
401	Device authentication failed
404	Book or device not found

1.3 KiB Raw Permalink Blame History