Add deprecation note to API docs for include_thumbnails

This commit is contained in:
Josh Hawkins 2025-08-18 06:24:09 -05:00
parent 6840415b6c
commit 641cd32aec

View File

@ -1,6 +1,6 @@
from typing import Optional from typing import Optional
from pydantic import BaseModel from pydantic import BaseModel, Field
DEFAULT_TIME_RANGE = "00:00,24:00" DEFAULT_TIME_RANGE = "00:00,24:00"
@ -21,7 +21,14 @@ class EventsQueryParams(BaseModel):
has_clip: Optional[int] = None has_clip: Optional[int] = None
has_snapshot: Optional[int] = None has_snapshot: Optional[int] = None
in_progress: Optional[int] = None in_progress: Optional[int] = None
include_thumbnails: Optional[int] = 1 include_thumbnails: Optional[int] = Field(
1,
description=(
"Deprecated. Thumbnail data is no longer included in the response. "
"Use the /api/events/:event_id/thumbnail.:extension endpoint instead."
),
deprecated=True,
)
favorites: Optional[int] = None favorites: Optional[int] = None
min_score: Optional[float] = None min_score: Optional[float] = None
max_score: Optional[float] = None max_score: Optional[float] = None