john-okeefe
b44e4e4709
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.
53 lines
1.0 KiB
Markdown
53 lines
1.0 KiB
Markdown
# Update Device
|
|
|
|
Update a device's information.
|
|
|
|
**Endpoint**: `PUT /api/devices/:id`
|
|
**Auth**: Required
|
|
**Content-Type**: `application/json`
|
|
|
|
## Path Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|-----------|------|-----------|-------------|
|
|
| id | string (UUID) | Yes | Device UUID |
|
|
|
|
## Request Body
|
|
|
|
| Field | Type | Required | Description |
|
|
|--------|------|-----------|-------------|
|
|
| name | string | No | Device display name |
|
|
| device_type | string | No | Device type (kobo, koreader, etc.) |
|
|
|
|
### Example Request
|
|
|
|
```json
|
|
{
|
|
"name": "My Kobo Clara",
|
|
"device_type": "kobo"
|
|
}
|
|
```
|
|
|
|
## Response (200 OK)
|
|
|
|
```json
|
|
{
|
|
"id": "uuid",
|
|
"name": "My Kobo Clara",
|
|
"device_type": "kobo",
|
|
"user_id": "user-uuid",
|
|
"status": "active",
|
|
"created_at": "2026-02-08T10:00:00Z",
|
|
"updated_at": "2026-02-08T11:00:00Z"
|
|
}
|
|
```
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
|------|-------------|
|
|
| 400 | Invalid request data |
|
|
| 401 | Invalid or expired token |
|
|
| 403 | Device does not belong to user |
|
|
| 404 | Device not found |
|