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,7 @@
+info:
+  name: Download Book (EPUB)
+  type: http
+  seq: 3
+http:
+  method: GET
+  url: '{{opds_base_url}}/devices/{{device_id}}/download/{{book_id}}'
@@ -0,0 +1,19 @@
+info:
+  name: Download Book KEPUB (On-the-fly Conversion)
+  type: http
+  seq: 1
+http:
+  method: GET
+  url: '{{base_url}}/opds/devices/{{deviceId}}/download/{{mediaItemId}}?format=kepub'
+  auth: inherit
+  body:
+    type: none
+
+docs: |-
+  ## Download Book KEPUB (On-the-fly Conversion)
+  
+    Downloads a book in Kobo EPUB (KEPUB) format with on-the-fly conversion if needed.
+  
+    **Method:** GET
+  
+    **Endpoint:** /opds/devices/{deviceId
@@ -0,0 +1,7 @@
+info:
+  name: Download Book (KEPUB)
+  type: http
+  seq: 4
+http:
+  method: GET
+  url: '{{opds_base_url}}/devices/{{device_id}}/download/{{book_id}}?format=kepub'
@@ -0,0 +1,7 @@
+info:
+  name: Get Cover Image
+  type: http
+  seq: 5
+http:
+  method: GET
+  url: '{{opds_base_url}}/devices/{{device_id}}/cover/{{book_id}}'
@@ -0,0 +1,7 @@
+info:
+  name: Get Device Catalog
+  type: http
+  seq: 1
+http:
+  method: GET
+  url: '{{opds_base_url}}/devices/{{device_id}}/catalog?page=1&per_page=50'
@@ -0,0 +1,7 @@
+info:
+  name: Get Device Navigation
+  type: http
+  seq: 6
+http:
+  method: GET
+  url: '{{opds_base_url}}/devices/{{device_id}}/nav'
@@ -0,0 +1,7 @@
+info:
+  name: List Formats
+  type: http
+  seq: 7
+http:
+  method: GET
+  url: '{{opds_base_url}}/devices/{{device_id}}/formats/{{book_id}}'
@@ -0,0 +1,7 @@
+info:
+  name: Search Device Catalog
+  type: http
+  seq: 2
+http:
+  method: GET
+  url: '{{opds_base_url}}/devices/{{device_id}}/search?q=hobbit'
@@ -0,0 +1,16 @@
+info:
+  name: Download Book - Query Token
+  type: http
+  seq: 3
+http:
+  method: GET
+  url: '{{opds_base_url}}/opds/devices/{{device_id}}/download/{{book_id}}?token={{device_token}}'
+
+docs: |-
+  ## Download Book - Query Token
+  
+    Tests OPDS book download using query parameter authentication.
+  
+    **Method:** GET
+  
+    **Endpoint:** /opds/devices/{device_id
@@ -0,0 +1,16 @@
+info:
+  name: Get Device Catalog - Bearer
+  type: http
+  seq: 1
+http:
+  method: GET
+  url: '{{opds_base_url}}/opds/devices/{{device_id}}/catalog'
+
+docs: |-
+  ## Get Device OPDS Catalog - Bearer
+  
+    Tests OPDS device catalog retrieval using Bearer token authentication.
+  
+    **Method:** GET
+  
+    **Endpoint:** /opds/devices/{device_id
@@ -0,0 +1,16 @@
+info:
+  name: Get Device Catalog - Query Token
+  type: http
+  seq: 2
+http:
+  method: GET
+  url: '{{opds_base_url}}/opds/devices/{{device_id}}/catalog?token={{device_token}}'
+
+docs: |-
+  ## Get Device OPDS Catalog - Query Token
+  
+    Tests OPDS device catalog retrieval using query parameter authentication.
+  
+    **Method:** GET
+  
+    **Endpoint:** /opds/devices/{device_id