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

docs: remove Phase X placeholders from API documentation

Browse Source 
Clean up API documentation files by removing Phase X references:

Remove 'API Explorer will be inserted here in Phase X' placeholders from:
- 70+ API endpoint documentation files
- Authentication endpoints (login, logout, register, refresh)
- User endpoints (profile, settings, password)
- Device endpoints (registration, sync, shelves)
- Library endpoints (CRUD, folders, visibility)
- Media endpoints (items, progress, highlights, notes)
- Admin endpoints (users, analytics)
- Sync endpoints (Kobo, KOReader)
- OPDS endpoints
- Scanner endpoints
- Queue endpoints

These placeholders were from planning documents and have no meaning
to API consumers. The documentation is now clean and ready for use.
This commit is contained in:
john-okeefe
2026-02-13 21:50:44 -05:00
parent 2706ae52c1
commit b44e4e4709
108 changed files with 0 additions and 432 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/developer/api/devices/add_to_shelf.md
-4
View File
@@ -44,7 +44,3 @@ Add a media item to a device's shelf (Kobo reading shelf).
| 401 | Invalid or expired token |
| 404 | Device or media item not found |
| 409 | Item already on shelf |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/approve_device_registration.md
-4
View File
@@ -44,7 +44,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
| 403 | User does not have admin privileges |
| 404 | Registration not found |
| 400 | Registration already processed |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/clear_shelf.md
-4
View File
@@ -34,7 +34,3 @@ Shelf cleared successfully.
|------|-------------|
| 401 | Invalid or expired token |
| 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/delete_device.md
-4
View File
@@ -35,7 +35,3 @@ Device deleted successfully.
| 401 | Invalid or expired token |
| 403 | Device does not belong to user |
| 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/get_devices.md
-4
View File
@@ -56,7 +56,3 @@ Check device registration status or get device details.
|------|-------------|
| 401 | Invalid or expired token (for device details) |
| 404 | Device or registration not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/get_shelf.md
-4
View File
@@ -48,7 +48,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------|
| 401 | Invalid or expired token |
| 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/list_devices.md
-4
View File
@@ -42,7 +42,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
| Code | Description |
|------|-------------|
| 401 | Invalid or expired token |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/list_pending_registrations.md
-4
View File
@@ -41,7 +41,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------|
| 401 | Invalid or expired token |
| 403 | User does not have admin privileges |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/register_device.md
-4
View File
@@ -42,7 +42,3 @@ Register a new device for sync.
|------|-------------|
| 400 | Invalid device data |
| 409 | Device already registered |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/reject_device_registration.md
-4
View File
@@ -40,7 +40,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
| 403 | User does not have admin privileges |
| 404 | Registration not found |
| 400 | Registration already processed |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/remove_from_shelf.md
-4
View File
@@ -37,7 +37,3 @@ Item removed from shelf successfully.
| 400 | Invalid request data |
| 401 | Invalid or expired token |
| 404 | Device or shelf item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/revoke_device.md
-4
View File
@@ -35,7 +35,3 @@ Device revoked successfully.
| 401 | Invalid or expired token |
| 403 | User does not own this device |
| 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/update_device.md
-4
View File
@@ -50,7 +50,3 @@ Update a device's information.
| 401 | Invalid or expired token |
| 403 | Device does not belong to user |
| 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->