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

2.1 KiB

Raw Blame History

Update Media Item

Update media item metadata (Admin only).

Endpoint: PUT /api/media-items/{media_id} Auth: Required (Admin only) Content-Type: application/json

Path Parameters

Parameter	Type	Required	Description
media_id	string	Yes	Media item UUID

Request Body

Field	Type	Required	Description
title	string	No	Updated title
author	string	No	Updated author
description	string	No	Updated description
series	string	No	Series name
series_number	integer	No	Number in series
tags	array of string	No	Updated tags (auto-normalized)
contributors	array of string	No	Updated contributors (auto-normalized)

Tag/Contributor Normalization:

Tags are titlecased and deduplicated (case-insensitive)
Contributors preserve original casing and punctuation
Punctuation-preferred deduplication (keeps "ACME CORP." over "acme corp")
Search fields auto-generated for case-insensitive search

Example Request

{
  "title": "Updated Title",
  "author": "Updated Author",
  "description": "Updated description",
  "series": "Series",
  "series_number": 2
}

Response (200 OK)

{
  "id": "uuid",
  "title": "Updated Title",
  "author": "Updated Author",
  "description": "Updated description",
  "series": "Series",
  "series_number": 2,
  "updated_at": "2026-01-31T10:00:00Z"
}

Error Responses

Code	Description
400	Invalid input data
401	Invalid or expired token
403	User is not an admin
404	Media item not found

2.1 KiB Raw Blame History