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/media-items/create_media_item.md
-4
View File
@@ -117,7 +117,3 @@ POST /api/libraries/{library_id}/folders
"folder_path": "/path/to/library/folder"
}
```
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/media-items/delete_media_item.md
-4
View File
@@ -35,7 +35,3 @@ Media item deleted successfully.
| 401 | Invalid or expired token |
| 403 | User is not an admin |
| 404 | Media item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/media-items/filter_sort_media_items.md
-4
View File
@@ -61,7 +61,3 @@ Filter and sort media items with advanced criteria.
| 400 | Invalid filter parameters |
| 401 | Invalid or expired token |
| 403 | User does not have access to this library |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/media-items/get_media_item.md
-4
View File
@@ -58,7 +58,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
| 401 | Invalid or expired token |
| 403 | User does not have access to this media item |
| 404 | Media item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/media-items/list_media_items.md
-4
View File
@@ -65,7 +65,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
| 400 | Invalid query parameters |
| 401 | Invalid or expired token |
| 403 | User does not have access to this library |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/media-items/search_media_items.md
-4
View File
@@ -55,7 +55,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------|
| 400 | Invalid search query (too short) |
| 401 | Invalid or expired token |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/media-items/update_media_item.md
-4
View File
@@ -64,7 +64,3 @@ Update media item metadata (Admin only).
| 401 | Invalid or expired token |
| 403 | User is not an admin |
| 404 | Media item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->