john-okeefe
253f56399d
BREAKING CHANGE: Documentation URLs have changed New structure: - user/ - End-user documentation (device setup, sync guides, frontend) - developer/ - Developer documentation (API reference, protocols, specs) - operations/ - Operations documentation (deployment, troubleshooting) - contributing/ - Contribution guides Changes: - Created portal INDEX.md files for each audience section - Moved device guides to user/devices/ (kobo-setup.md, koreader-setup.md) - Moved API docs to developer/ (api-reference.md, collections-api.md) - Moved sync guide to user/sync-guide.md - Moved troubleshooting to operations/troubleshooting.md - Moved all split API docs to developer/api/ - Renamed protocol files (kobo-protocol.md, koreader-protocol.md) - Added placeholder user guides (frontend, user-areas, settings, admin) - Updated all internal links to new paths - Updated Go code (http_handler.go, navigation.go) for new paths - Updated main INDEX.md for audience-based navigation Benefits: - Clear separation of user and developer documentation - Scalable structure for future user guide expansion - Better organization and discoverability - Audience-specific landing pages Related to DOCS_IMPLEMENTATION_PLAN.md Phase 2 completion
80 lines
1.7 KiB
Markdown
80 lines
1.7 KiB
Markdown
# API Documentation
|
|
|
|
Complete reference for Bookhoard REST API endpoints.
|
|
|
|
## Quick Links
|
|
|
|
- [Authentication](authentication/) - User registration, login, tokens
|
|
- [Users](users/) - Profile management
|
|
- [Libraries](libraries/) - Library management
|
|
- [Media Items](media-items/) - Book/ebook operations
|
|
- [Progress](progress/) - Reading progress tracking
|
|
- [Notes](notes/) - User notes management
|
|
- [Highlights](highlights/) - Book highlights
|
|
- [Ratings](ratings/) - Book ratings
|
|
- [Devices](devices/) - Device registration and sync
|
|
- [Analytics](analytics/) - Usage statistics
|
|
- [Book Matching](book-matching/) - Search and link books
|
|
- [Collections](collections/) - See [Collections API](../collections-api.md)
|
|
- [OPDS](opds/) - Open Publication Distribution
|
|
- [Sync Protocols](sync/) - KOReader and Kobo sync
|
|
- [WebSocket](websocket/) - Real-time sync events
|
|
|
|
---
|
|
|
|
## Authentication
|
|
|
|
See [Authentication Endpoints](authentication/)
|
|
|
|
## Users & Profiles
|
|
|
|
See [User Management](users/)
|
|
|
|
## Libraries
|
|
|
|
See [Library Management](libraries/)
|
|
|
|
## Media Items
|
|
|
|
See [Media Item Operations](media-items/)
|
|
|
|
## Reading Progress
|
|
|
|
See [Progress Tracking](progress/)
|
|
|
|
## Notes & Highlights
|
|
|
|
See [Notes Management](notes/) and [Highlights Management](highlights/)
|
|
|
|
## Ratings
|
|
|
|
See [Ratings System](ratings/)
|
|
|
|
## Device Management
|
|
|
|
See [Device Registration & Sync](devices/)
|
|
|
|
## Analytics
|
|
|
|
See [Usage Analytics](analytics/)
|
|
|
|
## Book Matching & Linking
|
|
|
|
See [Book Matching](book-matching/)
|
|
|
|
## Collections
|
|
|
|
See [Collections API](../collections-api.md) or [Collections Endpoints](collections/)
|
|
|
|
## OPDS
|
|
|
|
See [OPDS Feeds](opds/)
|
|
|
|
## Sync Protocols
|
|
|
|
See [KOReader Sync](sync/) and [Kobo Sync](sync/)
|
|
|
|
## WebSocket
|
|
|
|
See [WebSocket Protocol](websocket/)
|