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

docs: update comprehensive API documentation and project guides

Browse Source 
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
This commit is contained in:
john-okeefe
2026-02-27 17:06:22 -05:00
parent 6562b20ee5
commit 4d321528b2
154 changed files with 2817 additions and 2152 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/developer/api/users/change_password.md
+16 -15
View File
@@ -3,6 +3,7 @@
Change user password. Supports both self-service and admin modes.
**Endpoints**:
- Self-service: `PUT /api/auth/password`
- Admin reset: `PUT /api/auth/password/:id`
@@ -15,11 +16,11 @@ Users can change their own password by providing current password verification.
### Request Body
| Field | Type | Required | Description |
|--------|------|-----------|-------------|
| current_password | string | Yes | Current password for verification |
| new_password | string | Yes | New password (min 8 chars, complexity required) |
| confirm_password | string | Yes | Must match new_password |
| Field | Type | Required | Description |
| ---------------- | ------ | -------- | ----------------------------------------------- |
| current_password | string | Yes | Current password for verification |
| new_password | string | Yes | New password (min 8 chars, complexity required) |
| confirm_password | string | Yes | Must match new_password |
### Example Request
@@ -39,10 +40,10 @@ Admins can reset any user's password without knowing the current password.
### Request Body (Admin Mode)
| Field | Type | Required | Description |
|--------|------|-----------|-------------|
| new_password | string | Yes | New password (min 8 chars, complexity required) |
| confirm_password | string | Yes | Must match new_password |
| Field | Type | Required | Description |
| ---------------- | ------ | -------- | ----------------------------------------------- |
| new_password | string | Yes | New password (min 8 chars, complexity required) |
| confirm_password | string | Yes | Must match new_password |
### Example Admin Request
@@ -63,9 +64,9 @@ Admins can reset any user's password without knowing the current password.
## Error Responses
| Code | Description |
|------|-------------|
| 400 | Invalid input, weak password, or passwords don't match |
| 401 | Current password is incorrect (self-service mode) |
| 403 | Admin access required (admin mode only) |
| 404 | User not found (admin mode only) |
| Code | Description |
| ---- | ------------------------------------------------------ |
| 400 | Invalid input, weak password, or passwords don't match |
| 401 | Current password is incorrect (self-service mode) |
| 403 | Admin access required (admin mode only) |
| 404 | User not found (admin mode only) |
docs/developer/api/users/delete_user.md
+7 -6
View File
@@ -3,6 +3,7 @@
Delete a user account. Supports both self-deletion and admin deletion.
**Endpoints**:
- Self-deletion: `DELETE /api/auth/profile`
- Admin deletion: `DELETE /api/auth/profile/:id`
@@ -32,12 +33,12 @@ Admins can delete any user account by providing the user ID in the URL.
## Error Responses
| Code | Description |
|------|-------------|
| 400 | Cannot delete the last admin |
| 401 | Invalid or expired token |
| 403 | Admin access required (trying to delete another user) |
| 404 | User not found (admin mode only) |
| Code | Description |
| ---- | ----------------------------------------------------- |
| 400 | Cannot delete the last admin |
| 401 | Invalid or expired token |
| 403 | Admin access required (trying to delete another user) |
| 404 | User not found (admin mode only) |
## Safety Rules
docs/developer/api/users/get_profile.md
+6 -6
View File
@@ -7,9 +7,9 @@ Retrieve the current authenticated user's profile.
## Request Headers
| Header | Type | Required | Description |
|--------|------|-----------|-------------|
| Authorization | string | Yes | Bearer token |
| Header | Type | Required | Description |
| ------------- | ------ | -------- | ------------ |
| Authorization | string | Yes | Bearer token |
### Example Request
@@ -36,6 +36,6 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
## Error Responses
| Code | Description |
|------|-------------|
| 401 | Invalid or expired token |
| Code | Description |
| ---- | ------------------------ |
| 401 | Invalid or expired token |
docs/developer/api/users/update_profile.md
+18 -17
View File
@@ -3,6 +3,7 @@
Update user profile information. Supports both self-edit and admin modes.
**Endpoints**:
- Self-edit: `PUT /api/auth/profile`
- Admin edit: `PUT /api/auth/profile/:id`
@@ -15,13 +16,13 @@ Users can update their own profile. All fields are optional.
### Request Body
| Field | Type | Required | Description |
|--------|------|-----------|-------------|
| username | string | No | New username (must be unique, 3-50 chars) |
| email | string | No | New email (must be unique, valid format) |
| first_name | string | No | User's first name |
| last_name | string | No | User's last name |
| theme | string | No | Theme preference |
| Field | Type | Required | Description |
| ---------- | ------ | -------- | ----------------------------------------- |
| username | string | No | New username (must be unique, 3-50 chars) |
| email | string | No | New email (must be unique, valid format) |
| first_name | string | No | User's first name |
| last_name | string | No | User's last name |
| theme | string | No | Theme preference |
### Example Request
@@ -43,9 +44,9 @@ Admins can update any user by providing the user ID in the URL. Additionally sup
### Additional Request Body Fields (Admin Only)
| Field | Type | Required | Description |
|--------|------|-----------|-------------|
| role | string | No | New role: "user" or "admin" |
| Field | Type | Required | Description |
| ----- | ------ | -------- | --------------------------- |
| role | string | No | New role: "user" or "admin" |
### Example Admin Request
@@ -75,10 +76,10 @@ Admins can update any user by providing the user ID in the URL. Additionally sup
## Error Responses
| Code | Description |
|------|-------------|
| 400 | Invalid input data or invalid role |
| 401 | Invalid or expired token |
| 403 | Admin access required (admin mode only) |
| 404 | User not found (admin mode only) |
| 409 | Username or email already taken |
| Code | Description |
| ---- | --------------------------------------- |
| 400 | Invalid input data or invalid role |
| 401 | Invalid or expired token |
| 403 | Admin access required (admin mode only) |
| 404 | User not found (admin mode only) |
| 409 | Username or email already taken |