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/scanner/get_scan_status.md
-4
View File
@@ -67,7 +67,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
| 401 | Invalid or expired token |
| 403 | User does not have admin privileges |
| 404 | Job not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/scanner/get_watch_mode_status.md
-4
View File
@@ -60,7 +60,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
| 401 | Invalid or expired token |
| 403 | User does not have admin privileges |
| 404 | Library not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/scanner/scan_library.md
-4
View File
@@ -53,7 +53,3 @@ The scanner automatically detects and processes files based on the library type:
| 401 | Invalid or expired token |
| 403 | User does not have admin privileges |
| 404 | Library not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/scanner/start_scanner.md
-4
View File
@@ -48,7 +48,3 @@ Start the automated background scanner for a library. Supports ebook, manga, and
| 403 | User does not have admin privileges |
| 404 | Library not found |
| 409 | Scanner already running for this library |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/scanner/start_watch_mode.md
-4
View File
@@ -48,7 +48,3 @@ Watch mode automatically detects and processes:
| 403 | User does not have admin privileges |
| 404 | Library not found |
| 409 | Watch mode already active for this library |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/scanner/stop_scanner.md
-4
View File
@@ -39,7 +39,3 @@ Stop the automated background scanner for a library.
| 403 | User does not have admin privileges |
| 404 | Library not found |
| 400 | Scanner not running for this library |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/scanner/stop_watch_mode.md
-4
View File
@@ -39,7 +39,3 @@ Stop watch mode for a library.
| 403 | User does not have admin privileges |
| 404 | Library not found |
| 400 | Watch mode not active for this library |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->