docs: add collections API endpoint files (Phase 2 completion)

2026-02-02 15:54:59 -05:00
parent a3a3d4ed40
commit ec74650c18
11 changed files with 636 additions and 0 deletions
@@ -0,0 +1,63 @@
+# Update Collection
+
+Update collection details.
+
+**Endpoint**: `PUT /api/collections/{id}`
+**Auth**: Required
+**Content-Type**: `application/json`
+
+## Path Parameters
+
+| Parameter | Type | Required | Description |
+|-----------|------|-----------|-------------|
+| id | string (UUID) | Yes | Collection UUID |
+
+## Request Body
+
+All fields are optional. Include only fields you want to update.
+
+| Field | Type | Required | Description |
+|--------|------|-----------|-------------|
+| name | string | No | Collection name (max 255 chars) |
+| description | string | No | Collection description |
+| color | string | No | Hex color code (e.g., "#FF5733") |
+| icon | string | No | Emoji icon (e.g., "🚀", "📖") |
+| auto_assign_rules | array | No | Array of rule objects (replaces existing rules) |
+| view_settings | object | No | Per-device display preferences |
+
+### Example Request
+
+```json
+{
+  "name": "Sci-Fi Favorites",
+  "description": "Updated description",
+  "color": "#7aa2f7",
+  "icon": "🌟"
+}
+```
+
+## Response (200 OK)
+
+```json
+{
+  "id": "550e8400-e29b-41d4-a716-446655440000",
+  "name": "Sci-Fi Favorites",
+  "description": "Updated description",
+  "color": "#7aa2f7",
+  "icon": "🌟",
+  "auto_assign_rules": [],
+  "view_settings": {},
+  "created_at": "2026-02-01T10:00:00Z"
+}
+```
+
+## Error Responses
+
+| Code | Description |
+|------|-------------|
+| 400 | Invalid request (validation failed) |
+| 401 | Authentication required |
+| 404 | Collection not found |
+| 500 | Internal server error |
+
+## Try It Out