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,57 @@
+# List Collections
+
+Get all collections for the authenticated user.
+
+**Endpoint**: `GET /api/collections`
+**Auth**: Required
+**Content-Type**: `application/json`
+
+## Query Parameters
+
+| Parameter | Type | Required | Description |
+|-----------|------|-----------|-------------|
+| limit | integer | No | Number of collections to return (default: 50) |
+| offset | integer | No | Number of collections to skip (default: 0) |
+
+## Response (200 OK)
+
+```json
+{
+  "collections": [
+    {
+      "id": "550e8400-e29b-41d4-a716-446655440000",
+      "name": "Science Fiction",
+      "description": "My sci-fi collection",
+      "color": "#FF5733",
+      "icon": "🚀",
+      "auto_assign_rules": [
+        {
+          "field": "genre",
+          "operator": "equals",
+          "value": "Science Fiction",
+          "priority": 1,
+          "enabled": true
+        }
+      ],
+      "view_settings": {
+        "kobo": {
+          "view_mode": "grid",
+          "sort_order": "name",
+          "items_per_page": 24
+        }
+      },
+      "created_at": "2026-02-01T10:00:00Z"
+    }
+  ],
+  "total": 1
+}
+```
+
+## Error Responses
+
+| Code | Description |
+|------|-------------|
+| 401 | Authentication required |
+| 500 | Internal server error |
+
+## Try It Out