Bookhoard/bookhoard

Files

T

john-okeefe 67bd90feec docs: create API documentation index and structure

Phase 2 part 1: Add API documentation landing page
- Create docs/api/INDEX.md with quick links
- Organize by category (auth, users, libraries, media items, etc.)
- Provide navigation to all API endpoint documentation
- Link to COLLECTIONS_API.md for collections details

2026-02-02 08:51:37 -05:00

1.7 KiB

Raw Blame History

API Documentation

Complete reference for Bookhoard REST API endpoints.

Quick Links

Authentication - User registration, login, tokens
Users - Profile management
Libraries - Library management
Media Items - Book/ebook operations
Progress - Reading progress tracking
Notes - User notes management
Highlights - Book highlights
Ratings - Book ratings
Devices - Device registration and sync
Analytics - Usage statistics
Book Matching - Search and link books
Collections - See COLLECTIONS_API.md
OPDS - Open Publication Distribution
Sync Protocols - KOReader and Kobo sync
WebSocket - Real-time sync events

Authentication

See Authentication Endpoints

Users & Profiles

See User Management

Libraries

See Library Management

Media Items

See Media Item Operations

Reading Progress

See Progress Tracking

Notes & Highlights

See Notes Management and Highlights Management

Ratings

See Ratings System

Device Management

See Device Registration & Sync

Analytics

See Usage Analytics

Book Matching & Linking

See Book Matching

Collections

See Collections API or Collections Endpoints

OPDS

Sync Protocols

See KOReader Sync and Kobo Sync

WebSocket

See WebSocket Protocol