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,54 @@
+# Get Collection
+
+Get single collection with all books.
+
+**Endpoint**: `GET /api/collections/{id}`
+**Auth**: Required
+**Content-Type**: `application/json`
+
+## Path Parameters
+
+| Parameter | Type | Required | Description |
+|-----------|------|-----------|-------------|
+| id | string (UUID) | Yes | Collection UUID |
+
+## Query Parameters
+
+| Parameter | Type | Required | Description |
+|-----------|------|-----------|-------------|
+| include_books | boolean | No | Include books in response (default: true) |
+| limit | integer | No | Number of books to return (default: 50) |
+| offset | integer | No | Number of books to skip (default: 0) |
+
+## Response (200 OK)
+
+```json
+{
+  "id": "550e8400-e29b-41d4-a716-446655440000",
+  "name": "Science Fiction",
+  "description": "My sci-fi collection",
+  "color": "#FF5733",
+  "icon": "🚀",
+  "books": [
+    {
+      "media_item_id": "660e8400-e29b-41d4-a716-446655440000",
+      "title": "Foundation",
+      "author": "Isaac Asimov",
+      "cover_image_path": "/covers/foundation.jpg"
+    }
+  ],
+  "auto_assign_rules": [],
+  "view_settings": {},
+  "created_at": "2026-02-01T10:00:00Z"
+}
+```
+
+## Error Responses
+
+| Code | Description |
+|------|-------------|
+| 401 | Authentication required |
+| 404 | Collection not found |
+| 500 | Internal server error |
+
+## Try It Out