UpdateLibraryRequest

Update library request

Note: series_strategy and series_config are immutable after library creation. book_strategy, book_config, number_strategy, and number_config can be updated.

allowedFormatsstring[]nullable

Allowed file formats (e.g., ["CBZ", "CBR", "EPUB"])

Example: ["CBZ","CBR"]

bookConfig

Book strategy-specific configuration (JSON, mutable)

bookStrategy object

oneOf

null

null

BookStrategy

string

Book naming strategy (mutable) Options: filename, metadata_first, smart, series_name

Possible values: [filename, metadata_first, smart, series_name, custom]

defaultReadingDirectionstring | nullnullable

Default reading direction for books in this library (ltr, rtl, ttb or webtoon)

Example: rtl

descriptionstring | nullnullable

Optional description

Example: Updated comic book collection

excludedPatternsstring | nullnullable

Excluded path patterns (newline-separated, e.g., ".DS_Store\nThumbs.db")

Example: .DS_Store

isActiveboolean | nullnullable

Active status

Example: true

namestring | nullnullable

Library name

Example: Comics Collection

numberConfig

Number strategy-specific configuration (JSON, mutable)

numberStrategy object

oneOf

null

null

NumberStrategy

string

Book number strategy (mutable) Options: file_order, metadata, filename, smart

Possible values: [file_order, metadata, filename, smart]

pathstring | nullnullable

Filesystem path to the library

Example: /media/comics

scanningConfig object

oneOf

null

null

ScanningConfigDto

cronSchedulestring | nullnullable

Cron expression for scheduled scans (e.g., "0 */6 * * *")

Example: 0 */6 * * *

enabledbooleanrequired

Whether scheduled scanning is enabled

Example: true

purgeDeletedOnScanboolean

Purge soft-deleted books after completing a scan

Example: false

scanModestringrequired

Default scan mode for scheduled scans ("normal" or "deep")

Example: normal

scanOnStartboolean

Scan library when the application starts

Example: false

UpdateLibraryRequest

{
  "allowedFormats": [
    "CBZ",
    "CBR"
  ],
  "bookStrategy": "null",
  "defaultReadingDirection": "rtl",
  "description": "Updated comic book collection",
  "excludedPatterns": ".DS_Store",
  "isActive": true,
  "name": "Comics Collection",
  "numberStrategy": "null",
  "path": "/media/comics",
  "scanningConfig": "null"
}