docs(484): correct the counted-enumeration counts on the api client interfaces
PR Gates / CI image pin matches docker/ci (pull_request) Successful in 16s
PR Gates / Docs update reminder (pull_request) Successful in 16s
PR Gates / decisions lifecycle (pull_request) Successful in 21s
Build ErsatzTV Image / EF migration integrity (SQLite + MySql) (pull_request) Successful in 6m7s
Build ErsatzTV Image / API docs in sync (OpenAPI + endpoint index) (pull_request) Successful in 9s
Build ErsatzTV Image / Formatting (changed .cs conform to .editorconfig) (pull_request) Successful in 13s
Build ErsatzTV Image / Functional E2E (curl + UI contracts) (pull_request) Successful in 17m26s
Build ErsatzTV Image / Build & test (.NET) (pull_request) Successful in 22m17s
Build ErsatzTV Image / Build & push image (amd64) (pull_request) Has been skipped
PR Gates / CI image pin matches docker/ci (pull_request) Successful in 16s
PR Gates / Docs update reminder (pull_request) Successful in 16s
PR Gates / decisions lifecycle (pull_request) Successful in 21s
Build ErsatzTV Image / EF migration integrity (SQLite + MySql) (pull_request) Successful in 6m7s
Build ErsatzTV Image / API docs in sync (OpenAPI + endpoint index) (pull_request) Successful in 9s
Build ErsatzTV Image / Formatting (changed .cs conform to .editorconfig) (pull_request) Successful in 13s
Build ErsatzTV Image / Functional E2E (curl + UI contracts) (pull_request) Successful in 17m26s
Build ErsatzTV Image / Build & test (.NET) (pull_request) Successful in 22m17s
Build ErsatzTV Image / Build & push image (amd64) (pull_request) Has been skipped
Review follow-up. The comments still said three (Jellyfin) / two (Emby) library-level enumerations after the nested season and episode ones were counted, which understates the reach of the very safety property this branch establishes -- a future auditor reading them would conclude the nested sweeps are unprotected.
This commit is contained in:
@@ -9,9 +9,12 @@ public interface IEmbyApiClient
|
||||
Task<Either<BaseError, EmbyServerInformation>> GetServerInformation(string address, string apiKey);
|
||||
Task<Either<BaseError, List<EmbyLibrary>>> GetLibraries(string address, string apiKey);
|
||||
|
||||
// #484: the two library-level enumerations that feed a reconciliation sweep accept an optional
|
||||
// per-enumeration counter. The caller creates one instance per enumeration and reads it only after
|
||||
// the enumeration completes; passing null (the default) opts out and costs existing callers nothing.
|
||||
// #484: the four enumerations that feed a reconciliation sweep accept an optional per-enumeration
|
||||
// counter -- the two library-level ones (movies, shows) AND the two nested ones (seasons per show,
|
||||
// episodes per season), which feed the per-parent sweeps in MediaServerTelevisionLibraryScanner.
|
||||
// The caller creates one instance per enumeration, scoped to the parent it sweeps, and reads it
|
||||
// only after that enumeration completes; passing null (the default) opts out and costs existing
|
||||
// callers nothing.
|
||||
IAsyncEnumerable<Tuple<EmbyMovie, int>> GetMovieLibraryItems(
|
||||
string address,
|
||||
string apiKey,
|
||||
|
||||
@@ -9,9 +9,12 @@ public interface IJellyfinApiClient
|
||||
Task<Either<BaseError, JellyfinServerInformation>> GetServerInformation(string address, string authorizationHeader);
|
||||
Task<Either<BaseError, List<JellyfinLibrary>>> GetLibraries(string address, string authorizationHeader);
|
||||
|
||||
// #484: the three library-level enumerations that feed a reconciliation sweep accept an optional
|
||||
// per-enumeration counter. The caller creates one instance per enumeration and reads it only after
|
||||
// the enumeration completes; passing null (the default) opts out and costs existing callers nothing.
|
||||
// #484: the six enumerations that feed a reconciliation sweep accept an optional per-enumeration
|
||||
// counter -- the three library-level ones (movies, music videos, shows) AND the three nested ones
|
||||
// (seasons per show, episodes per season, both episode variants), which feed the per-parent sweeps
|
||||
// in MediaServerTelevisionLibraryScanner. The caller creates one instance per enumeration, scoped
|
||||
// to the parent it sweeps, and reads it only after that enumeration completes; passing null (the
|
||||
// default) opts out and costs existing callers nothing.
|
||||
IAsyncEnumerable<Tuple<JellyfinMovie, int>> GetMovieLibraryItems(
|
||||
string address,
|
||||
string authorizationHeader,
|
||||
|
||||
Reference in New Issue
Block a user