docs: add Carousel dashboard implementation plan

2026-02-17 17:00:46 -05:00
parent fce16b53f7
commit 96730d9475
407 changed files with 10834 additions and 10983 deletions
@@ -0,0 +1,48 @@
+info:
+  name: Register KOReader Device
+  type: http
+  seq: 2
+
+http:
+  method: POST
+  url: '{{base_url}}/api/devices/register'
+  auth: none
+  headers:
+    - key: Content-Type
+      value: application/json
+  body:
+    type: json
+    json:
+      device_name: My Kindle Paperwhite
+      device_type: koreader
+      device_identifier: G090GP123456789
+
+docs: |-
+  ## Register KOReader Device
+
+  Registers a KOReader device (typically Kindle devices running KOReader software).
+
+  **Method:** POST
+
+  **Endpoint:** /api/devices/register
+
+  **Authentication:** None (public endpoint)
+
+  **Request Body:**
+  - `device_name` (string): Human-readable name for the device
+  - `device_type` (string): Must be `koreader`
+  - `device_identifier` (string): Kindle serial number or unique device ID
+
+  **Response:**
+  - `registration_id` (string): UUID for tracking registration status
+  - `status` (string): Registration status - `pending`
+  - `message` (string): Confirmation message
+
+  **Status Codes:**
+  - 201: Registration initiated
+  - 400: Invalid device type or data
+
+  **KOReader Notes:**
+  - KOReader runs on Kindle, Kobo, PocketBook, and Android devices
+  - Device identifier is typically the device serial number
+  - Supports bookmarks, progress, highlights, and annotations sync