Mirrors/blakeblackshear.frigate
1
0
Fork 0
mirror of https://github.com/blakeblackshear/frigate.git synced 2025-08-27 13:47:50 +02:00
Code Issues Projects Releases Wiki Activity

Deprecate API field include_thumbnails (#19584)

Browse Source 
* Add deprecation note to API docs for include_thumbnails

* for search query params as well
This commit is contained in:
Josh Hawkins 2025-08-18 08:26:02 -05:00 committed by GitHub
parent b45f642868
commit ba20b61c43
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
frigate/api/defs/query/events_query_parameters.py
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
@ -40,7 +47,14 @@ class EventsSearchQueryParams(BaseModel):
query: Optional[str] = None query: Optional[str] = None
event_id: Optional[str] = None event_id: Optional[str] = None
search_type: Optional[str] = "thumbnail" 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 limit: Optional[int] = 50
cameras: Optional[str] = "all" cameras: Optional[str] = "all"
labels: Optional[str] = "all" labels: Optional[str] = "all"