diff --git a/docs/static/frigate-api.yaml b/docs/static/frigate-api.yaml index 123208d3e..1b3e37eb6 100644 --- a/docs/static/frigate-api.yaml +++ b/docs/static/frigate-api.yaml @@ -17,7 +17,7 @@ paths: summary: Auth operationId: auth_auth_get responses: - '200': + "200": description: Successful Response content: application/json: @@ -29,7 +29,7 @@ paths: summary: Profile operationId: profile_profile_get responses: - '200': + "200": description: Successful Response content: application/json: @@ -41,7 +41,7 @@ paths: summary: Logout operationId: logout_logout_get responses: - '200': + "200": description: Successful Response content: application/json: @@ -57,19 +57,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AppPostLoginBody' + $ref: "#/components/schemas/AppPostLoginBody" responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /users: get: tags: @@ -77,7 +77,7 @@ paths: summary: Get Users operationId: get_users_users_get responses: - '200': + "200": description: Successful Response content: application/json: @@ -92,19 +92,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AppPostUsersBody' + $ref: "#/components/schemas/AppPostUsersBody" responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /users/{username}: delete: tags: @@ -119,17 +119,17 @@ paths: type: string title: Username responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /users/{username}/password: put: tags: @@ -148,19 +148,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AppPutPasswordBody' + $ref: "#/components/schemas/AppPutPasswordBody" responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /users/{username}/role: put: tags: @@ -179,19 +179,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AppPutRoleBody' + $ref: "#/components/schemas/AppPutRoleBody" responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /faces: get: tags: @@ -204,12 +204,12 @@ paths: .jpg, and .jpeg. operationId: get_faces_faces_get responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/FacesResponse' + $ref: "#/components/schemas/FacesResponse" /faces/reprocess: post: tags: @@ -228,17 +228,17 @@ paths: type: object title: Body responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /faces/train/{name}/classify: post: tags: @@ -266,18 +266,18 @@ paths: type: object title: Body responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /faces/{name}/create: post: tags: @@ -297,18 +297,18 @@ paths: type: string title: Name responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /faces/{name}/register: post: tags: @@ -336,18 +336,18 @@ paths: $ref: >- #/components/schemas/Body_register_face_faces__name__register_post responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /faces/recognize: post: tags: @@ -363,20 +363,20 @@ paths: content: multipart/form-data: schema: - $ref: '#/components/schemas/Body_recognize_face_faces_recognize_post' + $ref: "#/components/schemas/Body_recognize_face_faces_recognize_post" responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/FaceRecognitionResponse' - '422': + $ref: "#/components/schemas/FaceRecognitionResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /faces/{name}/delete: post: tags: @@ -400,20 +400,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeleteFaceImagesBody' + $ref: "#/components/schemas/DeleteFaceImagesBody" responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /faces/{old_name}/rename: put: tags: @@ -435,20 +435,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RenameFaceBody' + $ref: "#/components/schemas/RenameFaceBody" responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /lpr/reprocess: put: tags: @@ -468,17 +468,17 @@ paths: type: string title: Event Id responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /reindex: put: tags: @@ -489,12 +489,12 @@ paths: Requires semantic search to be enabled in the configuration. Returns a success message or an error if semantic search is not enabled. operationId: reindex_embeddings_reindex_put responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' + $ref: "#/components/schemas/GenericResponse" /audio/transcribe: put: tags: @@ -510,20 +510,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AudioTranscriptionBody' + $ref: "#/components/schemas/AudioTranscriptionBody" responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /classification/{name}/dataset: get: tags: @@ -541,17 +541,17 @@ paths: type: string title: Name responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /classification/{name}/train: get: tags: @@ -569,17 +569,17 @@ paths: type: string title: Name responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" post: tags: - Classification @@ -596,18 +596,18 @@ paths: type: string title: Name responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /classification/{name}/dataset/{category}/delete: post: tags: @@ -639,18 +639,18 @@ paths: type: object title: Body responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /classification/{name}/dataset/categorize: post: tags: @@ -676,18 +676,18 @@ paths: type: object title: Body responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /classification/{name}/train/delete: post: tags: @@ -712,18 +712,18 @@ paths: type: object title: Body responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /review: get: tags: @@ -769,7 +769,7 @@ paths: in: query required: false schema: - $ref: '#/components/schemas/SeverityEnum' + $ref: "#/components/schemas/SeverityEnum" - name: before in: query required: false @@ -783,21 +783,21 @@ paths: type: number title: After responses: - '200': + "200": description: Successful Response content: application/json: schema: type: array items: - $ref: '#/components/schemas/ReviewSegmentResponse' + $ref: "#/components/schemas/ReviewSegmentResponse" title: Response Review Review Get - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /review_ids: get: tags: @@ -812,21 +812,21 @@ paths: type: string title: Ids responses: - '200': + "200": description: Successful Response content: application/json: schema: type: array items: - $ref: '#/components/schemas/ReviewSegmentResponse' + $ref: "#/components/schemas/ReviewSegmentResponse" title: Response Review Ids Review Ids Get - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /review/summary: get: tags: @@ -863,18 +863,18 @@ paths: default: utc title: Timezone responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/ReviewSummaryResponse' - '422': + $ref: "#/components/schemas/ReviewSummaryResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /reviews/viewed: post: tags: @@ -886,20 +886,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReviewModifyMultipleBody' + $ref: "#/components/schemas/ReviewModifyMultipleBody" responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /reviews/delete: post: tags: @@ -911,20 +911,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReviewModifyMultipleBody' + $ref: "#/components/schemas/ReviewModifyMultipleBody" responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /review/activity/motion: get: tags: @@ -960,21 +960,21 @@ paths: default: 30 title: Scale responses: - '200': + "200": description: Successful Response content: application/json: schema: type: array items: - $ref: '#/components/schemas/ReviewActivityMotionResponse' + $ref: "#/components/schemas/ReviewActivityMotionResponse" title: Response Motion Activity Review Activity Motion Get - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /review/event/{event_id}: get: tags: @@ -989,18 +989,18 @@ paths: type: string title: Event Id responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/ReviewSegmentResponse' - '422': + $ref: "#/components/schemas/ReviewSegmentResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /review/{review_id}: get: tags: @@ -1015,18 +1015,18 @@ paths: type: string title: Review Id responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/ReviewSegmentResponse' - '422': + $ref: "#/components/schemas/ReviewSegmentResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /review/{review_id}/viewed: delete: tags: @@ -1041,18 +1041,18 @@ paths: type: string title: Review Id responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /review/summarize/start/{start_ts}/end/{end_ts}: post: tags: @@ -1075,17 +1075,17 @@ paths: type: number title: End Ts responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /: get: tags: @@ -1093,7 +1093,7 @@ paths: summary: Is Healthy operationId: is_healthy__get responses: - '200': + "200": description: Successful Response content: text/plain: @@ -1106,7 +1106,7 @@ paths: summary: Config Schema operationId: config_schema_config_schema_json_get responses: - '200': + "200": description: Successful Response content: application/json: @@ -1118,7 +1118,7 @@ paths: summary: Go2Rtc Streams operationId: go2rtc_streams_go2rtc_streams_get responses: - '200': + "200": description: Successful Response content: application/json: @@ -1137,17 +1137,17 @@ paths: type: string title: Camera Name responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /version: get: tags: @@ -1155,7 +1155,7 @@ paths: summary: Version operationId: version_version_get responses: - '200': + "200": description: Successful Response content: text/plain: @@ -1168,7 +1168,7 @@ paths: summary: Stats operationId: stats_stats_get responses: - '200': + "200": description: Successful Response content: application/json: @@ -1187,17 +1187,17 @@ paths: type: string title: Keys responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /metrics: get: tags: @@ -1206,7 +1206,7 @@ paths: description: Expose Prometheus metrics endpoint and update metrics with latest stats operationId: metrics_metrics_get responses: - '200': + "200": description: Successful Response content: application/json: @@ -1218,7 +1218,7 @@ paths: summary: Config operationId: config_config_get responses: - '200': + "200": description: Successful Response content: application/json: @@ -1230,7 +1230,7 @@ paths: summary: Config Raw operationId: config_raw_config_raw_get responses: - '200': + "200": description: Successful Response content: application/json: @@ -1255,17 +1255,17 @@ paths: schema: title: Body responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /config/set: put: tags: @@ -1277,19 +1277,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AppConfigSetBody' + $ref: "#/components/schemas/AppConfigSetBody" responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /ffprobe: get: tags: @@ -1302,20 +1302,20 @@ paths: required: false schema: type: string - default: '' + default: "" title: Paths responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /vainfo: get: tags: @@ -1323,7 +1323,7 @@ paths: summary: Vainfo operationId: vainfo_vainfo_get responses: - '200': + "200": description: Successful Response content: application/json: @@ -1335,7 +1335,7 @@ paths: summary: Nvinfo operationId: nvinfo_nvinfo_get responses: - '200': + "200": description: Successful Response content: application/json: @@ -1365,7 +1365,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Download - name: stream in: query @@ -1373,7 +1373,7 @@ paths: schema: anyOf: - type: boolean - - type: 'null' + - type: "null" default: false title: Stream - name: start @@ -1382,7 +1382,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" default: 0 title: Start - name: end @@ -1391,20 +1391,20 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: End responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /restart: post: tags: @@ -1412,7 +1412,7 @@ paths: summary: Restart operationId: restart_restart_post responses: - '200': + "200": description: Successful Response content: application/json: @@ -1429,20 +1429,20 @@ paths: required: false schema: type: string - default: '' + default: "" title: Camera responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /sub_labels: get: tags: @@ -1456,20 +1456,20 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Split Joined responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /plus/models: get: tags: @@ -1485,17 +1485,17 @@ paths: default: false title: Filterbycurrentmodeldetector responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /recognized_license_plates: get: tags: @@ -1509,20 +1509,20 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Split Joined responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /timeline: get: tags: @@ -1550,20 +1550,20 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Source Id responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /timeline/hourly: get: tags: @@ -1578,7 +1578,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: all title: Cameras - name: labels @@ -1587,7 +1587,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: all title: Labels - name: after @@ -1596,7 +1596,7 @@ paths: schema: anyOf: - type: number - - type: 'null' + - type: "null" title: After - name: before in: query @@ -1604,7 +1604,7 @@ paths: schema: anyOf: - type: number - - type: 'null' + - type: "null" title: Before - name: limit in: query @@ -1612,7 +1612,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" default: 200 title: Limit - name: timezone @@ -1621,21 +1621,21 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: utc title: Timezone responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /preview/{camera_name}/start/{start_ts}/end/{end_ts}: get: tags: @@ -1654,7 +1654,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera Name - name: start_ts in: path @@ -1669,23 +1669,23 @@ paths: type: number title: End Ts responses: - '200': + "200": description: Successful Response content: application/json: schema: type: array items: - $ref: '#/components/schemas/PreviewModel' + $ref: "#/components/schemas/PreviewModel" title: >- Response Preview Ts Preview Camera Name Start Start Ts End End Ts Get - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /preview/{year_month}/{day}/{hour}/{camera_name}/{tz_name}: get: tags: @@ -1723,7 +1723,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera Name - name: tz_name in: path @@ -1732,23 +1732,23 @@ paths: type: string title: Tz Name responses: - '200': + "200": description: Successful Response content: application/json: schema: type: array items: - $ref: '#/components/schemas/PreviewModel' + $ref: "#/components/schemas/PreviewModel" title: >- Response Preview Hour Preview Year Month Day Hour Camera Name Tz Name Get - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /preview/{camera_name}/start/{start_ts}/end/{end_ts}/frames: get: tags: @@ -1768,7 +1768,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera Name - name: start_ts in: path @@ -1783,7 +1783,7 @@ paths: type: number title: End Ts responses: - '200': + "200": description: Successful Response content: application/json: @@ -1794,12 +1794,12 @@ paths: title: >- Response Get Preview Frames From Cache Preview Camera Name Start Start Ts End End Ts Frames Get - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /notifications/pubkey: get: tags: @@ -1810,7 +1810,7 @@ paths: Returns the public key or an error if notifications are not enabled. operationId: get_vapid_pub_key_notifications_pubkey_get responses: - '200': + "200": description: Successful Response content: application/json: @@ -1831,17 +1831,17 @@ paths: type: object title: Body responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /exports: get: tags: @@ -1852,14 +1852,14 @@ paths: Returns a list of exports ordered by date (most recent first). operationId: get_exports_exports_get responses: - '200': + "200": description: Successful Response content: application/json: schema: type: array items: - $ref: '#/components/schemas/ExportModel' + $ref: "#/components/schemas/ExportModel" title: Response Get Exports Exports Get /export/{camera_name}/start/{start_time}/end/{end_time}: post: @@ -1880,7 +1880,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera Name - name: start_time in: path @@ -1899,20 +1899,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExportRecordingsBody' + $ref: "#/components/schemas/ExportRecordingsBody" responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/StartExportResponse' - '422': + $ref: "#/components/schemas/StartExportResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /export/{event_id}/rename: patch: tags: @@ -1934,20 +1934,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExportRenameBody' + $ref: "#/components/schemas/ExportRenameBody" responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /export/{event_id}: delete: tags: @@ -1962,18 +1962,18 @@ paths: type: string title: Event Id responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /exports/{export_id}: get: tags: @@ -1991,18 +1991,18 @@ paths: type: string title: Export Id responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/ExportModel' - '422': + $ref: "#/components/schemas/ExportModel" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /events: get: tags: @@ -2017,7 +2017,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: all title: Camera - name: cameras @@ -2026,7 +2026,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: all title: Cameras - name: label @@ -2035,7 +2035,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: all title: Label - name: labels @@ -2044,7 +2044,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: all title: Labels - name: sub_label @@ -2053,7 +2053,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: all title: Sub Label - name: sub_labels @@ -2062,7 +2062,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: all title: Sub Labels - name: zone @@ -2071,7 +2071,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: all title: Zone - name: zones @@ -2080,7 +2080,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: all title: Zones - name: limit @@ -2089,7 +2089,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" default: 100 title: Limit - name: after @@ -2098,7 +2098,7 @@ paths: schema: anyOf: - type: number - - type: 'null' + - type: "null" title: After - name: before in: query @@ -2106,7 +2106,7 @@ paths: schema: anyOf: - type: number - - type: 'null' + - type: "null" title: Before - name: time_range in: query @@ -2114,7 +2114,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: 00:00,24:00 title: Time Range - name: has_clip @@ -2123,7 +2123,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Has Clip - name: has_snapshot in: query @@ -2131,7 +2131,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Has Snapshot - name: in_progress in: query @@ -2139,7 +2139,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: In Progress - name: include_thumbnails in: query @@ -2147,7 +2147,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" default: 1 title: Include Thumbnails - name: favorites @@ -2156,7 +2156,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Favorites - name: min_score in: query @@ -2164,7 +2164,7 @@ paths: schema: anyOf: - type: number - - type: 'null' + - type: "null" title: Min Score - name: max_score in: query @@ -2172,7 +2172,7 @@ paths: schema: anyOf: - type: number - - type: 'null' + - type: "null" title: Max Score - name: min_speed in: query @@ -2180,7 +2180,7 @@ paths: schema: anyOf: - type: number - - type: 'null' + - type: "null" title: Min Speed - name: max_speed in: query @@ -2188,7 +2188,7 @@ paths: schema: anyOf: - type: number - - type: 'null' + - type: "null" title: Max Speed - name: recognized_license_plate in: query @@ -2196,7 +2196,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: all title: Recognized License Plate - name: is_submitted @@ -2205,7 +2205,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Is Submitted - name: min_length in: query @@ -2213,7 +2213,7 @@ paths: schema: anyOf: - type: number - - type: 'null' + - type: "null" title: Min Length - name: max_length in: query @@ -2221,7 +2221,7 @@ paths: schema: anyOf: - type: number - - type: 'null' + - type: "null" title: Max Length - name: event_id in: query @@ -2229,7 +2229,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Event Id - name: sort in: query @@ -2237,7 +2237,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Sort - name: timezone in: query @@ -2245,25 +2245,25 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: utc title: Timezone responses: - '200': + "200": description: Successful Response content: application/json: schema: type: array items: - $ref: '#/components/schemas/EventResponse' + $ref: "#/components/schemas/EventResponse" title: Response Events Events Get - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /events/explore: get: tags: @@ -2282,21 +2282,21 @@ paths: default: 10 title: Limit responses: - '200': + "200": description: Successful Response content: application/json: schema: type: array items: - $ref: '#/components/schemas/EventResponse' + $ref: "#/components/schemas/EventResponse" title: Response Events Explore Events Explore Get - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /event_ids: get: tags: @@ -2314,21 +2314,21 @@ paths: type: string title: Ids responses: - '200': + "200": description: Successful Response content: application/json: schema: type: array items: - $ref: '#/components/schemas/EventResponse' + $ref: "#/components/schemas/EventResponse" title: Response Event Ids Event Ids Get - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /events/search: get: tags: @@ -2345,7 +2345,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Query - name: event_id in: query @@ -2353,7 +2353,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Event Id - name: search_type in: query @@ -2361,7 +2361,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: thumbnail title: Search Type - name: include_thumbnails @@ -2370,7 +2370,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" default: 1 title: Include Thumbnails - name: limit @@ -2379,7 +2379,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" default: 50 title: Limit - name: cameras @@ -2388,7 +2388,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: all title: Cameras - name: labels @@ -2397,7 +2397,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: all title: Labels - name: zones @@ -2406,7 +2406,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: all title: Zones - name: after @@ -2415,7 +2415,7 @@ paths: schema: anyOf: - type: number - - type: 'null' + - type: "null" title: After - name: before in: query @@ -2423,7 +2423,7 @@ paths: schema: anyOf: - type: number - - type: 'null' + - type: "null" title: Before - name: time_range in: query @@ -2431,7 +2431,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: 00:00,24:00 title: Time Range - name: has_clip @@ -2440,7 +2440,7 @@ paths: schema: anyOf: - type: boolean - - type: 'null' + - type: "null" title: Has Clip - name: has_snapshot in: query @@ -2448,7 +2448,7 @@ paths: schema: anyOf: - type: boolean - - type: 'null' + - type: "null" title: Has Snapshot - name: is_submitted in: query @@ -2456,7 +2456,7 @@ paths: schema: anyOf: - type: boolean - - type: 'null' + - type: "null" title: Is Submitted - name: timezone in: query @@ -2464,7 +2464,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: utc title: Timezone - name: min_score @@ -2473,7 +2473,7 @@ paths: schema: anyOf: - type: number - - type: 'null' + - type: "null" title: Min Score - name: max_score in: query @@ -2481,7 +2481,7 @@ paths: schema: anyOf: - type: number - - type: 'null' + - type: "null" title: Max Score - name: min_speed in: query @@ -2489,7 +2489,7 @@ paths: schema: anyOf: - type: number - - type: 'null' + - type: "null" title: Min Speed - name: max_speed in: query @@ -2497,7 +2497,7 @@ paths: schema: anyOf: - type: number - - type: 'null' + - type: "null" title: Max Speed - name: recognized_license_plate in: query @@ -2505,7 +2505,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: all title: Recognized License Plate - name: sort @@ -2514,20 +2514,20 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Sort responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /events/summary: get: tags: @@ -2541,7 +2541,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: utc title: Timezone - name: has_clip @@ -2550,7 +2550,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Has Clip - name: has_snapshot in: query @@ -2558,20 +2558,20 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Has Snapshot responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /events/{event_id}: get: tags: @@ -2587,18 +2587,18 @@ paths: type: string title: Event Id responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/EventResponse' - '422': + $ref: "#/components/schemas/EventResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" delete: tags: - Events @@ -2615,18 +2615,18 @@ paths: type: string title: Event Id responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /events/{event_id}/retain: post: tags: @@ -2645,18 +2645,18 @@ paths: type: string title: Event Id responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" delete: tags: - Events @@ -2674,18 +2674,18 @@ paths: type: string title: Event Id responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /events/{event_id}/plus: post: tags: @@ -2706,20 +2706,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SubmitPlusBody' + $ref: "#/components/schemas/SubmitPlusBody" responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/EventUploadPlusResponse' - '422': + $ref: "#/components/schemas/EventUploadPlusResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /events/{event_id}/false_positive: put: tags: @@ -2738,18 +2738,18 @@ paths: type: string title: Event Id responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/EventUploadPlusResponse' - '422': + $ref: "#/components/schemas/EventUploadPlusResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /events/{event_id}/sub_label: post: tags: @@ -2771,20 +2771,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EventsSubLabelBody' + $ref: "#/components/schemas/EventsSubLabelBody" responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /events/{event_id}/recognized_license_plate: post: tags: @@ -2806,20 +2806,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EventsLPRBody' + $ref: "#/components/schemas/EventsLPRBody" responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /events/{event_id}/description: post: tags: @@ -2841,20 +2841,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EventsDescriptionBody' + $ref: "#/components/schemas/EventsDescriptionBody" responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /events/{event_id}/description/regenerate: put: tags: @@ -2876,8 +2876,8 @@ paths: required: false schema: anyOf: - - $ref: '#/components/schemas/RegenerateDescriptionEnum' - - type: 'null' + - $ref: "#/components/schemas/RegenerateDescriptionEnum" + - type: "null" default: thumbnails title: Source - name: force @@ -2886,22 +2886,22 @@ paths: schema: anyOf: - type: boolean - - type: 'null' + - type: "null" default: false title: Force responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /description/generate: post: tags: @@ -2916,20 +2916,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EventsDescriptionBody' + $ref: "#/components/schemas/EventsDescriptionBody" responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /events/: delete: tags: @@ -2944,20 +2944,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EventsDeleteBody' + $ref: "#/components/schemas/EventsDeleteBody" responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/EventMultiDeleteResponse' - '422': + $ref: "#/components/schemas/EventMultiDeleteResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /events/{camera_name}/{label}/create: post: tags: @@ -2987,26 +2987,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EventsCreateBody' + $ref: "#/components/schemas/EventsCreateBody" default: - source_type: api score: 0 duration: 30 include_recording: true draw: {} responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/EventCreateResponse' - '422': + $ref: "#/components/schemas/EventCreateResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /events/{event_id}/end: put: tags: @@ -3029,20 +3028,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EventsEndBody' + $ref: "#/components/schemas/EventsEndBody" responses: - '200': + "200": description: Successful Response content: application/json: schema: - $ref: '#/components/schemas/GenericResponse' - '422': + $ref: "#/components/schemas/GenericResponse" + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /trigger/embedding: post: tags: @@ -3070,21 +3069,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TriggerEmbeddingBody' + $ref: "#/components/schemas/TriggerEmbeddingBody" responses: - '200': + "200": description: Successful Response content: application/json: schema: type: object title: Response Create Trigger Embedding Trigger Embedding Post - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /trigger/embedding/{camera_name}/{name}: put: tags: @@ -3112,9 +3111,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TriggerEmbeddingBody' + $ref: "#/components/schemas/TriggerEmbeddingBody" responses: - '200': + "200": description: Successful Response content: application/json: @@ -3123,12 +3122,12 @@ paths: title: >- Response Update Trigger Embedding Trigger Embedding Camera Name Name Put - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" delete: tags: - Events @@ -3151,7 +3150,7 @@ paths: type: string title: Name responses: - '200': + "200": description: Successful Response content: application/json: @@ -3160,12 +3159,12 @@ paths: title: >- Response Delete Trigger Embedding Trigger Embedding Camera Name Name Delete - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /triggers/status/{camera_name}: get: tags: @@ -3183,19 +3182,19 @@ paths: type: string title: Camera Name responses: - '200': + "200": description: Successful Response content: application/json: schema: type: object title: Response Get Triggers Status Triggers Status Camera Name Get - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /{camera_name}: get: tags: @@ -3209,7 +3208,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera Name - name: fps in: query @@ -3231,7 +3230,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Bbox - name: timestamp in: query @@ -3239,7 +3238,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Timestamp - name: zones in: query @@ -3247,7 +3246,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Zones - name: mask in: query @@ -3255,7 +3254,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Mask - name: motion in: query @@ -3263,7 +3262,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Motion - name: regions in: query @@ -3271,20 +3270,20 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Regions responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /{camera_name}/ptz/info: get: tags: @@ -3298,20 +3297,20 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera Name responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /{camera_name}/latest.{extension}: get: tags: @@ -3325,20 +3324,20 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera Name - name: extension in: path required: true schema: - $ref: '#/components/schemas/Extension' + $ref: "#/components/schemas/Extension" - name: bbox in: query required: false schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Bbox - name: timestamp in: query @@ -3346,7 +3345,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Timestamp - name: zones in: query @@ -3354,7 +3353,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Zones - name: mask in: query @@ -3362,7 +3361,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Mask - name: motion in: query @@ -3370,7 +3369,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Motion - name: paths in: query @@ -3378,7 +3377,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Paths - name: regions in: query @@ -3386,7 +3385,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Regions - name: quality in: query @@ -3394,7 +3393,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" default: 70 title: Quality - name: height @@ -3403,7 +3402,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Height - name: store in: query @@ -3411,20 +3410,20 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Store responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /{camera_name}/recordings/{frame_time}/snapshot.{format}: get: tags: @@ -3439,7 +3438,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera Name - name: frame_time in: path @@ -3463,17 +3462,17 @@ paths: type: integer title: Height responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /{camera_name}/plus/{frame_time}: post: tags: @@ -3487,7 +3486,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera Name - name: frame_time in: path @@ -3496,17 +3495,17 @@ paths: type: string title: Frame Time responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /recordings/storage: get: tags: @@ -3514,7 +3513,7 @@ paths: summary: Get Recordings Storage Usage operationId: get_recordings_storage_usage_recordings_storage_get responses: - '200': + "200": description: Successful Response content: application/json: @@ -3540,21 +3539,21 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" default: all title: Cameras responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /{camera_name}/recordings/summary: get: tags: @@ -3569,7 +3568,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera Name - name: timezone in: query @@ -3579,17 +3578,17 @@ paths: default: utc title: Timezone responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /{camera_name}/recordings: get: tags: @@ -3606,7 +3605,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera Name - name: after in: query @@ -3623,17 +3622,17 @@ paths: default: 1759935670.40172 title: Before responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /recordings/unavailable: get: tags: @@ -3669,7 +3668,7 @@ paths: default: 30 title: Scale responses: - '200': + "200": description: Successful Response content: application/json: @@ -3678,12 +3677,12 @@ paths: items: type: object title: Response No Recordings Recordings Unavailable Get - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /{camera_name}/start/{start_ts}/end/{end_ts}/clip.mp4: get: tags: @@ -3700,7 +3699,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera Name - name: start_ts in: path @@ -3715,17 +3714,17 @@ paths: type: number title: End Ts responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /vod/{camera_name}/start/{start_ts}/end/{end_ts}: get: tags: @@ -3742,7 +3741,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera Name - name: start_ts in: path @@ -3757,17 +3756,17 @@ paths: type: number title: End Ts responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /vod/{year_month}/{day}/{hour}/{camera_name}: get: tags: @@ -3802,20 +3801,20 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera Name responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /vod/{year_month}/{day}/{hour}/{camera_name}/{tz_name}: get: tags: @@ -3851,7 +3850,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera Name - name: tz_name in: path @@ -3860,17 +3859,17 @@ paths: type: string title: Tz Name responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /vod/event/{event_id}: get: tags: @@ -3897,17 +3896,17 @@ paths: title: Padding description: Padding to apply to the vod. responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /events/{event_id}/snapshot.jpg: get: tags: @@ -3931,7 +3930,7 @@ paths: schema: anyOf: - type: boolean - - type: 'null' + - type: "null" default: false title: Download - name: timestamp @@ -3940,7 +3939,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Timestamp - name: bbox in: query @@ -3948,7 +3947,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Bbox - name: crop in: query @@ -3956,7 +3955,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Crop - name: height in: query @@ -3964,7 +3963,7 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" title: Height - name: quality in: query @@ -3972,21 +3971,21 @@ paths: schema: anyOf: - type: integer - - type: 'null' + - type: "null" default: 70 title: Quality responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /events/{event_id}/thumbnail.{extension}: get: tags: @@ -4004,7 +4003,7 @@ paths: in: path required: true schema: - $ref: '#/components/schemas/Extension' + $ref: "#/components/schemas/Extension" - name: max_cache_age in: query required: false @@ -4025,17 +4024,17 @@ paths: default: ios title: Format responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /{camera_name}/grid.jpg: get: tags: @@ -4049,7 +4048,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera Name - name: color in: query @@ -4066,17 +4065,17 @@ paths: default: 0.5 title: Font Scale responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /events/{event_id}/snapshot-clean.webp: get: tags: @@ -4098,17 +4097,17 @@ paths: default: false title: Download responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /events/{event_id}/clip.mp4: get: tags: @@ -4132,17 +4131,17 @@ paths: title: Padding description: Padding to apply to clip. responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /events/{event_id}/preview.gif: get: tags: @@ -4157,17 +4156,17 @@ paths: type: string title: Event Id responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /{camera_name}/start/{start_ts}/end/{end_ts}/preview.gif: get: tags: @@ -4181,7 +4180,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera Name - name: start_ts in: path @@ -4205,17 +4204,17 @@ paths: title: Max Cache Age description: Max cache age in seconds. Default 30 days in seconds. responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /{camera_name}/start/{start_ts}/end/{end_ts}/preview.mp4: get: tags: @@ -4229,7 +4228,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera Name - name: start_ts in: path @@ -4253,17 +4252,17 @@ paths: title: Max Cache Age description: Max cache age in seconds. Default 7 days in seconds. responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /review/{event_id}/preview: get: tags: @@ -4288,17 +4287,17 @@ paths: default: gif title: Format responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /preview/{file_name}/thumbnail.webp: get: tags: @@ -4314,17 +4313,17 @@ paths: type: string title: File Name responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /preview/{file_name}/thumbnail.jpg: get: tags: @@ -4340,17 +4339,17 @@ paths: type: string title: File Name responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /{camera_name}/{label}/thumbnail.jpg: get: tags: @@ -4364,7 +4363,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera Name - name: label in: path @@ -4373,17 +4372,17 @@ paths: type: string title: Label responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /{camera_name}/{label}/best.jpg: get: tags: @@ -4397,7 +4396,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera Name - name: label in: path @@ -4406,17 +4405,17 @@ paths: type: string title: Label responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /{camera_name}/{label}/clip.mp4: get: tags: @@ -4430,7 +4429,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera Name - name: label in: path @@ -4439,17 +4438,17 @@ paths: type: string title: Label responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" /{camera_name}/{label}/snapshot.jpg: get: tags: @@ -4466,7 +4465,7 @@ paths: schema: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera Name - name: label in: path @@ -4475,17 +4474,17 @@ paths: type: string title: Label responses: - '200': + "200": description: Successful Response content: application/json: schema: {} - '422': + "422": description: Validation Error content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" components: schemas: AppConfigSetBody: @@ -4497,12 +4496,12 @@ components: update_topic: anyOf: - type: string - - type: 'null' + - type: "null" title: Update Topic config_data: anyOf: - type: object - - type: 'null' + - type: "null" title: Config Data type: object title: AppConfigSetBody @@ -4530,7 +4529,7 @@ components: role: anyOf: - type: string - - type: 'null' + - type: "null" title: Role default: viewer type: object @@ -4672,7 +4671,7 @@ components: sub_label: anyOf: - type: string - - type: 'null' + - type: "null" title: Sub Label camera: type: string @@ -4683,12 +4682,12 @@ components: end_time: anyOf: - type: number - - type: 'null' + - type: "null" title: End Time false_positive: anyOf: - type: boolean - - type: 'null' + - type: "null" title: False Positive zones: items: @@ -4698,7 +4697,7 @@ components: thumbnail: anyOf: - type: string - - type: 'null' + - type: "null" title: Thumbnail has_clip: type: boolean @@ -4712,22 +4711,22 @@ components: plus_id: anyOf: - type: string - - type: 'null' + - type: "null" title: Plus Id model_hash: anyOf: - type: string - - type: 'null' + - type: "null" title: Model Hash detector_type: anyOf: - type: string - - type: 'null' + - type: "null" title: Detector Type model_type: anyOf: - type: string - - type: 'null' + - type: "null" title: Model Type data: type: object @@ -4767,39 +4766,33 @@ components: title: EventUploadPlusResponse EventsCreateBody: properties: - source_type: - anyOf: - - type: string - - type: 'null' - title: Source Type - default: api sub_label: anyOf: - type: string - - type: 'null' + - type: "null" title: Sub Label score: anyOf: - type: number - - type: 'null' + - type: "null" title: Score default: 0 duration: anyOf: - type: integer - - type: 'null' + - type: "null" title: Duration default: 30 include_recording: anyOf: - type: boolean - - type: 'null' + - type: "null" title: Include Recording default: true draw: anyOf: - type: object - - type: 'null' + - type: "null" title: Draw default: {} type: object @@ -4820,7 +4813,7 @@ components: description: anyOf: - type: string - - type: 'null' + - type: "null" title: The description of the event type: object required: @@ -4831,7 +4824,7 @@ components: end_time: anyOf: - type: number - - type: 'null' + - type: "null" title: End Time type: object title: EventsEndBody @@ -4846,7 +4839,7 @@ components: - type: number maximum: 1 exclusiveMinimum: 0 - - type: 'null' + - type: "null" title: Score for recognized license plate type: object required: @@ -4863,12 +4856,12 @@ components: - type: number maximum: 1 exclusiveMinimum: 0 - - type: 'null' + - type: "null" title: Score for sub label camera: anyOf: - type: string - - type: 'null' + - type: "null" title: Camera this object is detected on. type: object required: @@ -4918,11 +4911,11 @@ components: ExportRecordingsBody: properties: playback: - $ref: '#/components/schemas/PlaybackFactorEnum' + $ref: "#/components/schemas/PlaybackFactorEnum" title: Playback factor default: realtime source: - $ref: '#/components/schemas/PlaybackSourceEnum' + $ref: "#/components/schemas/PlaybackSourceEnum" title: Playback source default: recordings name: @@ -4961,13 +4954,13 @@ components: score: anyOf: - type: number - - type: 'null' + - type: "null" title: Score description: Confidence score of the recognition (0-1) face_name: anyOf: - type: string - - type: 'null' + - type: "null" title: Face Name description: The recognized face name if successful type: object @@ -5016,7 +5009,7 @@ components: properties: detail: items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" type: array title: Detail type: object @@ -5150,7 +5143,7 @@ components: type: boolean title: Has Been Reviewed severity: - $ref: '#/components/schemas/SeverityEnum' + $ref: "#/components/schemas/SeverityEnum" thumb_path: type: string title: Thumb Path @@ -5170,10 +5163,10 @@ components: ReviewSummaryResponse: properties: last24Hours: - $ref: '#/components/schemas/Last24HoursReview' + $ref: "#/components/schemas/Last24HoursReview" root: additionalProperties: - $ref: '#/components/schemas/DayReview' + $ref: "#/components/schemas/DayReview" type: object title: Root type: object @@ -5200,7 +5193,7 @@ components: export_id: anyOf: - type: string - - type: 'null' + - type: "null" title: Export Id description: The export ID if successfully started type: object @@ -5220,7 +5213,7 @@ components: TriggerEmbeddingBody: properties: type: - $ref: '#/components/schemas/TriggerType' + $ref: "#/components/schemas/TriggerType" data: type: string title: Data diff --git a/frigate/api/defs/request/events_body.py b/frigate/api/defs/request/events_body.py index dd18ff8f7..6110e34f5 100644 --- a/frigate/api/defs/request/events_body.py +++ b/frigate/api/defs/request/events_body.py @@ -29,7 +29,6 @@ class EventsDescriptionBody(BaseModel): class EventsCreateBody(BaseModel): - source_type: Optional[str] = "api" sub_label: Optional[str] = None score: Optional[float] = 0 duration: Optional[int] = 30 diff --git a/frigate/api/event.py b/frigate/api/event.py index b8b596cde..1f5578fae 100644 --- a/frigate/api/event.py +++ b/frigate/api/event.py @@ -1620,7 +1620,7 @@ def create_event( body.score, body.sub_label, body.duration, - body.source_type, + "api", body.draw, ), EventMetadataTypeEnum.manual_event_create.value,