docs: add Carousel dashboard implementation plan
This commit is contained in:
@@ -0,0 +1,49 @@
|
||||
info:
|
||||
name: Register Device
|
||||
type: http
|
||||
seq: 1
|
||||
|
||||
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 Kobo Clara
|
||||
device_type: kobo
|
||||
device_identifier: N1234567890123
|
||||
|
||||
docs: |-
|
||||
## Register Device
|
||||
|
||||
Initiates device registration by sending device information to the server.
|
||||
|
||||
**Method:** POST
|
||||
|
||||
**Endpoint:** /api/devices/register
|
||||
|
||||
**Authentication:** None (public endpoint)
|
||||
|
||||
**Request Body:**
|
||||
- `device_name` (string): Human-readable name for the device
|
||||
- `device_type` (string): Type of device - `kobo`, `koreader`, or `web`
|
||||
- `device_identifier` (string): Unique device identifier (serial number or other ID)
|
||||
|
||||
**Response:**
|
||||
- `registration_id` (string): UUID for tracking registration status
|
||||
- `status` (string): Registration status - `pending`, `approved`, or `rejected`
|
||||
- `message` (string): Status message
|
||||
|
||||
**Status Codes:**
|
||||
- 201: Registration initiated successfully
|
||||
- 400: Invalid request data
|
||||
- 409: Device already registered
|
||||
|
||||
**Notes:**
|
||||
- Device registration requires user approval before activation
|
||||
- Registration ID should be stored for status checking
|
||||
- Device identifier must be unique per device
|
||||
Reference in New Issue
Block a user