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/book-matching/auto_link_books.md
-4
View File
@@ -46,7 +46,3 @@ Automatically link books to media items based on matching metadata.
| 400 | Invalid request data |
| 401 | Invalid or expired token |
| 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/book-matching/bulk_link_books.md
-4
View File
@@ -55,7 +55,3 @@ Each link object contains:
| 400 | Invalid request data |
| 401 | Invalid or expired token |
| 404 | Device, book, or media item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/book-matching/create_device_file_alias.md
-4
View File
@@ -51,7 +51,3 @@ Create a new file alias for a device.
| 401 | Invalid or expired token |
| 404 | Device or media item not found |
| 409 | File alias already exists |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/book-matching/delete_device_file_alias.md
-4
View File
@@ -35,7 +35,3 @@ File alias deleted successfully.
|------|-------------|
| 401 | Invalid or expired token |
| 404 | Device or file alias not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/book-matching/get_book_matches.md
-4
View File
@@ -50,7 +50,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------|
| 400 | Missing required query parameter |
| 401 | Invalid or expired token |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/book-matching/get_device_file_aliases.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/book-matching/get_unlinked_book_suggestions.md
-4
View File
@@ -65,7 +65,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/book-matching/get_unlinked_books.md
-4
View File
@@ -56,7 +56,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/book-matching/link_book.md
-4
View File
@@ -86,7 +86,3 @@ Link a device book to a Bookhoard media item. Supports bulk linking.
| 400 | Invalid link data |
| 401 | Invalid or expired token |
| 404 | Media item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/book-matching/search_books.md
-4
View File
@@ -50,7 +50,3 @@ Query books to find potential matches for linking.
|------|-------------|
| 400 | Invalid query parameters |
| 401 | Invalid or expired token |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/book-matching/update_device_file_alias.md
-4
View File
@@ -49,7 +49,3 @@ Update an existing device file alias.
| 400 | Invalid request data |
| 401 | Invalid or expired token |
| 404 | Device or file alias not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->