Skip to main content

BookWithErrorsDto

A book with its associated errors

book objectrequired

Book data transfer object

analysisErrorstring | nullnullable

Error message if book analysis failed

Example: Failed to parse CBZ: invalid archive
analyzedbooleanrequired

Whether the book has been analyzed (page dimensions available)

Example: true
createdAtstring<date-time>required

When the book was added to the library

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

Whether the book has been soft-deleted

Example: false
fileFormatstringrequired

File format (cbz, cbr, epub, pdf)

Example: cbz
fileHashstringrequired

File hash for deduplication

Example: a1b2c3d4e5f6g7h8i9j0
filePathstringrequired

Filesystem path to the book file

Example: /media/comics/Batman/Batman - Year One 001.cbz
fileSizeinteger<int64>required

File size in bytes

Example: 52428800
idstring<uuid>required

Book unique identifier

Example: 550e8400-e29b-41d4-a716-446655440001
libraryIdstring<uuid>required

Library this book belongs to

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

Name of the library

Example: Comics
numberinteger,null<int32>nullable

Book number within the series

Example: 1
pageCountinteger<int32>required

Number of pages in the book

Example: 32
readProgress object
oneOf
null
readingDirectionstring | nullnullable

Effective reading direction (from series metadata, or library default if not set) Values: ltr, rtl, ttb or webtoon

Example: ltr
seriesIdstring<uuid>required

Series this book belongs to

Example: 550e8400-e29b-41d4-a716-446655440002
seriesNamestringrequired

Name of the series

Example: Batman: Year One
titlestringrequired

Book title

Example: Batman: Year One #1
titleSortstring | nullnullable

Title used for sorting (title_sort field)

Example: batman year one 001
updatedAtstring<date-time>required

When the book was last updated

Example: 2024-01-15T10:30:00Z
errors object[]required

All errors for this book

  • Array [
    • details

    Additional error details (optional)

    errorTypeBookErrorTypeDto (string)required

    Book error type

    Possible values: [format_detection, parser, metadata, thumbnail, page_extraction, pdf_rendering, zero_pages, other]

    messagestringrequired

    Human-readable error message

    Example: Failed to parse CBZ: invalid archive
    occurredAtstring<date-time>required

    When the error occurred

    Example: 2024-01-15T10:30:00Z
  • ]
    • BookWithErrorsDto
    {
      "book": {
        "analysisError": "Failed to parse CBZ: invalid archive",
        "analyzed": true,
        "createdAt": "2024-01-01T00:00:00Z",
        "deleted": false,
        "fileFormat": "cbz",
        "fileHash": "a1b2c3d4e5f6g7h8i9j0",
        "filePath": "/media/comics/Batman/Batman - Year One 001.cbz",
        "fileSize": 52428800,
        "id": "550e8400-e29b-41d4-a716-446655440001",
        "libraryId": "550e8400-e29b-41d4-a716-446655440000",
        "libraryName": "Comics",
        "number": 1,
        "pageCount": 32,
        "readProgress": "null",
        "readingDirection": "ltr",
        "seriesId": "550e8400-e29b-41d4-a716-446655440002",
        "seriesName": "Batman: Year One",
        "title": "Batman: Year One #1",
        "titleSort": "batman year one 001",
        "updatedAt": "2024-01-15T10:30:00Z"
      },
      "errors": [
        {
          "errorType": "format_detection",
          "message": "Failed to parse CBZ: invalid archive",
          "occurredAt": "2024-01-15T10:30:00Z"
        }
      ]
    }