Merge pull request 'docs: update list_team_evolutions docstring for player_name and Player join' (#121) from ai/paper-dynasty-database#115 into next-release
Some checks are pending
Build Docker Image / build (push) Waiting to run

Reviewed-on: #121
This commit is contained in:
cal 2026-03-19 18:22:22 +00:00
commit 87f46a1bfd

View File

@ -1541,9 +1541,11 @@ async def list_team_evolutions(
): ):
"""List all EvolutionCardState rows for a team, with optional filters. """List all EvolutionCardState rows for a team, with optional filters.
Joins EvolutionCardState to EvolutionTrack so that card_type filtering Joins EvolutionCardState EvolutionTrack (for card_type filtering and
works without a second query. Results are paginated via page/per_page threshold context) and EvolutionCardState Player (for player_name),
(1-indexed pages); items are ordered by player_id for stable ordering. 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: Query parameters:
card_type -- filter to states whose track.card_type matches (e.g. 'batter', 'sp') 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: Response shape:
{"count": N, "items": [card_state_with_threshold_context, ...]} {"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): if not valid_token(token):
logging.warning("Bad Token: [REDACTED]") logging.warning("Bad Token: [REDACTED]")