bruno: replace Python generator with Go golden-writer in the drift test
The generator moves into the Go toolchain per repo preference: internal/docs/bruno_gen.go emits the OpenCollection mirrors (same output contract — gate-verified example-request bodies, env-var params, device-token headers, login/register/refresh token-capture scripts) and TestBrunoMirrorsDocs grows a -update flag: verification by default, regeneration on demand: go test ./internal/docs -run TestBrunoMirrorsDocs -update Generator and checker are now the same code — they cannot drift apart. scripts/gen_bruno_from_docs.py deleted; opencollection.yml README points at the go-test command. Also fixed vs the Python pass: mirror placement follows the docs tree folder (RelPath), not the area frontmatter (several docs — highlights, notes, ratings, users, progress — carry a different area); docs blocks emit the collection's mapping form (content + type), not a bare scalar; JSON body sanity is checked at generation time. Idempotent: back-to-back -update runs are byte-identical. make test green (9 pkgs).
This commit is contained in:
1 parent
acd82fff0a
commit
cfcd95b25e
195 files changed
+1049
-643
No files matched your search
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Hash Conflicts (API)
|
# Hash Conflicts (API)
|
||||||
|
|
||||||
`GET /api/admin/hash-conflicts` — auth: jwt+admin.
|
`GET /api/admin/hash-conflicts` — auth: jwt+admin.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/admin/hash_conflicts_api.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/admin/hash_conflicts_api.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# List Users
|
# List Users
|
||||||
|
|
||||||
`GET /api/auth/users` — auth: jwt+admin.
|
`GET /api/auth/users` — auth: jwt+admin.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/admin/list_users.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/admin/list_users.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -19,9 +19,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Update User Max Devices
|
# Update User Max Devices
|
||||||
|
|
||||||
`PUT /api/auth/users/:id/max-devices` — auth: jwt+admin.
|
`PUT /api/auth/users/:id/max-devices` — auth: jwt+admin.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/admin/update_user_max_devices.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/admin/update_user_max_devices.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Reading Statistics
|
# Get Reading Statistics
|
||||||
|
|
||||||
`GET /api/analytics/reading-stats` — auth: jwt.
|
`GET /api/analytics/reading-stats` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/analytics/get_analytics.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/analytics/get_analytics.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Device Usage
|
# Get Device Usage
|
||||||
|
|
||||||
`GET /api/analytics/device-usage` — auth: jwt.
|
`GET /api/analytics/device-usage` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/analytics/get_device_usage.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/analytics/get_device_usage.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Popular Books
|
# Get Popular Books
|
||||||
|
|
||||||
`GET /api/analytics/popular-books` — auth: jwt.
|
`GET /api/analytics/popular-books` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/analytics/get_popular_books.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/analytics/get_popular_books.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -43,9 +43,11 @@ runtime:
|
|||||||
}
|
}
|
||||||
onResponse();
|
onResponse();
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Login User
|
# Login User
|
||||||
|
|
||||||
`POST /api/auth/login` — auth: none.
|
`POST /api/auth/login` — auth: none.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/authentication/login.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/authentication/login.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Logout User
|
# Logout User
|
||||||
|
|
||||||
`POST /api/auth/logout` — auth: none.
|
`POST /api/auth/logout` — auth: none.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/authentication/logout.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/authentication/logout.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Password Rules
|
# Password Rules
|
||||||
|
|
||||||
`GET /api/auth/password-rules` — auth: none.
|
`GET /api/auth/password-rules` — auth: none.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/authentication/password_rules.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/authentication/password_rules.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -42,9 +42,11 @@ runtime:
|
|||||||
}
|
}
|
||||||
onResponse();
|
onResponse();
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Refresh Token
|
# Refresh Token
|
||||||
|
|
||||||
`POST /api/auth/refresh` — auth: none.
|
`POST /api/auth/refresh` — auth: none.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/authentication/refresh_token.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/authentication/refresh_token.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -46,9 +46,11 @@ runtime:
|
|||||||
}
|
}
|
||||||
onResponse();
|
onResponse();
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Register User
|
# Register User
|
||||||
|
|
||||||
`POST /api/auth/register` — auth: none.
|
`POST /api/auth/register` — auth: none.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/authentication/register.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/authentication/register.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -20,9 +20,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Auto Link Books
|
# Auto Link Books
|
||||||
|
|
||||||
`POST /api/sync/auto-link-books` — auth: jwt.
|
`POST /api/sync/auto-link-books` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/book-matching/auto_link_books.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/book-matching/auto_link_books.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -30,9 +30,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Bulk Link Books
|
# Bulk Link Books
|
||||||
|
|
||||||
`POST /api/sync/bulk-link-books` — auth: jwt.
|
`POST /api/sync/bulk-link-books` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/book-matching/bulk_link_books.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/book-matching/bulk_link_books.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -21,9 +21,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Create Device File Alias
|
# Create Device File Alias
|
||||||
|
|
||||||
`POST /api/devices/:id/file-aliases` — auth: jwt.
|
`POST /api/devices/:id/file-aliases` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/book-matching/create_device_file_alias.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/book-matching/create_device_file_alias.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Delete Device File Alias
|
# Delete Device File Alias
|
||||||
|
|
||||||
`DELETE /api/devices/:id/file-aliases/:aliasId` — auth: jwt.
|
`DELETE /api/devices/:id/file-aliases/:aliasId` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/book-matching/delete_device_file_alias.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/book-matching/delete_device_file_alias.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Book Matches
|
# Get Book Matches
|
||||||
|
|
||||||
`GET /api/books/match` — auth: jwt.
|
`GET /api/books/match` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/book-matching/get_book_matches.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/book-matching/get_book_matches.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Device File Aliases
|
# Get Device File Aliases
|
||||||
|
|
||||||
`GET /api/devices/:id/file-aliases` — auth: jwt.
|
`GET /api/devices/:id/file-aliases` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/book-matching/get_device_file_aliases.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/book-matching/get_device_file_aliases.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Unlinked Book Suggestions
|
# Get Unlinked Book Suggestions
|
||||||
|
|
||||||
`GET /api/sync/unlinked-books/:id/suggestions` — auth: jwt.
|
`GET /api/sync/unlinked-books/:id/suggestions` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/book-matching/get_unlinked_book_suggestions.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/book-matching/get_unlinked_book_suggestions.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Unlinked Books
|
# Get Unlinked Books
|
||||||
|
|
||||||
`GET /api/devices/:deviceId/sync/unlinked-books` — auth: jwt.
|
`GET /api/devices/:deviceId/sync/unlinked-books` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/book-matching/get_unlinked_books.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/book-matching/get_unlinked_books.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -25,9 +25,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Link Book
|
# Link Book
|
||||||
|
|
||||||
`POST /api/devices/:deviceId/sync/link-book` — auth: jwt.
|
`POST /api/devices/:deviceId/sync/link-book` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/book-matching/link_book.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/book-matching/link_book.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -23,9 +23,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Search Books for Matching
|
# Search Books for Matching
|
||||||
|
|
||||||
`POST /api/sync/books/query` — auth: jwt.
|
`POST /api/sync/books/query` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/book-matching/search_books.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/book-matching/search_books.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -20,9 +20,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Update Device File Alias
|
# Update Device File Alias
|
||||||
|
|
||||||
`PUT /api/devices/:id/file-aliases/:aliasId` — auth: jwt.
|
`PUT /api/devices/:id/file-aliases/:aliasId` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/book-matching/update_device_file_alias.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/book-matching/update_device_file_alias.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -23,9 +23,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Add Auto-Assign Rule
|
# Add Auto-Assign Rule
|
||||||
|
|
||||||
`POST /api/collections/:id/rules` — auth: jwt.
|
`POST /api/collections/:id/rules` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/collections/add_auto_assign_rule.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/collections/add_auto_assign_rule.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -26,9 +26,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Bulk Add Books
|
# Bulk Add Books
|
||||||
|
|
||||||
`POST /api/collections/bulk-add-books` — auth: jwt.
|
`POST /api/collections/bulk-add-books` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/collections/bulk_add_books.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/collections/bulk_add_books.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -23,9 +23,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Bulk Assign Books
|
# Bulk Assign Books
|
||||||
|
|
||||||
`POST /api/collections/:id/books` — auth: jwt.
|
`POST /api/collections/:id/books` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/collections/bulk_assign.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/collections/bulk_assign.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -22,9 +22,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Bulk Remove Books
|
# Bulk Remove Books
|
||||||
|
|
||||||
`POST /api/collections/:id/books/bulk-remove` — auth: jwt.
|
`POST /api/collections/:id/books/bulk-remove` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/collections/bulk_remove_books.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/collections/bulk_remove_books.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -25,9 +25,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Create Collection
|
# Create Collection
|
||||||
|
|
||||||
`POST /api/collections` — auth: jwt.
|
`POST /api/collections` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/collections/create_collection.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/collections/create_collection.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -5,7 +5,7 @@ info:
|
|||||||
|
|
||||||
http:
|
http:
|
||||||
method: POST
|
method: POST
|
||||||
url: '{{base_url}}/api/devices/{{collection_id}}/collections'
|
url: '{{base_url}}/api/devices/{{device_id}}/collections'
|
||||||
auth: inherit
|
auth: inherit
|
||||||
body:
|
body:
|
||||||
type: json
|
type: json
|
||||||
@@ -21,9 +21,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Create Shelf Mapping
|
# Create Shelf Mapping
|
||||||
|
|
||||||
`POST /api/devices/:id/collections` — auth: jwt.
|
`POST /api/devices/:id/collections` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/collections/create_shelf_mapping.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/collections/create_shelf_mapping.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Delete Collection
|
# Delete Collection
|
||||||
|
|
||||||
`DELETE /api/collections/:id` — auth: jwt.
|
`DELETE /api/collections/:id` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/collections/delete_collection.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/collections/delete_collection.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -5,7 +5,7 @@ info:
|
|||||||
|
|
||||||
http:
|
http:
|
||||||
method: DELETE
|
method: DELETE
|
||||||
url: '{{base_url}}/api/devices/{{collection_id}}/collections/{{collection_id}}'
|
url: '{{base_url}}/api/devices/{{device_id}}/collections/{{collection_id}}'
|
||||||
auth: inherit
|
auth: inherit
|
||||||
settings:
|
settings:
|
||||||
encodeUrl: true
|
encodeUrl: true
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Delete Shelf Mapping
|
# Delete Shelf Mapping
|
||||||
|
|
||||||
`DELETE /api/devices/:id/collections/:collectionId` — auth: jwt.
|
`DELETE /api/devices/:id/collections/:collectionId` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/collections/delete_shelf_mapping.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/collections/delete_shelf_mapping.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Collection
|
# Get Collection
|
||||||
|
|
||||||
`GET /api/collections/:id` — auth: jwt.
|
`GET /api/collections/:id` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/collections/get_collection.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/collections/get_collection.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Book Collections
|
# Get Book Collections
|
||||||
|
|
||||||
`GET /api/collections/:id/books` — auth: jwt.
|
`GET /api/collections/:id/books` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/collections/get_collection_books.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/collections/get_collection_books.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# List Collections
|
# List Collections
|
||||||
|
|
||||||
`GET /api/collections` — auth: jwt.
|
`GET /api/collections` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/collections/list_collections.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/collections/list_collections.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -22,9 +22,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Preview Collection
|
# Preview Collection
|
||||||
|
|
||||||
`POST /api/collections/preview` — auth: jwt.
|
`POST /api/collections/preview` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/collections/preview_collection.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/collections/preview_collection.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Remove Auto-Assign Rule
|
# Remove Auto-Assign Rule
|
||||||
|
|
||||||
`DELETE /api/collections/:id/rules/:ruleId` — auth: jwt.
|
`DELETE /api/collections/:id/rules/:ruleId` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/collections/remove_auto_assign_rule.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/collections/remove_auto_assign_rule.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -22,9 +22,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Reorder Collection Items
|
# Reorder Collection Items
|
||||||
|
|
||||||
`PUT /api/collections/:id/items/order` — auth: jwt.
|
`PUT /api/collections/:id/items/order` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/collections/reorder_items.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/collections/reorder_items.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -30,9 +30,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Test Rule
|
# Test Rule
|
||||||
|
|
||||||
`POST /api/collections/test-rules` — auth: jwt.
|
`POST /api/collections/test-rules` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/collections/test_rule.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/collections/test_rule.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -26,9 +26,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Update Collection
|
# Update Collection
|
||||||
|
|
||||||
`PUT /api/collections/:id` — auth: jwt.
|
`PUT /api/collections/:id` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/collections/update_collection.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/collections/update_collection.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -19,9 +19,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Update Collection Rule
|
# Update Collection Rule
|
||||||
|
|
||||||
`PUT /api/collections/:id/rules/:ruleId` — auth: jwt.
|
`PUT /api/collections/:id/rules/:ruleId` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/collections/update_rule.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/collections/update_rule.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -22,9 +22,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Bulk Dismiss Conflicts
|
# Bulk Dismiss Conflicts
|
||||||
|
|
||||||
`POST /api/conflicts/bulk-dismiss` — auth: jwt.
|
`POST /api/conflicts/bulk-dismiss` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/conflicts/bulk_dismiss_conflicts.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/conflicts/bulk_dismiss_conflicts.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -23,9 +23,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Bulk Resolve Conflicts
|
# Bulk Resolve Conflicts
|
||||||
|
|
||||||
`POST /api/conflicts/bulk-resolve` — auth: jwt.
|
`POST /api/conflicts/bulk-resolve` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/conflicts/bulk_resolve_conflicts.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/conflicts/bulk_resolve_conflicts.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Delete Conflict
|
# Delete Conflict
|
||||||
|
|
||||||
`DELETE /api/conflicts/:id` — auth: jwt.
|
`DELETE /api/conflicts/:id` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/conflicts/delete_conflict.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/conflicts/delete_conflict.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Dismiss All Resolved
|
# Dismiss All Resolved
|
||||||
|
|
||||||
`POST /api/conflicts/dismiss-all` — auth: jwt.
|
`POST /api/conflicts/dismiss-all` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/conflicts/dismiss_all_resolved.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/conflicts/dismiss_all_resolved.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Conflict Details
|
# Get Conflict Details
|
||||||
|
|
||||||
`GET /api/conflicts/:id` — auth: jwt.
|
`GET /api/conflicts/:id` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/conflicts/get_conflict.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/conflicts/get_conflict.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# List Conflicts
|
# List Conflicts
|
||||||
|
|
||||||
`GET /api/conflicts` — auth: jwt.
|
`GET /api/conflicts` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/conflicts/list_conflicts.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/conflicts/list_conflicts.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -19,9 +19,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Resolve Conflict
|
# Resolve Conflict
|
||||||
|
|
||||||
`POST /api/conflicts/:id/resolve` — auth: jwt.
|
`POST /api/conflicts/:id/resolve` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/conflicts/resolve_conflict.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/conflicts/resolve_conflict.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Dashboard Preferences
|
# Get Dashboard Preferences
|
||||||
|
|
||||||
`GET /api/dashboard/preferences` — auth: jwt.
|
`GET /api/dashboard/preferences` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/dashboard/get_preferences.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/dashboard/get_preferences.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Dashboard Sections
|
# Get Dashboard Sections
|
||||||
|
|
||||||
`GET /api/dashboard/sections` — auth: jwt.
|
`GET /api/dashboard/sections` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/dashboard/get_sections.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/dashboard/get_sections.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -20,9 +20,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Restore System Collection
|
# Restore System Collection
|
||||||
|
|
||||||
`POST /api/dashboard/restore-system-collection` — auth: jwt.
|
`POST /api/dashboard/restore-system-collection` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/dashboard/restore_system_collection.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/dashboard/restore_system_collection.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -22,9 +22,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Update Dashboard Preferences
|
# Update Dashboard Preferences
|
||||||
|
|
||||||
`PUT /api/dashboard/preferences` — auth: jwt.
|
`PUT /api/dashboard/preferences` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/dashboard/update_preferences.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/dashboard/update_preferences.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -21,9 +21,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Add to Shelf
|
# Add to Shelf
|
||||||
|
|
||||||
`POST /api/devices/:id/shelves` — auth: jwt.
|
`POST /api/devices/:id/shelves` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/devices/add_to_shelf.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/devices/add_to_shelf.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Approve Device Registration
|
# Approve Device Registration
|
||||||
|
|
||||||
`GET /api/devices/approve/:registration_id` — auth: jwt.
|
`GET /api/devices/approve/:registration_id` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/devices/approve_device_registration.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/devices/approve_device_registration.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Clear Shelf
|
# Clear Shelf
|
||||||
|
|
||||||
`DELETE /api/devices/:id/shelves/clear` — auth: jwt.
|
`DELETE /api/devices/:id/shelves/clear` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/devices/clear_shelf.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/devices/clear_shelf.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Delete Device
|
# Delete Device
|
||||||
|
|
||||||
`DELETE /api/devices/:id` — auth: jwt.
|
`DELETE /api/devices/:id` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/devices/delete_device.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/devices/delete_device.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Download Sidecar Config
|
# Download Sidecar Config
|
||||||
|
|
||||||
`GET /api/devices/:id/sidecar/download` — auth: jwt.
|
`GET /api/devices/:id/sidecar/download` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/devices/download_sidecar_config.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/devices/download_sidecar_config.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Device
|
# Get Device
|
||||||
|
|
||||||
`GET /api/devices/:id` — auth: jwt.
|
`GET /api/devices/:id` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/devices/get_device.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/devices/get_device.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Device Collection Mappings
|
# Get Device Collection Mappings
|
||||||
|
|
||||||
`GET /api/devices/:id/collections` — auth: jwt.
|
`GET /api/devices/:id/collections` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/devices/get_device_mappings.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/devices/get_device_mappings.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -19,9 +19,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Device / Check Registration Status
|
# Get Device / Check Registration Status
|
||||||
|
|
||||||
`POST /api/devices/register/status` — auth: none.
|
`POST /api/devices/register/status` — auth: none.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/devices/get_devices.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/devices/get_devices.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Shelf
|
# Get Shelf
|
||||||
|
|
||||||
`GET /api/devices/:id/shelves` — auth: jwt.
|
`GET /api/devices/:id/shelves` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/devices/get_shelf.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/devices/get_shelf.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Device Sidecar Config
|
# Get Device Sidecar Config
|
||||||
|
|
||||||
`GET /api/devices/:id/sidecar` — auth: jwt.
|
`GET /api/devices/:id/sidecar` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/devices/get_sidecar_config.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/devices/get_sidecar_config.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -25,9 +25,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Link Book
|
# Link Book
|
||||||
|
|
||||||
`POST /api/devices/:deviceId/sync/link-book` — auth: jwt.
|
`POST /api/devices/:deviceId/sync/link-book` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/devices/link_book.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/devices/link_book.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# List User Devices
|
# List User Devices
|
||||||
|
|
||||||
`GET /api/devices` — auth: jwt.
|
`GET /api/devices` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/devices/list_devices.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/devices/list_devices.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# List Pending Device Registrations:<|end|><|start|><|start|>assistant to=edit<|channel|>analysis <|constrain|>xml<|message|><rfl:parameter name="path">
|
# List Pending Device Registrations:<|end|><|start|><|start|>assistant to=edit<|channel|>analysis <|constrain|>xml<|message|><rfl:parameter name="path">
|
||||||
|
|
||||||
`GET /api/devices/pending` — auth: jwt.
|
`GET /api/devices/pending` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/devices/list_pending_registrations.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/devices/list_pending_registrations.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Regenerate Device Token
|
# Regenerate Device Token
|
||||||
|
|
||||||
`PUT /api/devices/:id/regenerate-token` — auth: jwt.
|
`PUT /api/devices/:id/regenerate-token` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/devices/regenerate_device_token.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/devices/regenerate_device_token.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -21,9 +21,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Register Device
|
# Register Device
|
||||||
|
|
||||||
`POST /api/devices/register` — auth: none.
|
`POST /api/devices/register` — auth: none.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/devices/register_device.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/devices/register_device.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Reject Device Registration
|
# Reject Device Registration
|
||||||
|
|
||||||
`POST /api/devices/reject/:registration_id` — auth: jwt.
|
`POST /api/devices/reject/:registration_id` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/devices/reject_device_registration.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/devices/reject_device_registration.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Remove from Shelf
|
# Remove from Shelf
|
||||||
|
|
||||||
`DELETE /api/devices/:id/shelves` — auth: jwt.
|
`DELETE /api/devices/:id/shelves` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/devices/remove_from_shelf.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/devices/remove_from_shelf.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -22,9 +22,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Update Device
|
# Update Device
|
||||||
|
|
||||||
`PUT /api/devices/:id` — auth: jwt.
|
`PUT /api/devices/:id` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/devices/update_device.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/devices/update_device.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -20,9 +20,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Update Device Collection Mapping
|
# Update Device Collection Mapping
|
||||||
|
|
||||||
`PUT /api/devices/:id/collections/:collectionId` — auth: jwt.
|
`PUT /api/devices/:id/collections/:collectionId` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/devices/update_device_mapping.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/devices/update_device_mapping.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -24,9 +24,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Create Highlight
|
# Create Highlight
|
||||||
|
|
||||||
`POST /api/media-items/:id/highlights` — auth: jwt.
|
`POST /api/media-items/:id/highlights` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/highlights/create_highlight.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/highlights/create_highlight.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Delete Highlight
|
# Delete Highlight
|
||||||
|
|
||||||
`DELETE /api/media-items/:id/highlights/:highlightId` — auth: jwt.
|
`DELETE /api/media-items/:id/highlights/:highlightId` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/highlights/delete_highlight.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/highlights/delete_highlight.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Highlights
|
# Get Highlights
|
||||||
|
|
||||||
`GET /api/media-items/:id/highlights` — auth: jwt.
|
`GET /api/media-items/:id/highlights` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/highlights/get_highlights.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/highlights/get_highlights.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -20,9 +20,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Update Highlight
|
# Update Highlight
|
||||||
|
|
||||||
`PUT /api/media-items/:id/highlights/:highlightId` — auth: jwt.
|
`PUT /api/media-items/:id/highlights/:highlightId` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/highlights/update_highlight.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/highlights/update_highlight.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -20,9 +20,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Create Job
|
# Create Job
|
||||||
|
|
||||||
`POST /api/jobs` — auth: jwt.
|
`POST /api/jobs` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/jobs/create_job.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/jobs/create_job.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Job Status
|
# Get Job Status
|
||||||
|
|
||||||
`GET /api/jobs/:jobId` — auth: jwt.
|
`GET /api/jobs/:jobId` — auth: jwt.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/jobs/get_job_status.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/jobs/get_job_status.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -22,9 +22,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Analytics GetTests
|
# Analytics GetTests
|
||||||
|
|
||||||
`POST /api/sync/kobo/:token/v1/analytics/gettests` — auth: device-token.
|
`POST /api/sync/kobo/:token/v1/analytics/gettests` — auth: device-token.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/kobo/analytics_gettests.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/kobo/analytics_gettests.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -30,9 +30,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Bookmark Sync
|
# Bookmark Sync
|
||||||
|
|
||||||
`POST /api/sync/kobo/:token/bookmark` — auth: device-token.
|
`POST /api/sync/kobo/:token/bookmark` — auth: device-token.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/kobo/bookmark_sync.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/kobo/bookmark_sync.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -16,9 +16,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Kobo Initialization
|
# Kobo Initialization
|
||||||
|
|
||||||
`GET /api/sync/kobo/:token/v1/initialization` — auth: device-token.
|
`GET /api/sync/kobo/:token/v1/initialization` — auth: device-token.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/kobo/initialization.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/kobo/initialization.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -34,9 +34,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Markup Sync
|
# Markup Sync
|
||||||
|
|
||||||
`POST /api/sync/kobo/:token/markup` — auth: device-token.
|
`POST /api/sync/kobo/:token/markup` — auth: device-token.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/kobo/markup_sync.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/kobo/markup_sync.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -23,9 +23,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Sync From Server
|
# Sync From Server
|
||||||
|
|
||||||
`POST /api/sync/kobo/:token/sync-from-server` — auth: device-token.
|
`POST /api/sync/kobo/:token/sync-from-server` — auth: device-token.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/kobo/sync_from_server.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/kobo/sync_from_server.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -16,9 +16,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Library
|
# Get Library
|
||||||
|
|
||||||
`GET /api/sync/koreader/library` — auth: device-token.
|
`GET /api/sync/koreader/library` — auth: device-token.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/koreader/get_library.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/koreader/get_library.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -16,9 +16,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Metadata
|
# Get Metadata
|
||||||
|
|
||||||
`GET /api/sync/koreader/metadata/:uuid` — auth: device-token.
|
`GET /api/sync/koreader/metadata/:uuid` — auth: device-token.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/koreader/get_metadata.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/koreader/get_metadata.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -16,9 +16,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get KOReader Rating
|
# Get KOReader Rating
|
||||||
|
|
||||||
`GET /api/sync/koreader/rating` — auth: device-token.
|
`GET /api/sync/koreader/rating` — auth: device-token.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/koreader/get_rating.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/koreader/get_rating.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -16,9 +16,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get KOReader Review
|
# Get KOReader Review
|
||||||
|
|
||||||
`GET /api/sync/koreader/review` — auth: device-token.
|
`GET /api/sync/koreader/review` — auth: device-token.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/koreader/get_review.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/koreader/get_review.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -22,9 +22,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Push KOReader Stats
|
# Push KOReader Stats
|
||||||
|
|
||||||
`POST /api/sync/koreader/stats` — auth: device-token.
|
`POST /api/sync/koreader/stats` — auth: device-token.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/koreader/push_stats.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/koreader/push_stats.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -16,9 +16,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Resolve Book:<|end|><|start|> assistant to=edit<|channel|>analysis <|constrain|>xml<|message|><rfl:parameter name="path">
|
# Resolve Book:<|end|><|start|> assistant to=edit<|channel|>analysis <|constrain|>xml<|message|><rfl:parameter name="path">
|
||||||
|
|
||||||
`GET /api/sync/koreader/resolve` — auth: device-token.
|
`GET /api/sync/koreader/resolve` — auth: device-token.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/koreader/resolve_book.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/koreader/resolve_book.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -22,9 +22,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Set KOReader Rating
|
# Set KOReader Rating
|
||||||
|
|
||||||
`POST /api/sync/koreader/rating` — auth: device-token.
|
`POST /api/sync/koreader/rating` — auth: device-token.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/koreader/set_rating.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/koreader/set_rating.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -22,9 +22,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Set KOReader Review
|
# Set KOReader Review
|
||||||
|
|
||||||
`POST /api/sync/koreader/review` — auth: device-token.
|
`POST /api/sync/koreader/review` — auth: device-token.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/koreader/set_review.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/koreader/set_review.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -45,9 +45,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Sync Bookmarks
|
# Sync Bookmarks
|
||||||
|
|
||||||
`POST /api/sync/koreader/bookmarks` — auth: device-token.
|
`POST /api/sync/koreader/bookmarks` — auth: device-token.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/koreader/sync_bookmarks.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/koreader/sync_bookmarks.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -39,9 +39,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Sync Progress
|
# Sync Progress
|
||||||
|
|
||||||
`POST /api/sync/koreader/progress` — auth: device-token.
|
`POST /api/sync/koreader/progress` — auth: device-token.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/koreader/sync_progress.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/koreader/sync_progress.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -19,9 +19,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Add Library Folder
|
# Add Library Folder
|
||||||
|
|
||||||
`POST /api/libraries/:id/folders` — auth: jwt+admin.
|
`POST /api/libraries/:id/folders` — auth: jwt+admin.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/libraries/add_library_folder.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/libraries/add_library_folder.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Browse Library Folders
|
# Browse Library Folders
|
||||||
|
|
||||||
`GET /api/libraries/browse` — auth: jwt+admin.
|
`GET /api/libraries/browse` — auth: jwt+admin.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/libraries/browse-folders.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/libraries/browse-folders.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -21,9 +21,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Create Library
|
# Create Library
|
||||||
|
|
||||||
`POST /api/libraries` — auth: jwt+admin.
|
`POST /api/libraries` — auth: jwt+admin.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/libraries/create_library.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/libraries/create_library.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Delete Library
|
# Delete Library
|
||||||
|
|
||||||
`DELETE /api/libraries/:id` — auth: jwt+admin.
|
`DELETE /api/libraries/:id` — auth: jwt+admin.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/libraries/delete_library.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/libraries/delete_library.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -19,9 +19,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Delete Library Folder
|
# Delete Library Folder
|
||||||
|
|
||||||
`DELETE /api/libraries/:id/folders` — auth: jwt+admin.
|
`DELETE /api/libraries/:id/folders` — auth: jwt+admin.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/libraries/delete_library_folder.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/libraries/delete_library_folder.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Delete Processing Issue
|
# Delete Processing Issue
|
||||||
|
|
||||||
`DELETE /api/libraries/:id/issues/:issueId` — auth: jwt+admin.
|
`DELETE /api/libraries/:id/issues/:issueId` — auth: jwt+admin.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/libraries/delete_processing_issue.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/libraries/delete_processing_issue.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Library Details:<|end|><|start|> assistant to=edit<|channel|>analysis <|constrain|>xml<|message|><rfl:parameter name="path">
|
# Get Library Details:<|end|><|start|> assistant to=edit<|channel|>analysis <|constrain|>xml<|message|><rfl:parameter name="path">
|
||||||
|
|
||||||
`GET /api/libraries/:id` — auth: jwt+admin.
|
`GET /api/libraries/:id` — auth: jwt+admin.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/libraries/get_library.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/libraries/get_library.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Library Folders
|
# Get Library Folders
|
||||||
|
|
||||||
`GET /api/libraries/:id/folders` — auth: jwt+admin.
|
`GET /api/libraries/:id/folders` — auth: jwt+admin.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/libraries/get_library_folders.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/libraries/get_library_folders.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Library Media Items
|
# Get Library Media Items
|
||||||
|
|
||||||
`GET /api/libraries/:id/media-items` — auth: jwt+admin.
|
`GET /api/libraries/:id/media-items` — auth: jwt+admin.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/libraries/get_library_media_items.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/libraries/get_library_media_items.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
@@ -13,9 +13,11 @@ settings:
|
|||||||
followRedirects: true
|
followRedirects: true
|
||||||
maxRedirects: 5
|
maxRedirects: 5
|
||||||
|
|
||||||
docs: |-
|
docs:
|
||||||
|
content: |-
|
||||||
# Get Library Statistics
|
# Get Library Statistics
|
||||||
|
|
||||||
`GET /api/libraries/:id/stats` — auth: jwt+admin.
|
`GET /api/libraries/:id/stats` — auth: jwt+admin.
|
||||||
|
|
||||||
Canonical reference: `docs/developer/api/libraries/get_library_stats.md` (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, not this file.
|
Canonical reference: docs/developer/api/libraries/get_library_stats.md (docs site → Developer → API). This request is GENERATED from that doc; edit the doc, then run the drift test with -update.
|
||||||
|
type: text/markdown
|
||||||
Loaded 100 of 195 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user