Files
bookhoard/docs/developer/api/users/update_username.md
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

688 B

Update Username

Update the authenticated user's username.

Endpoint: PUT /api/auth/username Auth: Required Content-Type: application/json

Request Body

Field Type Required Description
username string Yes New username (min 3 chars, alphanumeric and underscore only)

Example Request

{
  "username": "new_username"
}

Response (200 OK)

{
  "message": "Username updated successfully"
}

Error Responses

Code Description
400 Invalid username format
401 Invalid or expired token
409 Username already taken by another user