diff --git a/docs/static/frigate-api.yaml b/docs/static/frigate-api.yaml index 9a6364e27..6faee8d27 100644 --- a/docs/static/frigate-api.yaml +++ b/docs/static/frigate-api.yaml @@ -7,7 +7,7 @@ info: servers: - url: https://demo.frigate.video/api - - url: http://localhost:5001/ + - url: http://localhost:5001/api paths: /auth: @@ -296,7 +296,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReviewSetMultipleReviewedBody' + $ref: '#/components/schemas/ReviewModifyMultipleBody' responses: '200': description: Successful Response @@ -321,7 +321,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReviewDeleteMultipleReviewsBody' + $ref: '#/components/schemas/ReviewModifyMultipleBody' responses: '200': description: Successful Response @@ -1141,11 +1141,11 @@ paths: type: number title: End Time requestBody: + required: true content: application/json: schema: - type: object - title: Body + $ref: '#/components/schemas/ExportRecordingsBody' responses: '200': description: Successful Response @@ -1408,6 +1408,14 @@ paths: - type: number - type: 'null' title: Max Length + - name: event_id + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Event Id - name: sort in: query required: false @@ -1518,7 +1526,7 @@ paths: anyOf: - type: string - type: 'null' - default: thumbnail,description + default: thumbnail title: Search Type - name: include_thumbnails in: query @@ -1590,6 +1598,22 @@ paths: - type: 'null' default: 00:00,24:00 title: Time Range + - name: has_clip + in: query + required: false + schema: + anyOf: + - type: boolean + - type: 'null' + title: Has Clip + - name: has_snapshot + in: query + required: false + schema: + anyOf: + - type: boolean + - type: 'null' + title: Has Snapshot - name: timezone in: query required: false @@ -2356,14 +2380,14 @@ paths: required: false schema: type: number - default: 1729274204.653048 + default: 1731271332.181958 title: After - name: before in: query required: false schema: type: number - default: 1729277804.653095 + default: 1731274932.181968 title: Before responses: '200': @@ -3262,6 +3286,29 @@ components: required: - subLabel title: EventsSubLabelBody + ExportRecordingsBody: + properties: + playback: + allOf: + - $ref: '#/components/schemas/PlaybackFactorEnum' + title: Playback factor + default: realtime + source: + type: string + title: Source + default: recordings + name: + type: string + maxLength: 256 + minLength: 1 + title: Friendly name + image_path: + type: string + title: Image Path + type: object + required: + - name + title: ExportRecordingsBody Extension: type: string enum: @@ -3313,6 +3360,12 @@ components: - total_alert - total_detection title: Last24HoursReview + PlaybackFactorEnum: + type: string + enum: + - realtime + - timelapse_25x + title: PlaybackFactorEnum RegenerateDescriptionEnum: type: string enum: @@ -3336,7 +3389,7 @@ components: - motion - camera title: ReviewActivityMotionResponse - ReviewDeleteMultipleReviewsBody: + ReviewModifyMultipleBody: properties: ids: items: @@ -3348,7 +3401,7 @@ components: type: object required: - ids - title: ReviewDeleteMultipleReviewsBody + title: ReviewModifyMultipleBody ReviewSegmentResponse: properties: id: @@ -3386,19 +3439,6 @@ components: - thumb_path - data title: ReviewSegmentResponse - ReviewSetMultipleReviewedBody: - properties: - ids: - items: - type: string - minLength: 1 - type: array - minItems: 1 - title: Ids - type: object - required: - - ids - title: ReviewSetMultipleReviewedBody ReviewSummaryResponse: properties: last24Hours: diff --git a/frigate/api/defs/request/export_recordinds_body.py b/frigate/api/defs/request/export_recordinds_body.py index 189560b97..c98f9a83f 100644 --- a/frigate/api/defs/request/export_recordinds_body.py +++ b/frigate/api/defs/request/export_recordinds_body.py @@ -1,6 +1,7 @@ -from typing import Optional +from typing import Union from pydantic import BaseModel, Field +from pydantic.json_schema import SkipJsonSchema from frigate.record.export import PlaybackFactorEnum @@ -11,4 +12,4 @@ class ExportRecordingsBody(BaseModel): ) source: str = "recordings" name: str = Field(title="Friendly name", min_length=1, max_length=256) - image_path: Optional[str] = None + image_path: Union[str, SkipJsonSchema[None]] = None