Skip to main content

SeriesExternalIndexDto

Slim per-series projection for external discovery tools.

Returned by GET /api/v1/series/external-index. It carries just the series UUID, its linked external IDs, and the locally-owned volume/chapter signals, deliberately omitting the heavy metadata, genres, tags, covers, ratings, and links of [FullSeriesResponse].

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
    localMaxChapternumber,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
    localMaxVolumeinteger,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
    volumesOwnedinteger,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
    SeriesExternalIndexDto
    {
      "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
    }