Updated Documentation for the Review endpoints (#14401)

* Updated documentation for the review endpoint

* Updated documentation for the review/summary endpoint

* Updated documentation for the review/summary endpoint

* Documentation for the review activity audio and motion endpoints

* Added responses for more review.py endpoints

* Added responses for more review.py endpoints

* Fixed review.py responses and proper path parameter names

* Added body model for /reviews/viewed and /reviews/delete

* Updated OpenAPI specification for the review controller endpoints

* Run ruff format frigate

* Drop significant_motion

* Updated frigate-api.yaml

* Deleted total_motion

* Combine 2 models into generic

frigate/api/defs/generic_response.py

@@ -0,0 +1,6 @@
+from pydantic import BaseModel
+
+
+class GenericResponse(BaseModel):
+    success: bool
+    message: str

frigate/api/defs/review_body.py

@@ -0,0 +1,6 @@
+from pydantic import BaseModel, conlist, constr
+
+
+class ReviewModifyMultipleBody(BaseModel):
+    # List of string with at least one element and each element with at least one char
+    ids: conlist(constr(min_length=1), min_length=1)

frigate/api/defs/review_query_parameters.py

@@ -1,28 +1,31 @@
-from typing import Optional
+from typing import Union
 
 from pydantic import BaseModel
+from pydantic.json_schema import SkipJsonSchema
+
+from frigate.review.maintainer import SeverityEnum
 
 
 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] = None
-    after: Optional[float] = None
+    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: Optional[str] = "all"
-    labels: Optional[str] = "all"
-    zones: Optional[str] = "all"
-    timezone: Optional[str] = "utc"
+    cameras: str = "all"
+    labels: str = "all"
+    zones: str = "all"
+    timezone: str = "utc"
 
 
 class ReviewActivityMotionQueryParams(BaseModel):
-    cameras: Optional[str] = "all"
-    before: Optional[float] = None
-    after: Optional[float] = None
-    scale: Optional[int] = 30
+    cameras: str = "all"
+    before: Union[float, SkipJsonSchema[None]] = None
+    after: Union[float, SkipJsonSchema[None]] = None
+    scale: int = 30

frigate/api/defs/review_responses.py

@@ -0,0 +1,43 @@
+from datetime import datetime
+from typing import Dict
+
+from pydantic import BaseModel, Json
+
+from frigate.review.maintainer import SeverityEnum
+
+
+class ReviewSegmentResponse(BaseModel):
+    id: str
+    camera: str
+    start_time: datetime
+    end_time: datetime
+    has_been_reviewed: bool
+    severity: SeverityEnum
+    thumb_path: str
+    data: Json
+
+
+class Last24HoursReview(BaseModel):
+    reviewed_alert: int
+    reviewed_detection: int
+    total_alert: int
+    total_detection: int
+
+
+class DayReview(BaseModel):
+    day: datetime
+    reviewed_alert: int
+    reviewed_detection: int
+    total_alert: int
+    total_detection: int
+
+
+class ReviewSummaryResponse(BaseModel):
+    last24Hours: Last24HoursReview
+    root: Dict[str, DayReview]
+
+
+class ReviewActivityMotionResponse(BaseModel):
+    start_time: int
+    motion: float
+    camera: str