Files

T

john-okeefe b44e4e4709 docs: remove Phase X placeholders from API documentation

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.

2026-02-13 21:50:44 -05:00

942 B

Raw Blame History

Add Library Folder

Add a folder to an existing library (Admin only).

Endpoint: POST /api/libraries/{library_id}/folders Auth: Required (Admin only) Content-Type: application/json

Path Parameters

Parameter	Type	Required	Description
library_id	string	Yes	Library UUID

Request Body

Field	Type	Required	Description
folder_path	string	Yes	Absolute path to folder

Example Request

{
  "folder_path": "/path/to/comics"
}

Response (201 Created)

{
  "id": "uuid",
  "library_id": "uuid",
  "folder_path": "/path/to/comics",
  "created_at": "2026-01-31T10:00:00Z"
}

Error Responses

Code	Description
400	Invalid folder path
401	Invalid or expired token
403	User is not an admin
404	Library not found

942 B Raw Blame History