docs: update list_team_evolutions docstring for player_name and Player join #121

Merged
cal merged 1 commits from ai/paper-dynasty-database#115 into next-release 2026-03-19 18:22:23 +00:00

View File

@ -1541,9 +1541,11 @@ async def list_team_evolutions(
):
"""List all EvolutionCardState rows for a team, with optional filters.
Joins EvolutionCardState to EvolutionTrack so that card_type filtering
works without a second query. Results are paginated via page/per_page
(1-indexed pages); items are ordered by player_id for stable ordering.
Joins EvolutionCardState EvolutionTrack (for card_type filtering and
threshold context) and EvolutionCardState Player (for player_name),
both eager-loaded in a single query. Results are paginated via
page/per_page (1-indexed pages); items are ordered by player_id for
stable ordering.
Query parameters:
card_type -- filter to states whose track.card_type matches (e.g. 'batter', 'sp')
@ -1554,7 +1556,8 @@ async def list_team_evolutions(
Response shape:
{"count": N, "items": [card_state_with_threshold_context, ...]}
Each item in 'items' has the same shape as GET /evolution/cards/{card_id}.
Each item in 'items' has the same shape as GET /evolution/cards/{card_id},
plus a ``player_name`` field sourced from the Player table.
"""
if not valid_token(token):
logging.warning("Bad Token: [REDACTED]")