LibraryDto

Library data transfer object

allowedFormatsstring[]nullable

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

Example: ["CBZ","CBR","PDF"]

bookConfig

Book strategy-specific configuration (JSON)

bookCountinteger,null<int64>nullable

Total number of books in this library

Example: 1250

bookStrategyBookStrategy (string)required

Book naming strategy (filename, metadata_first, smart, series_name)

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

createdAtstring<date-time>required

When the library was created

Example: 2024-01-01T00:00:00Z

defaultReadingDirectionstringrequired

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

Example: ltr

descriptionstring | nullnullable

Optional description

Example: My comic book collection

excludedPatternsstring | nullnullable

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

Example: .DS_Store Thumbs.db

idstring<uuid>required

Library unique identifier

Example: 550e8400-e29b-41d4-a716-446655440000

isActivebooleanrequired

Whether the library is active

Example: true

lastScannedAtstring,null<date-time>nullable

When the library was last scanned

Example: 2024-01-15T10:30:00Z

namestringrequired

Library name

Example: Comics

numberConfig

Number strategy-specific configuration (JSON)

numberStrategyNumberStrategy (string)required

Book number strategy (file_order, metadata, filename, smart)

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

pathstringrequired

Filesystem path to the library root

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

seriesConfig

Strategy-specific configuration (JSON)

seriesCountinteger,null<int64>nullable

Total number of series in this library

Example: 85

seriesStrategySeriesStrategy (string)required

Series detection strategy (series_volume, series_volume_chapter, flat, etc.)

Possible values: [series_volume, series_volume_chapter, flat, publisher_hierarchy, calibre, custom]

updatedAtstring<date-time>required

When the library was last updated

Example: 2024-01-15T10:30:00Z

LibraryDto

{
  "allowedFormats": [
    "CBZ",
    "CBR",
    "PDF"
  ],
  "bookCount": 1250,
  "bookStrategy": "filename",
  "createdAt": "2024-01-01T00:00:00Z",
  "defaultReadingDirection": "ltr",
  "description": "My comic book collection",
  "excludedPatterns": ".DS_Store\nThumbs.db",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "isActive": true,
  "lastScannedAt": "2024-01-15T10:30:00Z",
  "name": "Comics",
  "numberStrategy": "file_order",
  "path": "/media/comics",
  "scanningConfig": "null",
  "seriesCount": 85,
  "seriesStrategy": "series_volume",
  "updatedAt": "2024-01-15T10:30:00Z"
}