Api improvements (#15327)

* Organize api files

* Add more API definitions for events

* Add export select by ID

* Typing fixes

* Update openapi spec

* Change type

* Fix test

* Fix message

* Fix tests

frigate/api/defs/query/app_query_parameters.py

@@ -0,0 +1,12 @@
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class AppTimelineHourlyQueryParameters(BaseModel):
+    cameras: Optional[str] = "all"
+    labels: Optional[str] = "all"
+    after: Optional[float] = None
+    before: Optional[float] = None
+    limit: Optional[int] = 200
+    timezone: Optional[str] = "utc"

frigate/api/defs/query/events_query_parameters.py

@@ -0,0 +1,60 @@
+from typing import Optional
+
+from pydantic import BaseModel
+
+DEFAULT_TIME_RANGE = "00:00,24:00"
+
+
+class EventsQueryParams(BaseModel):
+    camera: Optional[str] = "all"
+    cameras: Optional[str] = "all"
+    label: Optional[str] = "all"
+    labels: Optional[str] = "all"
+    sub_label: Optional[str] = "all"
+    sub_labels: Optional[str] = "all"
+    zone: Optional[str] = "all"
+    zones: Optional[str] = "all"
+    limit: Optional[int] = 100
+    after: Optional[float] = None
+    before: Optional[float] = None
+    time_range: Optional[str] = DEFAULT_TIME_RANGE
+    has_clip: Optional[int] = None
+    has_snapshot: Optional[int] = None
+    in_progress: Optional[int] = None
+    include_thumbnails: Optional[int] = 1
+    favorites: Optional[int] = None
+    min_score: Optional[float] = None
+    max_score: Optional[float] = None
+    is_submitted: Optional[int] = None
+    min_length: Optional[float] = None
+    max_length: Optional[float] = None
+    event_id: Optional[str] = None
+    sort: Optional[str] = None
+    timezone: Optional[str] = "utc"
+
+
+class EventsSearchQueryParams(BaseModel):
+    query: Optional[str] = None
+    event_id: Optional[str] = None
+    search_type: Optional[str] = "thumbnail"
+    include_thumbnails: Optional[int] = 1
+    limit: Optional[int] = 50
+    cameras: Optional[str] = "all"
+    labels: Optional[str] = "all"
+    zones: Optional[str] = "all"
+    after: Optional[float] = None
+    before: Optional[float] = None
+    time_range: Optional[str] = DEFAULT_TIME_RANGE
+    has_clip: Optional[bool] = None
+    has_snapshot: Optional[bool] = None
+    is_submitted: Optional[bool] = None
+    timezone: Optional[str] = "utc"
+    min_score: Optional[float] = None
+    max_score: Optional[float] = None
+    sort: Optional[str] = None
+
+
+class EventsSummaryQueryParams(BaseModel):
+    timezone: Optional[str] = "utc"
+    has_clip: Optional[int] = None
+    has_snapshot: Optional[int] = None

frigate/api/defs/query/media_query_parameters.py

@@ -0,0 +1,42 @@
+from enum import Enum
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class Extension(str, Enum):
+    webp = "webp"
+    png = "png"
+    jpg = "jpg"
+    jpeg = "jpeg"
+
+
+class MediaLatestFrameQueryParams(BaseModel):
+    bbox: Optional[int] = None
+    timestamp: Optional[int] = None
+    zones: Optional[int] = None
+    mask: Optional[int] = None
+    motion: Optional[int] = None
+    regions: Optional[int] = None
+    quality: Optional[int] = 70
+    height: Optional[int] = None
+
+
+class MediaEventsSnapshotQueryParams(BaseModel):
+    download: Optional[bool] = False
+    timestamp: Optional[int] = None
+    bbox: Optional[int] = None
+    crop: Optional[int] = None
+    height: Optional[int] = None
+    quality: Optional[int] = 70
+
+
+class MediaMjpegFeedQueryParams(BaseModel):
+    fps: int = 3
+    height: int = 360
+    bbox: Optional[int] = None
+    timestamp: Optional[int] = None
+    zones: Optional[int] = None
+    mask: Optional[int] = None
+    motion: Optional[int] = None
+    regions: Optional[int] = None

frigate/api/defs/query/regenerate_query_parameters.py

@@ -0,0 +1,9 @@
+from typing import Optional
+
+from pydantic import BaseModel
+
+from frigate.events.types import RegenerateDescriptionEnum
+
+
+class RegenerateQueryParameters(BaseModel):
+    source: Optional[RegenerateDescriptionEnum] = RegenerateDescriptionEnum.thumbnails

frigate/api/defs/query/review_query_parameters.py

@@ -0,0 +1,31 @@
+from typing import Union
+
+from pydantic import BaseModel
+from pydantic.json_schema import SkipJsonSchema
+
+from frigate.review.maintainer import SeverityEnum
+
+
+class ReviewQueryParams(BaseModel):
+    cameras: str = "all"
+    labels: str = "all"
+    zones: str = "all"
+    reviewed: int = 0
+    limit: Union[int, SkipJsonSchema[None]] = None
+    severity: Union[SeverityEnum, SkipJsonSchema[None]] = None
+    before: Union[float, SkipJsonSchema[None]] = None
+    after: Union[float, SkipJsonSchema[None]] = None
+
+
+class ReviewSummaryQueryParams(BaseModel):
+    cameras: str = "all"
+    labels: str = "all"
+    zones: str = "all"
+    timezone: str = "utc"
+
+
+class ReviewActivityMotionQueryParams(BaseModel):
+    cameras: str = "all"
+    before: Union[float, SkipJsonSchema[None]] = None
+    after: Union[float, SkipJsonSchema[None]] = None
+    scale: int = 30