Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,8 +209,15 @@ and quality governance; the plugin routes the request to a configured
connection and reports its status.

A series request may name seasons in `RequestDescriptor.seasons`. Season `0`
is Specials, and an empty list means the whole series. A plugin that fulfils
seasons individually declares it in its manifest:
is Specials, and an empty list means the whole series. Season numbers are the
host's (TMDB's), and download services number some series differently, so
`RequestDescriptor.season_details` also gives each requested season's first
air date and episode count. A plugin finds a season's detail by its `number`
and matches the season as the first that many regular episodes airing from
that date, or the ones it finds when fewer match. A season with no detail, a
detail without a date or count, and a detail that matches no episode are
matched by number. A plugin that fulfils seasons individually declares it in
its manifest:

```json
{
Expand Down
11 changes: 11 additions & 0 deletions docs/compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,17 @@ wire, the host decides who may receive a season-only request from the
manifest's `RequestRouterDescriptor.supports_seasons` flag instead. An absent
descriptor means the flag is false.

`RequestDescriptor.season_details` (added in v0.34.0) is a repeated field, so
it has no presence: a host that predates it, a whole-series request, and a
request made before the host stored the details all send an empty list. A
plugin then matches `seasons` by number, as before. The list may leave out
seasons in `seasons`, so a plugin finds each detail by its `number`, not its
position. A season with no detail, a detail with an empty `first_air_date` or
an `episode_count` of 0, and a detail that matches no episode in the plugin's
service are matched by number too, and so is season `0` (Specials) whatever
its detail says. When fewer than `episode_count` episodes match, the season is
the ones that do. A plugin built before the field existed ignores it.

`TargetStatus.progress` is a message field, so its presence is the `nil` check.
Unset means the target has nothing in flight, and the host clears the progress
it stored for it. A set `progress` must carry a `phase`: the host counts one
Expand Down
Loading
Loading