Frigate HTTP API using FastAPI (#13871)

* POC: Added FastAPI with one endpoint (get /logs/service)

* POC: Revert error_log

* POC: Converted preview related endpoints to FastAPI

* POC: Converted two more endpoints to FastAPI

* POC: lint

* Convert all media endpoints to FastAPI. Added /media prefix (/media/camera && media/events && /media/preview)

* Convert all notifications API endpoints to FastAPI

* Convert first review API endpoints to FastAPI

* Convert remaining review API endpoints to FastAPI

* Convert export endpoints to FastAPI

* Fix path parameters

* Convert events endpoints to FastAPI

* Use body for multiple events endpoints

* Use body for multiple events endpoints (create and end event)

* Convert app endpoints to FastAPI

* Convert app endpoints to FastAPI

* Convert auth endpoints to FastAPI

* Removed flask app in favour of FastAPI app. Implemented FastAPI middleware to check CSRF, connect and disconnect from DB. Added middleware x-forwared-for headers

* Added starlette plugin to expose custom headers

* Use slowapi as the limiter

* Use query parameters for the frame latest endpoint

* Use query parameters for the media snapshot.jpg endpoint

* Use query parameters for the media MJPEG feed endpoint

* Revert initial nginx.conf change

* Added missing even_id for /events/search endpoint

* Removed left over comment

* Use FastAPI TestClient

* severity query parameter should be a string

* Use the same pattern for all tests

* Fix endpoint

* Revert media routers to old names. Order routes to make sure the dynamic ones from media.py are only used whenever there's no match on auth/etc

* Reverted paths for media on tsx files

* Deleted file

* Fix test_http to use TestClient

* Formatting

* Bind timeline to DB

* Fix http tests

* Replace filename with pathvalidate

* Fix latest.ext handling and disable uvicorn access logs

* Add cosntraints to api provided values

* Formatting

* Remove unused

* Remove unused

* Get rate limiter working

---------

Co-authored-by: Nicolas Mowen <nickmowen213@gmail.com>

frigate/api/defs/app_body.py

@@ -0,0 +1,19 @@
+from pydantic import BaseModel
+
+
+class AppConfigSetBody(BaseModel):
+    requires_restart: int = 1
+
+
+class AppPutPasswordBody(BaseModel):
+    password: str
+
+
+class AppPostUsersBody(BaseModel):
+    username: str
+    password: str
+
+
+class AppPostLoginBody(BaseModel):
+    user: str
+    password: str

frigate/api/defs/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/events_body.py

@@ -0,0 +1,30 @@
+from datetime import datetime
+from typing import Optional, Union
+
+from pydantic import BaseModel, Field
+
+
+class EventsSubLabelBody(BaseModel):
+    subLabel: str = Field(title="Sub label", max_length=100)
+    subLabelScore: Optional[float] = Field(
+        title="Score for sub label", default=None, gt=0.0, le=1.0
+    )
+
+
+class EventsDescriptionBody(BaseModel):
+    description: Union[str, None] = Field(
+        title="The description of the event", min_length=1
+    )
+
+
+class EventsCreateBody(BaseModel):
+    source_type: Optional[str] = "api"
+    sub_label: Optional[str] = None
+    score: Optional[int] = 0
+    duration: Optional[int] = 30
+    include_recording: Optional[bool] = True
+    draw: Optional[dict] = {}
+
+
+class EventsEndBody(BaseModel):
+    end_time: Optional[int] = datetime.now().timestamp()

frigate/api/defs/events_query_parameters.py

@@ -0,0 +1,52 @@
+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
+    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,description"
+    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
+    timezone: Optional[str] = "utc"
+
+
+class EventsSummaryQueryParams(BaseModel):
+    timezone: Optional[str] = "utc"
+    has_clip: Optional[int] = None
+    has_snapshot: Optional[int] = None

frigate/api/defs/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/review_query_parameters.py

@@ -0,0 +1,31 @@
+from datetime import datetime, timedelta
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class ReviewQueryParams(BaseModel):
+    cameras: Optional[str] = "all"
+    labels: Optional[str] = "all"
+    zones: Optional[str] = "all"
+    reviewed: Optional[int] = 0
+    limit: Optional[int] = None
+    severity: Optional[str] = None
+    before: Optional[float] = datetime.now().timestamp()
+    after: Optional[float] = (datetime.now() - timedelta(hours=24)).timestamp()
+
+
+class ReviewSummaryQueryParams(BaseModel):
+    cameras: Optional[str] = "all"
+    labels: Optional[str] = "all"
+    zones: Optional[str] = "all"
+    timezone: Optional[str] = "utc"
+    day_ago: Optional[int] = (datetime.now() - timedelta(hours=24)).timestamp()
+    month_ago: Optional[int] = (datetime.now() - timedelta(days=30)).timestamp()
+
+
+class ReviewActivityMotionQueryParams(BaseModel):
+    cameras: Optional[str] = "all"
+    before: Optional[float] = datetime.now().timestamp()
+    after: Optional[float] = (datetime.now() - timedelta(hours=1)).timestamp()
+    scale: Optional[int] = 30

frigate/api/defs/tags.py

@@ -0,0 +1,13 @@
+from enum import Enum
+
+
+class Tags(Enum):
+    app = "App"
+    preview = "Preview"
+    logs = "Logs"
+    media = "Media"
+    notifications = "Notifications"
+    review = "Review"
+    export = "Export"
+    events = "Events"
+    auth = "Auth"