Skip to main content

PaginatedResponse_SeriesExternalIndexDto

Generic paginated response wrapper with HATEOAS links

data object[]required

The data items for this page

  • Array [
    • externalIds object[]required

    External IDs linked to this series (empty if none have been linked yet)

  • Array [
    • externalIdstringrequired

    External ID value from the source

    Example: 12345
    externalUrlstring | nullnullable

    URL to the external source page (if available)

    Example: https://mangabaka.dev/manga/12345
    sourcestringrequired

    Source identifier (e.g., "plugin:mangabaka", "comicinfo", "epub")

    Example: plugin:mangabaka
  • ]
    • idstring<uuid>required

    Series ID (build the Codex web deep link /series/{id} consumer-side)

    Example: 550e8400-e29b-41d4-a716-446655440002
    localMaxChapter(number | null)<float>nullable

    Highest book_metadata.chapter across non-deleted books, or null if no book in the series has a parsed chapter.

    Example: 130.5
    localMaxVolume(integer | null)<int32>nullable

    Highest book_metadata.volume across non-deleted books, or null if no book in the series has a parsed volume.

    Example: 12
    volumesOwned(integer | null)<int64>nullable

    Count of complete-volume files (volume set, chapter null). A soft, display-only signal; not authoritative for "how far along".

    Example: 12
  • ]
    • links objectrequired

    HATEOAS navigation links

    firststringrequired

    Link to the first page

    laststringrequired

    Link to the last page

    nextstring | nullnullable

    Link to the next page (null if on last page)

    prevstring | nullnullable

    Link to the previous page (null if on first page)

    selfstringrequired

    Link to the current page

    pageinteger<int64>required

    Current page number (1-indexed)

    Possible values: >= 0

    Example: 1
    pageSizeinteger<int64>required

    Number of items per page

    Possible values: >= 0

    Example: 50
    totalinteger<int64>required

    Total number of items across all pages

    Possible values: >= 0

    Example: 150
    totalPagesinteger<int64>required

    Total number of pages

    Possible values: >= 0

    Example: 3
    PaginatedResponse_SeriesExternalIndexDto
    {
      "data": [
        {
          "externalIds": [
            {
              "externalId": "12345",
              "externalUrl": "https://mangabaka.dev/manga/12345",
              "source": "plugin:mangabaka"
            }
          ],
          "id": "550e8400-e29b-41d4-a716-446655440002",
          "localMaxChapter": 130.5,
          "localMaxVolume": 12,
          "volumesOwned": 12
        }
      ],
      "links": {
        "first": "string",
        "last": "string",
        "next": "string",
        "prev": "string",
        "self": "string"
      },
      "page": 1,
      "pageSize": 50,
      "total": 150,
      "totalPages": 3
    }