Skip to main content

SeriesExternalIdRefDto

Slim external-ID reference used by the external-index endpoint.

Carries only the fields a discovery consumer needs to match a Codex series against an upstream provider: the source, the provider's ID, and an optional deep link. Deliberately omits the record id, sync hashes, and timestamps that [SeriesExternalIdDto] exposes.

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
SeriesExternalIdRefDto
{
  "externalId": "12345",
  "externalUrl": "https://mangabaka.dev/manga/12345",
  "source": "plugin:mangabaka"
}