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

Raw Permalink Blame History

Update Collection

Update collection details.

Endpoint: PUT /api/collections/{id} Auth: Required Content-Type: application/json

Path Parameters

Parameter	Type	Required	Description
id	string (UUID)	Yes	Collection UUID

Request Body

All fields are optional. Include only fields you want to update.

Field	Type	Required	Description
name	string	No	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 (replaces existing rules)
view_settings	object	No	Per-device display preferences

Example Request

{
  "name": "Sci-Fi Favorites",
  "description": "Updated description",
  "color": "#7aa2f7",
  "icon": "🌟"
}

Response (200 OK)

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Sci-Fi Favorites",
  "description": "Updated description",
  "color": "#7aa2f7",
  "icon": "🌟",
  "auto_assign_rules": [],
  "view_settings": {},
  "created_at": "2026-02-01T10:00:00Z"
}

Error Responses

Code	Description
400	Invalid request (validation failed)
401	Authentication required
404	Collection not found
500	Internal server error

1.9 KiB Raw Permalink Blame History