diff --git a/frigate/api/defs/query/events_query_parameters.py b/frigate/api/defs/query/events_query_parameters.py index d707ba8cc..187dd3f91 100644 --- a/frigate/api/defs/query/events_query_parameters.py +++ b/frigate/api/defs/query/events_query_parameters.py @@ -1,6 +1,6 @@ from typing import Optional -from pydantic import BaseModel +from pydantic import BaseModel, Field DEFAULT_TIME_RANGE = "00:00,24:00" @@ -21,7 +21,14 @@ class EventsQueryParams(BaseModel): has_clip: Optional[int] = None has_snapshot: 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 min_score: Optional[float] = None max_score: Optional[float] = None @@ -40,7 +47,14 @@ class EventsSearchQueryParams(BaseModel): query: Optional[str] = None event_id: Optional[str] = None search_type: Optional[str] = "thumbnail" - 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, + ) limit: Optional[int] = 50 cameras: Optional[str] = "all" labels: Optional[str] = "all"