Follow-up to the sweep route audit, correcting its diagnosis: the CLI
DOES read .yml bodies — via OpenCollection's `body.data` string form
(the NewDevDBSetup script always worked because it used it). The
failing scenario POSTs used `body.json` (structured) / `body.jsonBody`
(string) — keys the CLI silently ignores, sending Content-Length: 0
with form-urlencoded content-type, so every server bind failed.
- 81 bodies converted to data-form (json maps serialized; jsonBody
strings kept verbatim, {{vars}} intact).
- 6 pre-existing TRUNCATED payloads repaired: the original generator
cut bodies at the first {{var}} (every SHA-256-identified scenario
plus Sync Progress/Sync Bookmarks shipped mid-JSON and 400'd from
day one). Rewritten whole, faithful to each file's documented
purpose; book_sha256/book_uuid added to the environment.
- environments: opds_base_url correction from the sweep retained.
Verified live against the rebuilt dev container: the full koreader
scenario tree runs green through `bru run` — 14/14 (202s across
immediate/checkpoint/SHA-256 progress, 200s bookmarks, highlights,
notes; SHA-256 book identification exercised against a real
file_sha256).
62 lines
1.3 KiB
YAML
62 lines
1.3 KiB
YAML
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
|
|
data: "{\n \"device_name\": \"My Kindle Paperwhite\",\n \"device_type\": \"koreader\",\n \"device_identifier\": \"G090GP123456789\"\n}"
|
|
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'
|