Bookhoard/bookhoard
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 12 Wiki Activity

docs: update search API documentation with unified endpoint

Browse Source 
- Update search_media_items.md with comprehensive fuzzy filter documentation
- Document all filter parameters (author_filter, series_filter, genre_filter, language_filter)
- Document autocomplete parameters (authors, genres, series, languages)
- Add fuzzy search examples (asimov → Asimov, Isaac)
- Add exact match with quotes examples ("Foundation and Empire")
- Add combined search + filters examples
- Add field-specific search examples for autocomplete
- Document error responses (400, 401, 404)
- Remove deprecated filter_sort_media_items.md (functionality moved to search endpoint)
- Update api-reference.md to reflect unified endpoint
- Update api/api-reference.md to reflect unified endpoint

All text filters use pg_trgm fuzzy matching (threshold: 0.3) except years/booleans which are exact.
This commit is contained in:
john-okeefe
2026-03-23 22:38:23 -04:00
parent 08b32c7b30
commit 06800b9a27
4 changed files with 137 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/developer/api/api-reference.md
-1
View File
@@ -80,7 +80,6 @@ See [Library Management](libraries/)
See [Media Item Operations](media-items/)
- GET /api/media-items - List media items
- GET /api/media-items/filtered - Filter and sort media items
- GET /api/media-items/:id - Get media item details
- POST /api/media-items/bulk-delete - Bulk delete media items
- POST /api/media-items/bulk-update - Bulk update media items (tags/contributors with normalization)