mirror of
https://github.com/blakeblackshear/frigate.git
synced 2026-04-27 09:07:41 +03:00
att
This commit is contained in:
Victor Tramontina
parent
c990f35f40
commit
759c94cb34
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: all-recordings-summary-recordings-summary-get
|
||||
title: "All Recordings Summary"
|
||||
description: "Returns true/false by day indicating if recordings exist"
|
||||
sidebar_label: "All Recordings Summary"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJylVMFu2zAM/RWDZyNOi+3iW7EV3YAVG9pslyAoGJt21MmSK9FFPUP/PlB24gRpgRU7xZEeHx+fSA7AWHvI13BLpULYpFCSL5xqWVkDOdwRd874hF1HWYXaU7LtkxL7RJlSFcjK1ImqEkeFdaUytU/oRXmGFGxLDoXmawk5oNYPM+jBd02Drn/tqCaJbtFhQ0xO1A1gsCHIgVVDf6whSEGJvKeOXA8pOHrqlKMS8qgxBV/sqEHIB+C+lUjPTpkapL4KO82QQ8cFpMCKtQBWe+oQ0kO+Ahty6N+RDk3/vYqSTxML6XRiOq0hbI6loNZHUj5NWYOAHPnWGk9e2C+XS/k5faP7rijI+6rTyd0EhhQKa5gMR01tq+NbWZM9eokZZsUhhJDCh8vLc+JfqFUZw5Jr56x7Byu0Tt6f1ai7JEal5UsxNf4coG1xcvsPNirDVJODsAnp/gydw/7IyW92FAghhcbXr/XDHnpL3mNNcCB7GxrNSFZyG+bcdvtIBZ90xzrWNaaecJuZZrZ3dPftMj6P9r2WbA/5slr9OCMc37Yh3lmZwf1k8Q5yyObRy6bRgxQ8uef9zHVOQw475tbnWVZSYxeVUzUyLZ5VSTbDVsUHmYF5lmlboN5Zz/nH5fJixGxkfiobPZ30QgqSaGy05eJisZT6W+u5wdhK0wReaenqw3K5Pyg9adVhbsz/WVmTuUwvnLUaVeybWN0w2baGOUzsmuRsUpCS5X4Ytujpp9MhyPG4MsTOUnnc6qOl8Zv605X2jLqL3oipb8DnjTSjN/LHKYFDvpZx2BGW5GLaMeyqKKjlo6iz6RWWQ6fcXK8ghL816Bpg
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"All Recordings Summary"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/recordings/summary"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Returns true/false by day indicating if recordings exist
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"timezone","in":"query","required":false,"schema":{"type":"string","default":"utc","title":"Timezone"}},{"name":"cameras","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"all","title":"Cameras"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
62
docs/docs/integrations/api/auth-auth-get.api.mdx
Normal file
62
docs/docs/integrations/api/auth-auth-get.api.mdx
Normal file
@ -0,0 +1,62 @@
|
||||
---
|
||||
id: auth-auth-get
|
||||
title: "Auth"
|
||||
description: "Auth"
|
||||
sidebar_label: "Auth"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJxlkUtvwyAQhP9KNWcUu5V64dZDVfXaxymKqg3exLTYUFhHjZD/e7VO1CcHEDDLfjNUCO0L7Bo3k/TYGMTEmcTH8b6DBU3SvyzTngUGmUuKY+ECW3HVtrp0XFz2SWtg8Tg5x6XspnDxcBbDwMVReBSVU0rBu6VF81q0pqK4ngeCrbMO8+fJBc1gYOmjQp1QEkkPi4ZOt4XzgbNaqZhygEUvkoptmo6HuNplvyfh1cF3HBtKHrP5KbRNE6Kj0Mci9rptL0+ajYEfd1EZxUtgWMBAG53Q2tXlqsVskGKRgRYzIw38Tf3LSoUck14Kf0iTAvlRixeMena0XkLXr1AW3de6pcLPOcyzHr9PnI+w643BgbKnrWKtN7NBz9RxXiJ446MyOMdJwzpQmLTvv/DV4Vewd7dPmOdPHrqz1g==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Auth"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/auth"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Auth
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: camera-ptz-info-camera-name-ptz-info-get
|
||||
title: "Camera Ptz Info"
|
||||
description: "Camera Ptz Info"
|
||||
sidebar_label: "Camera Ptz Info"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVMFu2zAM/ZWApw0Q4rTYLroNa7EVWLeiy3YJjICxaVudbakSHSwx9O+DZCdOlnbATpbpx6fHR9I9MJYO5AruKVcIqQBtyCIr3d7lICHDhiyuDe/Xqi30ej0GWmxoPYVLYhBg0GJDTDYw9hAwE0V8E6BakGCQKxBg6blTlnKQbDsS4LKKGgTZA+9MSHVsVVuCAFZch8DHyDX7Gri8TwOFM7p15ELW9WIRHjm5zCoTagAJ37ssI+eKrp49jmAQkOmWqeUAR2NqlcWSkycXcvpJiffeC3h3fX1J/BNrlce02a212v4HKxgbbGY16M6JUdXhpJgadwmodXb2FdvdtyJ6fG6UF8eIaplKsuBTLw4xtBZ3J25+0YNA8AIaV/7L+HtyDkuCI9nr0GjGbBm++uluvXmijM+avop1DVePuHSimewd3H29jJvBvpcuO0A+L5cPF4RDb8+bOg7YA+9nd22hgzriSodVOMw4VyAh6U/G2ieG94ka8I7s9rABna1BQsVsnEySnBo9L6wqkWm+VTnpBI2KTZuAMklqnWFdacfy/WJxNWDSsDmFjr6PNYGAcNGgezG/mi+CR0Y7bjCO27h/lyWdlXxsJNNvTkyNKs5DVNSP5a5Anm+x4T2MilIBQWsA9f0GHf2wtfch/NyR3YFcpQK2aBVuguxVD7ly4ZyDLLB2dKHnuEXw5nEclrczEC/rPMxEGyZii3U3WvOLdn/9e+ImVIQ52ShjQHzIMjJ8knuxuMH74xB8ul2C938Al4zG6g==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Camera Ptz Info"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/{camera_name}/ptz/info"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Camera Ptz Info
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"camera_name","in":"path","required":true,"schema":{"type":"string","title":"Camera Name"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
62
docs/docs/integrations/api/config-config-get.api.mdx
Normal file
62
docs/docs/integrations/api/config-config-get.api.mdx
Normal file
@ -0,0 +1,62 @@
|
||||
---
|
||||
id: config-config-get
|
||||
title: "Config"
|
||||
description: "Config"
|
||||
sidebar_label: "Config"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJxlkU9PwzAMxb8Keudo7ZC45DYhhLjy51RVKEu9NZA2IXEnpqjfHbkbaEAuluJn+/fsAjb7DN1gEyNahRApGXZhfOigYcO4c/vXc9gTQyFRjmHMlKELrutaQkfZJhelDhpPk7WU827yV49nMZT0YhpZ5CZG7+wypnrLUlOQbU+DgS6zPPWn5e1CAIWBuA+CdoKJhntoVPY7nykdKImjgil5aPTMMeuq6mgIq11ye8O0OriOQmWiw6wuhbqqfLDG9yGzvqnr9UnTKrhxF4STHXuCBhRk0AmvXq1XNWaFGDIPZjE0moEuyX8ZKuBjlDTTJ1fRGzdK+QJSzq6a8/rlLMIjP6VsTaaX5OdZvj8mSkfoplU4mOTMVtCadlboyXSUljW80xEaG2spysoOxk8y+d8RxOXPeu/vnjHPX3jMt/0=
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Config"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/config"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Config
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
62
docs/docs/integrations/api/config-raw-config-raw-get.api.mdx
Normal file
62
docs/docs/integrations/api/config-raw-config-raw-get.api.mdx
Normal file
@ -0,0 +1,62 @@
|
||||
---
|
||||
id: config-raw-config-raw-get
|
||||
title: "Config Raw"
|
||||
description: "Config Raw"
|
||||
sidebar_label: "Config Raw"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJxlkUFrGzEQhf9KeGdhbQq56BZKKb0mzcmYMNGOvUq0K0WatWPE/vcya1PSVBeJ4Wnme28ahA4Vbov7nLEzSJkLSUjTrx4OPk37cHgudHr+9DywwKBwzWmqXOEavnWdXj1XX0LW/3B4nL3nWvdzvHm4imG0p/AkKqecY/DrOPta9U9D9QOPBNcWPeZLy+8rxc0DnWAwsgxJMS9AmWSAg72Q2rJqKpcjF3XYMJcIh0EkV2dtz2Pa7Es4kPDmGHpOlnLAYj4LnbUxeYpDquLuuu72otkZhGmflFeCRIYDDHTQBbPb3G46LAY5VRlpNTbRyF8d/GOuQc5ZJcIfYnOkMGmLFaZd3W2vK9H86aQLUzKtt/ZClZ9KXBYtv89cznDbncGRSqAXhdzuFoOBqeeyBvLGZzjce89ZAzxSnHX+f2tRv3/D/vnjN5blD9HUwRY=
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Config Raw"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/config/raw"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Config Raw
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: config-save-config-save-post
|
||||
title: "Config Save"
|
||||
description: "Config Save"
|
||||
sidebar_label: "Config Save"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVF1v0zAU/SvVfQLJNN0EL34bAwkk0Kat8FJV021ym3o4sWc7HVXk/46unX6Ebkg8JbLPPefcL/cQsPYgF3BlLSwFGEsOgzLt1woklKZdq/rB45YeTv+t8QEEWHTYUCDHDD202BBISAhjmQQEqBYkPHXkdiDA0VOnHFUgg+tIgC831CDIHsLOptjgVFuDgKCC5oN73NLkJpPFuMwU5MNHU+047m/G0rSB2pAo6XcorEZ20J9KDdSJIsYYmdRb03ryfH85m/GnIl86lZUl3HdlSd6vOz25G8AwUkNrtSpT6YpHb8aaWeX95eU58U/Uqkphk8/OGfcfrGAdtyuo7LuigErznwrU+HOANuXoFtvdzTp1blz9KA4nqg1Uk4O4jGJ/hs7h7qRF30w2CFFA4+t/dfM7eY81wYHsdWgqxmTOt/GobVaPVIbRJC1SXll6wC2PNMfy5uq+nsanXL6XxPaQL/P57Rlh7u24qddpVyY8vOyMwsbwOh3WJmxAQpE3qvAZ5clt95vUOQ0SNiFYL4uiosZM107VGGi6VRWZAq1KbToCZVFoU6LeGB/kh9nsImOWvIFrczr3IICFstPZ9GI646qwtwbTgA17PE5ilOChbSc7FkV20w/5LYbXg1NjiqUA9sYXfb9CTz+cjpGP8+vAeVfK40pzV9eoPZ2pHjYD3twNA/B2AuJlN79od/YabVF3qQZcmC06xXIgFzzeG8KKXPKRQ6+z2rs0hMfYkcoee1WWZMMJ6mxzWfEwCbc393MQsBpescZUHOPwmUcbn5PDGP8A1yXqOA==
|
||||
sidebar_class_name: "post api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Config Save"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/config/save"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Config Save
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"save_option","in":"query","required":true,"schema":{"type":"string","title":"Save Option"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={{"required":true,"content":{"text/plain":{"schema":{"title":"Body"}}}}}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,62 @@
|
||||
---
|
||||
id: config-schema-config-schema-json-get
|
||||
title: "Config Schema"
|
||||
description: "Config Schema"
|
||||
sidebar_label: "Config Schema"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJxtkU9LxDAQxb+KvHNoquAlNxERr66elrLEdHYbTZuYTBeX0u8u0y7iv1xCJo83vzczge2hwGxxkxIahZgoW/ZxeGhh4OKw94ddcR31dvfz9VrisDsQQyFTSXEoVGAmXNW1XC0Vl30SKxhsRueolP0YLh7PYiixZxpY5Dal4N3SWYuz1NZGMNMsR/2yvF1oLjarSKEn7qJAr0zJcgcDvULr1atarBUK5SNlyT1hzAEGHXMqRuuW+ljtsz9YpuroW4raJo9ZfRcarUN0NnSxsLmu68tV0yj4YR8FnT0HggEUpNFKXFeXVY1ZIcXCvV0yDranf8L8iDqBT0lUTB+sU7B+EJeFZzoH3Z53JeG+RW0UBFL+p+nFFnrOYZ6l/D5SPsFsG4Wjzd6+CO+2mRU6si3lZTZvdILBjXOUZKZHG0bh+LMsif41//u7J8zzJwgizek=
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Config Schema"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/config/schema.json"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Config Schema
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
70
docs/docs/integrations/api/config-set-config-set-put.api.mdx
Normal file
70
docs/docs/integrations/api/config-set-config-set-put.api.mdx
Normal file
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: config-set-config-set-put
|
||||
title: "Config Set"
|
||||
description: "Config Set"
|
||||
sidebar_label: "Config Set"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVE1v2zAM/SsBz1qcFNtFt24rsAEbVrTpLkFQMDbjqJMtVaLbBoH/+0DJrdOmLbZcIlOPX++R2gNjHUEv4dR7WClwngKyce33CjSUrt2Y+joSXx8cfcegINBtR5E/u2oHep8+TaAKNIeOlLgytSxX6L01ZYpa3ETXii2WW2pQTj5ITjYUD8LE60CRMSR/3nkCDaZlqimAAjZsxXIxgCcXA1hBRRvsLIOe97169HTrGyr5wPHU+y+pn0vKDfS9wANF79qYKzmZzeSvolgG46V40HDZlSXFuOms5Exg+Pdec5aPJyfHgX+jNVVym5yF4MJ/RH3BYEWMxsrJMDXxGGBd+ewW292vDejlE9GRg2lr6NUR9f1qJBVDwN0Bpz9cLhB6BU2sD4Qb4o3QnxQj1gRPwd6GJjImC7l9TdBx6papr5x6wK3GMCO9md232/ia6Xtver4tFudHAbO2z0XNMza5JPFuiLdOliqvj0fegoYi71UREyZSuKMQkxhdsKBhy+yjLoqKGjfdBFMj0/TOVOQK9CZpNAJ1UVhXot26yPrTbDbPmJUCGZqLcWHPHrDxll5fuHmvwLQbl2QZWgYFUlhuazadT2dCoXeRG0zT2GJDLzt+RsaTxEwPXHiLJk1KKn4/sLEcHpzEBIt+0onY9/s1RroKtu/FfNtR2IFerhTcYTC4liKXMpxbwopCIvAP7XJFskUf0ggJ3HZJ9pcbJUxmj9OyJM/vYlcHcp5fLUDBengGG1eJS8B7mU68z9y5REJ+4MS2B4tt3ckOaMgh5fcXk6HowA==
|
||||
sidebar_class_name: "put api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Config Set"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"put"}
|
||||
path={"/config/set"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Config Set
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"requires_restart":{"type":"integer","title":"Requires Restart","default":1}},"type":"object","title":"AppConfigSetBody"}}}}}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: create-event-events-camera-name-label-create-post
|
||||
title: "Create Event"
|
||||
description: "Create Event"
|
||||
sidebar_label: "Create Event"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJy9Vk2P2zYQ/SvCnFqAXSmb9sJbu1mgC7RNsLvtxTAEShzbTClRISk3hqD/XgxJS/LacRYpUB8MgZx5M/PmiwN4sXXAV3C/x9Y7WDMwHVrhlWkfJHCoLQqPJdJ1/HdlWYsGrShb0WBZllpUqMsySXbGeWDQCSsa9GgJfQASJbRZERioFjh0wu+AgcVPvbIogXvbIwNX77ARwAfwh45Unbeq3QIDr7ymg7uAlf1BWOPIJhvBnf+M/ltAGcd1VEbnfzHyQBq1aT22nj5F12lVB7Lyj860dDZDS9yIXgdBZ3pbY5mMiU4B+WAsAi8YyD4SDvxtQX7XupdYWqyNleRVclpa8Q/wYRwZdJay5BW6M/QBRHt4vwmsnwZHHKWTttcaKLZjuE8BInumazZ7HlwdGbi+imn+Zvy+yhKlU+QXkNq+qdBeRwrKCx+LccngBVDVetx+BfXdEWAB/JaQL2TjgonKGI2ivWriISJljxPSwhZleJxSfG7AVB+x9tdDIN0F5DBSpZzqz9Kx3+9Cz4bKHoO4RdeZ1sW6ui2KWMeutqqL/MJTX9fo3KbX2WMSBvb6pnhRuRFs0YhHJpelE2VGBg06J7Z4rW9/TyIjgzizlLwmHmjIHiRc4mqeGqvJ09mJhYH1C8BI60RPpPbH29tzNv8SWsnAVXZvrbHfTqVEL1ToT+WxcecC2tQnt69o46lz1jM7wlpxWA5KEx0M+XHbV+bmOKu+mBciI46jr2WG4oqmk9wiGzO9kd0vh/Eu0netZX59fv5wBhhze5rUmP4slEIoGL8ztEun1eh3wCGP2zQfFktxzIcwZsc8blNaE2j3xy3aWw0cdt53jue5xMbcbKzaCo83eyXR5HFcLwV5nmtTC70zzvOfiuJNlFkzoIJ6nFfb/WfRdBrPt9WUm8USWBxe2GKvXGKq3ZhQA4lfYECRRg6Lmzc3BeWLSGtEKP204F/Qe8L9VFEeP/u800KFwgx8DIn5VWxc6mV++iDhx7dDYn/NgHgjlWGohMM/rR5HOv7Uoz0AX60Z7IVVoqIIVgNI5ehbAt8I7fDMu6m54bvHVMPfZ8Aue30s1ZYKdS90n1j6Gw8v3lKU8//RdKQpTIUdCok2xB7v7qKZH9JT4qh7NsrI5ajxc11j56/Krhdd9OH90zMwqNJzrDGSdOLyC8VFfpoQdphzaaVq0W77sDwgYtLvX/BGwjM=
|
||||
sidebar_class_name: "post api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Create Event"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/events/{camera_name}/{label}/create"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Create Event
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"camera_name","in":"path","required":true,"schema":{"type":"string","title":"Camera Name"}},{"name":"label","in":"path","required":true,"schema":{"type":"string","title":"Label"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={{"content":{"application/json":{"schema":{"default":{"source_type":"api","score":0,"duration":30,"include_recording":true,"draw":{}},"properties":{"source_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Type","default":"api"},"sub_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sub Label"},"score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Score","default":0},"duration":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration","default":30},"include_recording":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include Recording","default":true},"draw":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Draw","default":{}}},"type":"object","title":"EventsCreateBody"}}}}}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"},"event_id":{"type":"string","title":"Event Id"}},"type":"object","required":["success","message","event_id"],"title":"EventCreateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: create-face-faces-name-create-post
|
||||
title: "Create Face"
|
||||
description: "Create Face"
|
||||
sidebar_label: "Create Face"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVMFu2zAM/ZWApw0Q4jTYLroNW4cN2NaizXYJjICVmVidbakSEyww9O8DZSdpkHbALrYhPZKPj4/ugXETQS/hekcdRygVOE8B2bruawUaTCBkWq3RDI+4WnXY0mo1XngXGRR4DNgSU5BkPQgE9PBSYDvQ4JFrUBDoaWsDVaA5bElBNDW1CLoH3nuJiRxstwEFbLmRgx+SJKVSYqN3XaQo8PlsJq+KognWC1/QcL81hmJcb5vJ3QgGBcZ1TB0LHL1vrMntFY9RYvoThZRSUvBuPr9M/AsbW+WwyXUILvxHVvBBJGU78K6I0TbyZZnaeAlonDm7xW5/s86qniuU1PHEdkwbCpDKpA5nGALun8n4zQ0EISlo4+Zfin+nGHFDcEz2OjSLMVnIbTrVdg+PZPhs2svc11B6xJWnNCd5B3Vfb+PTIN9LxQ6QL4vF7UXCYbbnQ/2YLTz5jEZc0hLXTix/tDTXoKHIri968XIqBteDgkhhd3D7NjSgoWb2URdFRa2broPdINN0ZytyBXqbx3UC6qJonMGmdpH1+9nsasCUsixrlxUfuwEFUmhgPJteTWeijnBsMRtt3LXzZs4aPY6P6Q8XvkGbXZDZ9GOfS8h9ggI9bu3YaqlASAqi7x8w0s/QpCTHT1sKe9DLUsEOg8UH4bvsobJRvivQa2wiXZA5Lg68uRv98XYC6mWSBxt0YoIdNttRk9+0P/xgsutrwopCrj9cfTCGPD8LulhSUfs49Nub+wWk9BcOwLg1
|
||||
sidebar_class_name: "post api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Create Face"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/faces/{name}/create"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Create Face
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
70
docs/docs/integrations/api/create-user-users-post.api.mdx
Normal file
70
docs/docs/integrations/api/create-user-users-post.api.mdx
Normal file
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: create-user-users-post
|
||||
title: "Create User"
|
||||
description: "Create User"
|
||||
sidebar_label: "Create User"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVMFu2zAM/ZWAZy9Oi+2iW7cV2IANDdp0lyAoGJux1cmWKtFJg8D/PlBK6qRduy4HR6afSPE9Pu2AsQqg5nDRcQ2LDKwjj6xt+70EBYUnZLrrAvn4CHfOBoYMPD10FPizLbegdvFVeypBse8og8K2TC3LJ3TO6CKmzO+DbSUWipoalJXzUpA1BXmTEi02JGveOgIFgb1uK8iANRsJ3B4wfQYOQ9hYX76Fnx4wfQbempgb2+3VCtT8+a4+e4q0nTHQL4Y817I3g5JW2BkGBWtNG/LQ99lhj13eU3FgJ9ExH3o6Ou5R2gvnpjawdBUim30vGT0FZ9uQaDmfTOSvpFB47YRJUHDTFQWFsOrM6HoPhvcTn6p8PD9/mfgXGl3GbaNL763/j6zP5CyJURtZaaYmvAQYW5x8fYcuumWqhPbFwDt6j9sjyX/YdECRvAnVW9Pxk0LAKg5TgrwOjWSMZvL1X5pLX6n0Hnck+EBvYvf1Nr4m+v5W7AD5NptNXyRM2p6K+iUaeSRjJicjrq34e+9mh1yDgjxaHDII5NeyEiU6b0BBzeyCyvOSGjteeV0h03itS7I5Oh0FGoAqz40t0NQ2sPo0mZwlzCIDmZjr4eq4fMTGJUsO1h+YH+w9xJKFh8EA3a5slG1PCWQgZ09tT8Zn40m8KWzgBuO07qucMnLC1tMMMD1y7gzqOEqxwd2erGTsIMpKmxLY7ZYY6NabvpfwQ0d+C2q+yGCNXuNSjjeXsa0JS/KR3d+0lbMkf32IwyVw08WBeO41oTntuCgKcvwmdnGk8/TqZgYZLPfXdWNL2eNxI4ziJtFmY/vRiDG2A4Nt1Yk9FKSc8vsDHmUg6A==
|
||||
sidebar_class_name: "post api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Create User"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/users"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Create User
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"username":{"type":"string","title":"Username"},"password":{"type":"string","title":"Password"},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role","default":"viewer"}},"type":"object","required":["username","password"],"title":"AppPostUsersBody"}}}}}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: delete-event-events-event-id-delete
|
||||
title: "Delete Event"
|
||||
description: "Delete Event"
|
||||
sidebar_label: "Delete Event"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJydVE2L2zAQ/SthTi2IOBvai26FDe3ClpZt2kswQbEnsbaypZXGocHovxdJtuNsttvSiz80X2/ezFMHJA4O+AZWR2zIQc5AG7SCpG7uSuBQokLCLQZzerpt/yfL7TaZgYERVtRIaEO2DhpRI3AYHIGBbICDEVQBA4tPrbRYAifbIgNXVFgL4B3QyYQ4R1Y2B2BAklQ4iPBmdyV4n4d4Z3Tj0IWQ5WIRXiW6wkoTgAOHb21RoHP7Vs0eemdgUOiGsKHgLoxRsoh9Zo8uxHQTGMYGFkimCi4lm+Dbaa1QNBOAfUHwDGp0ThzwtXY+9y7es8FH7x6xoAtyNmPlc9L8nOQjNmhlMfbnfUj3brm8puOHULKMzc5W1mr7/1yUSEKq8CUJa3ftoHRxYRXN6cs+7sQlGZ6NJ7IhPKAFn5/pENaK04Sxe50ARoLd4Z/IHZK9slaBjNk6WP82itBXKt37TSZxpjex++c2bhN9LxUbXD6t11+vEqbZXg71NmpvFqURN4QqfZZs1CRVwCFLss26QY0eGDi0x0GsrVXAoSIyjmdZibWe7608CML5UZaoM2FknNfZkWeZ0oVQlXbE3y8WN8knDzrf60h53w4wCIUS5MX8Zr4I9BjtqBZx0/qr4lk3F62OAyT8RZlRQsY9iHC6vs1NumyCVvh47eQMAsJg7bqdcPjdKu/D8VOL9gR8kzM4CivFLoDddFBKF75L4HuhHF4BGWUDbx767Xg7A/YywGEJmrACR6HanpCfeJpejnHvKxQl2oghmT8UBRqaBF7JNNA9Tv12db9ar8D734nK/U4=
|
||||
sidebar_class_name: "delete api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Delete Event"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/events/{event_id}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Delete Event
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"event_id","in":"path","required":true,"schema":{"type":"string","title":"Event Id"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"}},"type":"object","required":["success","message"],"title":"GenericResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: delete-events-events-delete
|
||||
title: "Delete Events"
|
||||
description: "Delete Events"
|
||||
sidebar_label: "Delete Events"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyllU1v2zAMhv+KwbMXp8V20W1bU6xAuw1dtksQBIrN2OpkyZXotEHg/z5QcuKk6QfQ5WJLoii+70MrWyBZehAzmKzRkId5CrZBJ0lZc1WAgAI1Ei4wLO8eizgLKTi8b9HTF1tsQGzDUDksQJBrMYXcGkJDvCSbRqs8JM7uvDU85/MKa8lvjeNjSaHnUThmoYowUIR1eKFNgyDAk1OmhC7dTUjn5AZSIEWax9MKk5AhubrwCdmkr7YbttjlHebU1x8Lnh2cOh+SRV8uQoagsus4j0PfWONjuefjMT8K9LlTDSsEAb/aPEfvV61ObvtgeLchPiY7cGFprUZpDmT3B7IxUXDR43qXiVFxkfR90aVgLC1WtjX/lfa7peSSk+wTvwFlp/xE1DMFPcV202pSUcgeQcT38fz8lNgfqVUReCQT56x7P64CSSp9ZNBxgLb50ao0mx8rELNTI/czyhCW6KCbv+zutY0FMoDal6dghtAb9F6WOKB6OTSYkUx59S1arCse3ccdIBnsje6+1nvBvucO24V8m05/niSMbI+hRvy7bkuhRqrscLFBCo2kCgRksYkySMGjW6PzgUfrNAioiBovsqzA2o5WTpWScLRWBdpMNipgGgJFlmmbS11ZT+LTeHwWY+YpcN/cDjfm5FHWjcYnN95sR4BBK7OygU2vG1Lg0qK28ehsNGYfG+uplqEljazxGdlHpuxREz5S1mipQscEBdvej/465L0MkbXw5Ha7lB5/O911PH3fotuAmM1TWEun5JKLnHHhFcoCXbDwL25AwNf4KX0IfcThug3sn35W7GXc8TnPsaFXY+cHQC8m15PpBFJY9n9GtS14l5MP3KXyIdpngwnhqwtzW9DSlC1/CwJiVv79A+9Mcoo=
|
||||
sidebar_class_name: "delete api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Delete Events"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/events/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Delete Events
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"event_ids":{"items":{"type":"string"},"type":"array","title":"The event IDs to delete"}},"type":"object","required":["event_ids"],"title":"EventsDeleteBody"}}}}}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","title":"Success"},"deleted_events":{"items":{"type":"string"},"type":"array","title":"Deleted Events"},"not_found_events":{"items":{"type":"string"},"type":"array","title":"Not Found Events"}},"type":"object","required":["success","deleted_events","not_found_events"],"title":"EventMultiDeleteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: delete-retain-events-event-id-retain-delete
|
||||
title: "Delete Retain"
|
||||
description: "Delete Retain"
|
||||
sidebar_label: "Delete Retain"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJydVE2L2zAQ/SthTi2IOLu0F90KG9qFLS3btJdggmJPYm1lSSvJocHov5eR7MRpth/0ZCO9mXnvzYx6CGLvga9heUAdPJQMjEUngjT6vgYONSoMuHEYhNQbTKhN/m5kvRkvMgwYWOFEiwEdZe1BixaBw4gHBlIDBytCAwwcPnfSYQ08uA4Z+KrBVgDvIRwtxfngpN4DgyCDooNEc3ZfQ4wlxXtrtEdPIbeLBX1q9JWTlgQAhy9dVaH3u07NHgcwMKiMDqgDwYW1SlZJb/HkKaaf0LCO3AgyV/A52YTf1hiFQk8IDgUhMmjRe7HHP8n5OEBiZCPGbJ+wChfmrE+Vz0nLc5L3qNHJ6qQvRkr35vb22o5vQsk6iZ0tnTPu/72oqe+K/mTA1l8DlKkuboU+ftqlmbg0I7LTidQB9+gglmc7hHPiOHHswWSCyWC//ydzx2R/GCsyY7ai27+1gnTl0gNu0omzvdnd38u4y/a9VGyEfFitPl8lzL29bOpd2r3ZY9rENCKhMefdTUsZGuBQ5PUt+nEdY+HGII/uMC5t5xRwaEKwnhdFja2Z75zci4Dzg6zRFMLK1LczkBeFMpVQjfGBv10sbjKmpH3fmWT9IAsYUKFMfTG/mS/IJmt8aEWauOHJ+FXVheZTJwP+CIVVBIks8+kHuev86tDS8Mn7MyguGRBXgvX9Vnj86lSMdPzcoTsCX5cMDsJJsSXa6x5q6em/Br4TyuMVo9MiwavHYV5ez4C9zHQcC01DcRCqG6z5jsfpc5k2oUFRo0sc8vW7qkIbJoFXi0vGn8bgbvmwXC0hxp+UdAcH
|
||||
sidebar_class_name: "delete api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Delete Retain"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/events/{event_id}/retain"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Delete Retain
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"event_id","in":"path","required":true,"schema":{"type":"string","title":"Event Id"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"}},"type":"object","required":["success","message"],"title":"GenericResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: delete-reviews-reviews-delete-post
|
||||
title: "Delete Reviews"
|
||||
description: "Delete Reviews"
|
||||
sidebar_label: "Delete Reviews"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJydlE1v2zAMhv9KwLMWJ8V28W1bi61AixZttosRFIrFOOpkSZXktEbg/z5QsuOkH+tQX2yLFMX3IcUdBF55yAu4wa3ER1gyMBYdD9LocwE5CFQY8M5Fs9+/+2VrfAAGDh8a9OGbES3ku/grHQrIg2uQQWl0QB3IxK1Vsozhs3tvNK35coM1py/r6PAg0dOfFOkVsI4fobUIOfjgpK6AQS31BeoqbCCfd2wwc+d4m6znaeecQZBBkfFceOhGX7O6x3IQkDIu4rHLcUsCc2mEXLeXjQrSKoxCu44iOfTWaJ8yPpnN6CXQl05aEgk53DZlid6vGzW56Z3hw0x8CnaAY2WMQq5hzLg/EDoGNXrPK3yN3uB92bu8h2U4eQx6AOkHanSy3OtLbD6fnLzE8ZsrKaLYyZlzxn2chcDApTpqkWMHZcojK9ft1Rry4jmMju1XpA5YoYNu+bKjBrEXJiUYAfvqv+AOwd52jTAmC7K+VwrSlY7u/Q4qMeJNdN+WcZrwvXbY4PJzsbh+ETDV9riop3EcTNJdST0SNobmRz8hLKdrClk/P7I0P4CBR7dF52NVGqcgh00I1udZJrA207WTFQ843UqBJuNWxmKNjnmWKVNytTE+5F9ms3nyWTKg7rkZ59LZE6+twv1cKYYKUKGlXptYm143MKCkkrbZdD6dEUeSUvPYkprX+JrsIyr7Wgd8CplVXMaWicnveiIFuIPNkcmSAakh22634h5/OdV1tPzQoGshL5YMttxJvqJkCxKwQS7QRYh/sIUcvqcr9Sn2E7mrJvbA8+tFNNOOr2WJNvzTd3lQ1+ur2wUwWPUjvzaC9jj+SL3KHxNEE0nEuxfXdqC4rpo4kSDFpOcvrh492g==
|
||||
sidebar_class_name: "post api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Delete Reviews"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/reviews/delete"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Delete Reviews
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"ids":{"items":{"type":"string","minLength":1},"type":"array","minItems":1,"title":"Ids"}},"type":"object","required":["ids"],"title":"ReviewModifyMultipleBody"}}}}}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"}},"type":"object","required":["success","message"],"title":"GenericResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: delete-user-users-username-delete
|
||||
title: "Delete User"
|
||||
description: "Delete User"
|
||||
sidebar_label: "Delete User"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVF2L2zAQ/CthnloQce5oX/R2cIEWrrRcc30JJujsTayrbPmkdWgw+u9Fsp0Pclfoi220s6vZ2Vn3YLXzkGvcdVwhF7AtOcXaNl9LSJRkiGnTeXLp4Tfp1aiaNpshCIFWOVUTk4uVesQoJCYgBHQDiVZxBQFHr512VEKy60jAFxXVCrIHH9qY59npZgcB1mziwdNUKIQ85vvWNp58TLldLOKrJF843UbakPjZFQV5v+3M7HEEQ6CwDVPDEa7a1ugidZm9+JjTn2iEEILAp9vb68K/lNFlSpstnbPuP6qidVFZ1gPvklhpE780U+2vAcYWF1HVHL5vk7qXKgVxPNEN044cQh7EdKacU4czKR/sQBBBoPa7f6n+jbxXO8Kx2PvQJMZsFaPhdLd9fqGCLya+Tn0NV4+4/FTmJO+g7vtt3A/yvXXZBPmyWv24KjjM9nKo98nFs2iyyIy4sifnJ3NzBYks2T/rJ1cHCHhy+8n0nTOQqJhbL7OspNrOt07vFNN8r0uymWp1mtYJKLPM2EKZynqWnxeLmwGTx33Z2iT42AwE4kUD4cX8Zr6I4rTWc62Sz8aVu+zlos/j9Jj+cNYapZMJEpt+bHKddtZDQB6XNxeI/GKw75+VpydnQojHrx25A+Q6F9grp9VzpLruUWofv0vIrTKerngcVwYfHkdnfJxBvM1vMkATx79Xphvl+E2H819M8nxFqiSXOAzhu6Kgls8Sr1Y0in0c+f3yYblaIoS/wsG8Vg==
|
||||
sidebar_class_name: "delete api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Delete User"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/users/{username}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Delete User
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"username","in":"path","required":true,"schema":{"type":"string","title":"Username"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: deregister-faces-faces-name-delete-post
|
||||
title: "Deregister Faces"
|
||||
description: "Deregister Faces"
|
||||
sidebar_label: "Deregister Faces"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVE1v2zAM/SsBTxugxWmxXXTb1g4bsK1Fm+0SGIFiM4462XIlOm1g6L8PlJy4QdpiyyEWKPLx8eOpB1KVB7mAyy025CEXYFt0irRtvpUgoUSHlfaEbrlWBfrhf9moGpfLEg0SLlvrCQS0yqkaCR0j9sAuINNHgG5AQqtoAwIc3nfaYQmSXIcCfLHBWoHsgXYtx3hyuqlAAGkybPjJICHkKRY9fbLljgMK2xA2xEfVtkYXkXp2523DthNku7rDgp4gR6AQQmBo39rGo2f/89mMPyX6wumWQUHCbVcU6P26M5ObwRnEP3NIWd6fn58C/1ZGlzFscumcdf+BCq3jkZFOvEskpQ2fNGHtTx2MLY5uVbO7WseBHTc/iINFN4QVOgh5EHubck7tnvTxu00EIQioffXaMH+g96pCOIC97BqbMZnzbRhzH4Y4LtIi1pVSD375CDO2N3X35TIuUvueS7Z3+TqfX58AptkeD/XioJ3JF1YN00PaWNbVQTK0AQlZVFXWs1ZCllQFAjy67V5NnTMgYUPUepllJdZ2una6UoTTrS7RZqrVcWajo8wyYwtlNtaT/DCbnSWfXAAv0c0opMtHVbdcWx9YqGsbRzKUCwKYRCppNj2bzrh9zL9WcRMHnT9T7VE7DkMmfKSsNUrHXYl0+6ERC1gPoXJ4NoZe5AK4Cvbo+5Xy+MuZENh836HbgVzkArbKabVi0oseSu35XIJcK+PxhMxBXvDmZtiitxMQz5PcL0vDq7JVphsa8wd3+xcuamODqkQX86erzynLu7jBY+iJoHlwKeJjUWBLr/rmT/bo+up2DgJWw3NY25JjnHpgdaiHRNPGqqPao60Ho5qqYw1KSJj8+ws0pxFM
|
||||
sidebar_class_name: "post api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Deregister Faces"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/faces/{name}/delete"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Deregister Faces
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={{"content":{"application/json":{"schema":{"type":"object","title":"Body"}}}}}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: end-event-events-event-id-end-put
|
||||
title: "End Event"
|
||||
description: "End Event"
|
||||
sidebar_label: "End Event"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJydVVtv2jAU/ivoPG1S1tBqe8nbLmirtGlVx/aCEDrEB3Dn2K7t0KIo/306diChdGwqDxB8Lv6+71zSQMC1h2IGky3p4GGegbHkMEijrwUUQFosiG3p2y+6f1IsFmyzdYAMLDqsKJDjXA1orIhjO0/IQGoowGLYQAaO7mvpSEARXE0Z+HJDFULRQNhZjvPBSb2GDIIMig8iuNG1gLadp3jy4YMROw56mq40OpAObEJrlSwjmfzOG81n/W3WMdUgyfM/JhMk424A9e77KjLpEOm6WpKDNhucKAWM5oBRi9GU49s22zuZ5R2V4SkRP9Eigm9b9nXkrdE+obgaj/lHkC+dtAwcCvhRlyV5v6rV6LZzhhfz9CnZQO6lMYpQD2B2F0KbQUXe45rOVedb5/Ic8b44s8PNfdKBfJ9Jk5PlgV/S5u3V1akcv1BJEcmOJs4Z93ItBAWUip9koMqfOihTHllPGqMTY9AYUgdac6/MeznQOdwNFPtqEsAosF//l7j7ZGemhMUYTdn6r1Iwr3R15zeoRC9vUvfvND4l+c41/Jfp9OYkYartcVF5fOJ0xPYIG8PLZ79cwgYKyNMCypv9Wmlz0rxbPLntfvPUTkEBmxCsL/JcUGUuVk6uMdDFVgoyOVoZq9U7FnmuTIlqY3wo3o3Hl8lnngG3z22/bCaPWFlFx8ti3PJyW5lYmI40ZMCAErHxxeXFmEW0xocKYz92+3HI+UiNQ40DPYbcKpSxVSLmptNjltYrj1MxWLQsyTwDJsM+TbNETz+dals+vq/J7aCYzTPYopO4ZLyzBoT0/CygWKHydALnMF/w6rZro9cjyJ6Hue8Wzb2yRVV3mvym3fClEAdkQyjIRQzJ/DHd9Ca2cR9+MtVcwxTxvizJhrO+80FP3fycQgbL7uVRGcEhDh94QvAhITWReJz4eNaAQr2u4x6ElJI/fwDwaXpH
|
||||
sidebar_class_name: "put api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"End Event"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"put"}
|
||||
path={"/events/{event_id}/end"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
End Event
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"event_id","in":"path","required":true,"schema":{"type":"string","title":"Event Id"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"end_time":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"End Time"}},"type":"object","title":"EventsEndBody"}}}}}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"}},"type":"object","required":["success","message"],"title":"GenericResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: event-clip-events-event-id-clip-mp-4-get
|
||||
title: "Event Clip"
|
||||
description: "Event Clip"
|
||||
sidebar_label: "Event Clip"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVFFr2zAQ/ivhnjYQcVq6F72NtWyFlY0u20sIQbUutjrZUqVzWDD67+Msx0lIV9iTxenu9N133+ceSFUR5AoeUBsFawHOY1BkXHuvQQLusKVNaY3fDMe4yd+N0ZscbvzNpkICAV4F1SBh4IY9tKrBqYPRIMC0IMErqkFAwJfOBNQgKXQoIJY1NgpkD7T3XBcpmLYCAWTIcuCOG83uNaS05vroXRsxcsn1YsEfjbEMxjN4kPCjK0uMcdvZ2eOYDAJK1xK2xOnKe2vKYdbiOXJNf4SRUkoCbq6vLxv/UtbooWx2F4IL/9EVfGB+yWTcGkkZyydD2MTLBOvKs1vV7r9tB3bPWUpiipiWsMIAaZ3EIaZCUPsTKr+6DBCSgCZWb7H+gDGqCmFq9saCmIzZkm/T8W339IwlnW18NcyVnx7z1sc2R3ozu/8e4zbT99pjh5Qvy+X3i4Z5t+dLzer6ZI1nYEi1Y/kfhE01SCiyA4r+IOlUsAPmjb8BARHD7iD9LliQUBP5KItCY+Pm22AqRTjfGY2uUN4MOzsmyqKwrlS2dpHkh8XiKues2TVbN9A+jgQC+KEMezG/mi+YIu8iNWpQ22i8s4nOhp1WSPiHCm+VGZQwgOnHaVfZuBEEyBMLTwOvBTBUTuz7JxXxZ7Apcfilw7AHuVoL2Klg1BOjXvWgTeSzBrlVNuIFpslD8O5xlMr7GYjXsR4U0bIedsp2IzO/cX/6zxlMUKPSGAYM+fpjWaKnk8ILzzLvkwg+3y0hpb/PXsJ1
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Event Clip"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/events/{event_id}/clip.mp4"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Event Clip
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"event_id","in":"path","required":true,"schema":{"type":"string","title":"Event Id"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
70
docs/docs/integrations/api/event-events-event-id-get.api.mdx
Normal file
70
docs/docs/integrations/api/event-events-event-id-get.api.mdx
Normal file
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: event-events-event-id-get
|
||||
title: "Event"
|
||||
description: "Event"
|
||||
sidebar_label: "Event"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJylVk2P2zYQ/SvCnFqAWDuL5qJbkd0kCyTIYtftoYYh0OLYYkqRCjky6hr878VQH5bXGydwL7ZBvnl88+k5AMltgHwJ9zu0FGAlwDXoJWlnHxTkgHxepM9QdN+FVkWxRQIBjfSyRkLPHAewssbRRisQoC3k0EiqQIDHb632qCAn36KAUFZYS8gPQPuG7QJ5bbcggDQZPkiisgcFMa7YPjTOBgxscjuf85fCUHrdsFzI4bktSwxh05rsqQeDgNJZQksMl01jdJm8m30NbHOYyGg8+066e0GrS9JYlAAj12guwT4lQBQQ2nUxoqXdf9mkiJ3aRTGe2NYYYK8Hpud2nY1spazRXwzduw7BL5P0VJDm1Ezo6zX6Cf6ZUdmCUVEAWjVanIntbS+Jvbdq5NpIE7BoXNCkd68zrp0zKO1FyvdMkz0ONFHAv872mSKsw3kwohgOpPdyP3H2r2TJ91Vbr63UV2dlMRJEAZUMRWl0M5EyeHa0+ChD9o5BvUGwsgmVox8aPQ/AyK1AUttCW4UbbTWh2V+0f0r47GGKjwIa04aiq/NrnH80bci6RqidQlNUMlTXkn1mhuwjM0QBCglLcr7o4NdR3vUk2YIBo8r/Q9mpHPiUpGkTuvVXLGkS9ju+j8c6HAHHUbiENCe70TAdE2OTn3TwpDXPOmvoiGlZT4ryRbm9XkTHmjjJ6cuEnISyj8PqxdweJ3CMHILfbm/PB/af0miVxnF2773z109rxc6Yk2lwCjCuPLn9iexrS7jlSbf6/ij55DqBqbzC9tJI/owhyC0e59KFPz4ORl9mPygf9qt7usdN8nAMbxfd77tx14XvtcfGGbRYPJ4Rdrk9TWrKPmtCqhzvEMOuQBXkMOt2idlh2BIiVzj63bBEtN5ADhVRE/LZTGHtbjZebyXhzU4rdDPZ6JSlIzCfzYwrpalcoPztfP6mw6x4/9i4FOjeCRDAD3VC5zdvbuZpDrpAtUz11a8wgw8nno35IvyHZo2ROqU96Tj0/i277Ye7MB/3oJUAlsa3h8NaBvzDmxj5+FuLfg/5ciVgJ72Wa1a5PIDSgX8ryFOTnwkZuwR+eeqL4dcMxOsCh5xbzvhOmraPxN+4n25rqcwrlAp90tBd/16W2NDE8KwrOc5jrj/cLyDG/wBw6YVH
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Event"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/events/{event_id}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Event
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"event_id","in":"path","required":true,"schema":{"type":"string","title":"Event Id"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Id"},"label":{"type":"string","title":"Label"},"sub_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sub Label"},"camera":{"type":"string","title":"Camera"},"start_time":{"type":"number","title":"Start Time"},"end_time":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"End Time"},"false_positive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"False Positive"},"zones":{"items":{"type":"string"},"type":"array","title":"Zones"},"thumbnail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail"},"has_clip":{"type":"boolean","title":"Has Clip"},"has_snapshot":{"type":"boolean","title":"Has Snapshot"},"retain_indefinitely":{"type":"boolean","title":"Retain Indefinitely"},"plus_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plus Id"},"model_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Hash"},"detector_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detector Type"},"model_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Type"},"data":{"type":"object","title":"Data"}},"type":"object","required":["id","label","sub_label","camera","start_time","end_time","false_positive","zones","thumbnail","has_clip","has_snapshot","retain_indefinitely","plus_id","model_hash","detector_type","model_type","data"],"title":"EventResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
70
docs/docs/integrations/api/event-ids-event-ids-get.api.mdx
Normal file
70
docs/docs/integrations/api/event-ids-event-ids-get.api.mdx
Normal file
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: event-ids-event-ids-get
|
||||
title: "Event Ids"
|
||||
description: "Event Ids"
|
||||
sidebar_label: "Event Ids"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJylVk1v3DYQ/SvCnFpA8G6M5qJbETuJgQQx7G0PNQyBEmdXTClSIUeLbhf878VQ3157k7gnL6g3bz7ezHiOQGLnIXuA6z0a8vCYgm3QCVLW3EjIAPk9V9Ln068dEqTQCCdqJHRsfwQjaoQMlPSQgjKQwbcW3QFScPitVQ4lZORaTMGXFdYCsiPQoWEbT06ZHaRAijQ/3EgPITyyqW+s8egZfble8x+JvnSq4Qghg/u2LNH7bauTux4MKZTWEBpiuGgarcqY0OqrZ5vjaQTCOcGhKsI6+mocl4FU51nJ89FCSEGLAvU52KcICCn4tshHtDCHL9tYwKVdSMcX02oNXI2B6b4tkpGtFDW6s9V81yHYMwlHOSlWakZfF+hm+HtGJRtGhRTQyNHiJNje9lyw10aOXFuhPeaN9YrU/nnGwlqNwpylfM80ye1AE1L415peqUHAp9V8qvTA9Ve05O9VWxdGqFershkJQgqV8HmpVTMLZchssvgofPKOQb2BN6LxlaXvGt0PwMAjQkKZXBmJW2UUoT6ctb+L+ORmjg8pNLr1edfnr0n+Vrc+6QahthJ1XglfvZbsMzMkH5khpCCRsCTr8g7+OsqrniTZMGCM8v9QdlEOfFLQfAht8RVLmpX9ir+HqQ9HwLQdH3jPDItkvibGIV9M8Gw0TyZrmIh5W8+a8km7Pd9EU08sNH0qyKKUfR3m48//NcbNHOZ92L0lEZHcSD/79QEJQuBy/XZ5ebr0/xRaybjSk2vnrPuZjb/c7JIT14vNsQRoWy6+/kCnKEO44634+PLa+WS7AGMr+t259f0ZvRc7nHbYy9BYjL4lv9NqnFfnusfNNJvK21X35TSuuvI952zcV5vN7Qlhp+1S1FF9jgupsnx+DKcGVZDBajxBeBLQ7Yfbo3UaMqiIGp+tVhJre7F1aicIL/ZKol2JRkWFJmC2WmlbCl1ZT9nb9fpNh3nk22VrY5H7BCAFdtQFub54c7GO+9J6qkXsrf7ymce/yGzUi/AfWjVaqCh7jOXY5/YwHVqsBEfFj8djITz+4XQI/NxdVJyxVF4UmqWMk3/icRwH+OWuV/3XBNLnI/kbD+Plthe6jVlzKfbCKXYD2QP3coVCoov+O5PfyxIbmlmdjB6zjGJ+uN5ACP8BAfiNog==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Event Ids"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/event_ids"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Event Ids
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"ids","in":"query","required":true,"schema":{"type":"string","title":"Ids"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"properties":{"id":{"type":"string","title":"Id"},"label":{"type":"string","title":"Label"},"sub_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sub Label"},"camera":{"type":"string","title":"Camera"},"start_time":{"type":"number","title":"Start Time"},"end_time":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"End Time"},"false_positive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"False Positive"},"zones":{"items":{"type":"string"},"type":"array","title":"Zones"},"thumbnail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail"},"has_clip":{"type":"boolean","title":"Has Clip"},"has_snapshot":{"type":"boolean","title":"Has Snapshot"},"retain_indefinitely":{"type":"boolean","title":"Retain Indefinitely"},"plus_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plus Id"},"model_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Hash"},"detector_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detector Type"},"model_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Type"},"data":{"type":"object","title":"Data"}},"type":"object","required":["id","label","sub_label","camera","start_time","end_time","false_positive","zones","thumbnail","has_clip","has_snapshot","retain_indefinitely","plus_id","model_hash","detector_type","model_type","data"],"title":"EventResponse"},"title":"Response Event Ids Event Ids Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: event-preview-events-event-id-preview-gif-get
|
||||
title: "Event Preview"
|
||||
description: "Event Preview"
|
||||
sidebar_label: "Event Preview"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVMFu2zAM/ZWApw0Q4rTYLroNWLEVWLGiy3YJjIC1aFudbakSnS0w9O+DLMdJlq7ATpIlknp8fM8DMFYe5AbuSGmEXICx5JC16W4VSKAddby1jnaafm3HL79N61ar7XxT6XJbEYMAiw5bYnKx7AAdtjTX0QoE6A4kWOQaBDh67rUjBZJdTwJ8UVOLIAfgvY15np3uKhDAmpt4cBMLLW4VhJDHfG9N58nHlOvVKi6KfOG0jS2AhG99UZD3Zd8sHqZgEFCYjqnjGI7WNroYO86efMwZjjBCCEHAu+vry8I/sNFqTFvcOGfcf1QF6yLLrBNuRYy6iTvN1PrLgMYUZ7fY7b+WI7vnLAUxn+iOqSIHIQ/icIbO4f6Eyi8mAYQgoPXVa6zfkfdYEczFXhlQJGOxjrfh+LZ5fKKCzya+GftKT09x+bHMkd7E7r/b+Jjoe+mxQ8jn9fr+omCa7flQk7ruk6gjNuLaRB8ctM01SMiSD7LhoOqQTT5YVroEAZ7c7mCA3jUgoWa2XmaZotYsS6crZFrutCKTodXj5I6BMssaU2BTG8/y/Wp1lWLy6J3SjORPjYGA+FACv1peLVeRKGs8tzhqbrLf332ddT3Pkuk3Z7ZBPUpixDNMPW+Sgz0IkCdePm07FxABx9hheERP310TQjx+7sntQW5yATt0Gh8j9s0ASvu4VyBLbDxdwJr9BG8eJtm8XYB4Ge5BHV3Uxg6bfuLnJ+1P/z+jIWpCRW7EkK4/FAVZPkm88G9kf1bDp5s1hPAHZ/zLAA==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Event Preview"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/events/{event_id}/preview.gif"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Event Preview
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"event_id","in":"path","required":true,"schema":{"type":"string","title":"Event Id"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: event-snapshot-clean-events-event-id-snapshot-clean-png-get
|
||||
title: "Event Snapshot Clean"
|
||||
description: "Event Snapshot Clean"
|
||||
sidebar_label: "Event Snapshot Clean"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVE1v2zAM/SsBTxugxWmxXXwb1mIrsGJD1+1SBAFjMbY6WVIlOltg6L8P8leSJi2wkw2KfCQf+dgCYxkgf4BbkgphKcA68sjKmhsJOdCWDK+CQRcqy6tCE5pVZwyr/rtScvXcwZlyVRKDAIcea2LyKUkLBmuaUJUEAcpADg65AgGenhrlSULOviEBoaioRshb4J1LcYG9MiUIYMU6Ga4T0OxGQoxiQpf2j9EWJ/SnhvzuCH6DOpzDX1ub6gcBkjbYaJ5cx4RXI3aMy4QYnDWBQsK4XCzSR1IovHKJQcjhR1MUFMKm0bO7wRkEFNYwGU7u6JxWRUd49hhSTLuvK8YYBby/vDwF/oVayS5sdu299f+BCs6nIbPq65bEqHT6U0x1OHXQtjh6RbP7tunGeTyWNILBogxTSR7iMorRht7j7mB2X21fIEQBdShfG/MthYAlwQT2ykYkMmb36TXuc9v1IxV8tAMPXV996sFvuYfZ09uz+3IbVz1955KNLl/u77+fAPazPR5qv84/BjHNPg3LWBNXNqlx1BRXkEPWyzBrRzXFbJThu06Gc9cxE8hvR/01XkMOFbMLeZZJqu1841WJTPOtkmQzdKqb494xzzJtC9SVDZx/WCwuep9lEtfGdqMY2gQBKVHfymJ+MV8k2pwNXGO3gYM+X+jyiIppwEx/OXMaVbcnXVntwMBDf0cCCMgPLsoZEpYCUvkppG3XGOin1zEmc38bEjVSBVzrg+vwm3bHx2SLuun6TM1v0avkfz72WS+TMuHN3bCAb2cgzvc47pnZHeYc65ka7aRVEUryXQ3988eiIMcHgSeXIBU/LdTn63uI8R9U9hCW
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Event Snapshot Clean"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/events/{event_id}/snapshot-clean.png"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Event Snapshot Clean
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"event_id","in":"path","required":true,"schema":{"type":"string","title":"Event Id"}},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Download"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: event-snapshot-events-event-id-snapshot-jpg-get
|
||||
title: "Event Snapshot"
|
||||
description: "Returns a snapshot image for the specified object id. NOTE: The query params only take affect while the event is in-progress. Once the event has ended the snapshot configuration is used."
|
||||
sidebar_label: "Event Snapshot"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzVVU2P5DQQ/StWnUAKnd4RCCk3YEewEsvAbMNl1Gq540riWcf22JXZbUX578h2vpqeWQ1Cc+CUxK6891xVftUD8dpDcQfvUUgO+wwE+tJJS9JoKOAWqXPaM8685tY3hphseY2sMo5Rg8xbLGUlUTBzvMeSmBQb9tvN7rpguwbZQ4fuxCx3vPXMaHVixD8i41UVYj81UmGEwUfUxKRnUn9jnakder9hN7pcbzfcM9QCRWKeBJVGV7LuHA+aA0bnUWwgA2MxLb4TUEDEOEx/HeKnP6TnQYrDsnVv60ONBBlE4UjoQo560LzFGUkKyECGJFlODWTg8KGTDgUU5DrMwJcNthyKHuhkw3+enNQ1ZECSVFi4jsd6J2AYshldmE9aGT6jxxSewVdc+TN8rk83VVQ4Mh2NUcg1BNhxSXdKwRALXPFO0QwziXk78a7FkGzRE2/tf1EjNWGN7kk1E/tuJlrTH4/m82sz/xg41qSlM69+3J8Cx5q0QVk39Nq0vySWNfFDx5Wk02sxz932/XaR8cfIOYQIh94a7dEH7KvtNjzOTehDV5bofdUpdjsGQwal0YSaoiJrlSzjVc/vffinX/QOwzBk8O3V1SXwX1xJkWzj2jnj/gUqWBfshWTSLZC4VOFNErb+MkCZ8mz3IomjOaxyOKd1P2TTGneOn1YO8qtJAmHIoPX1l8zmPXrPa4QZ7Au+FJLBdmF3WLiTwZ/1xl08V6Ie41bdtqQ3Zff5Y7xN6XuKbG7d3e73C8BU2xapMcHiJ9OmBgrIk8Pn/WTXQz45/ObeBr0e3eNk7Z1T4RYSWV/kucDWbCona064eZQCTc6tjMVZAos8V6bkqjGeiu+22zcpZh9uUmVifkftkEEgSk233bzZbEMurPHU8thW411M8+DDqBL+MYz7pTn/33N5LDHhZ8qt4jJ2b8xrPxbvLs1YDxkUq2l7Vr99BiHzIbjvj9zjn04NQ1hOHhaqKqTnR7VysY94Oh+xj1x1sUShts+Er4fgS+LHqfWS0HHWvCR0nhAvCV5cfYnehw8nQ/jTyXm22766HW/81+y58k0XW59xTnLmGkYva5ALdFFD2v6hLNGuj3ZhvUH8fM1/vt7BMPwNpk+q8Q==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Event Snapshot"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/events/{event_id}/snapshot.jpg"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Returns a snapshot image for the specified object id. NOTE: The query params only take affect while the event is in-progress. Once the event has ended the snapshot configuration is used.
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"event_id","in":"path","required":true,"schema":{"type":"string","title":"Event Id"}},{"name":"download","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"title":"Download"}},{"name":"timestamp","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Timestamp"}},{"name":"bbox","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bbox"}},{"name":"crop","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Crop"}},{"name":"height","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Height"}},{"name":"quality","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":70,"title":"Quality"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: event-thumbnail-events-event-id-thumbnail-extension-get
|
||||
title: "Event Thumbnail"
|
||||
description: "Event Thumbnail"
|
||||
sidebar_label: "Event Thumbnail"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJytVE1v2zAM/SsGz0LsZuthvg1rhxVYsGELdikCg7VoW4UtuRIdNAj03wdZcZwsXYFiO8kWqffIx489MNYO8ntYkVQIGwGmJ4usjL6TkANtSXPBzdA9aFRtMf67Ip6FksWJraBnJu2U0UVRE4OAHi12xGQDxR40dnTEVBIEKA059MgNCLD0NChLEnK2AwlwZUMdQr4H3vXhnWOrdA0CWHEbLm4DUHInwXsxo09B/Dv8EekUv8PnosSyoQJrmjieBrK7M5IKW/cSi9JMNVkQIMmVVvVBashhhc/JCJtgTYnSiaPSaOkWyQ1VOLScvMsSiTt3ahtRRivky+sPyyzL5vAD4qcR8WNN4P8P4YkQlbEd8tsVOOpMeuhC6ynjQABqaY2SoQWPOR1MU0afI6P3m8DjeqMduYC8zLJwnCf4cyhLcq4a2uTHwRkElEYzaQ7u2PetKsdeTx9deLOfo/XeewHvl8tL4F/YKjk+S26tNfYNqNDbMF+sYtySGFUbvhRT5y4dWlOeWVHvvlXjLJ2LGcryR4P5jRfTHVqLuxMhv5oYYOiKztWvDcGKnMPYP9HllXkJYiTrYPUzt3l4pJLPOuN+zCtSH/w2M8wsb1T372ncRPleIptcvqzX3y8AY23Pixp3yXpaZiE64saEHTjtMm4ghzRuwHQ/bTGfHjfgYn9cPh4EOLLbafUNtoUcGube5WkqqTOLyqoamRZbJcmk2KuxirNjnqatKbFtjOP8Osuuos8mDFxlxkIckgQBgSgmki2uFhl4/xtlRQAx
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Event Thumbnail"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/events/{event_id}/thumbnail.{extension}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Event Thumbnail
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"event_id","in":"path","required":true,"schema":{"type":"string","title":"Event Id"}},{"name":"extension","in":"path","required":true,"schema":{"type":"string","title":"Extension"}},{"name":"max_cache_age","in":"query","required":false,"schema":{"type":"integer","description":"Max cache age in seconds. Default 30 days in seconds.","default":2592000,"title":"Max Cache Age"},"description":"Max cache age in seconds. Default 30 days in seconds."},{"name":"format","in":"query","required":false,"schema":{"type":"string","enum":["ios","android"],"default":"ios","title":"Format"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
70
docs/docs/integrations/api/events-events-get.api.mdx
Normal file
70
docs/docs/integrations/api/events-events-get.api.mdx
Normal file
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: events-events-get
|
||||
title: "Events"
|
||||
description: "Events"
|
||||
sidebar_label: "Events"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFWN9v2zgM/lcMPRuNW+xe/LZbe1uBFiva3D2sCAzFZhJtsuRJctA28P9+oPwjspOmaoJ6T0Udit9HiqRIboihS03iR3K1BmE0mYVEFqCoYVJcZyQmYL8nzZ8lGBKSgiqagwGFJzdE0BxITFKag6IkJEyQmPwuQT2TkCj4XTIFGYkXlGsIiU5XkFMSbwgVz98XVoN5LlCDNoqJJanC7osoOSfVLCQZLGjJDYkJ5ZyExDDDUeBLDVrhmR4P/UeI6B4TTufAR+ZxYzF3WIztjpsa1OWhy3nyJzzyUM6DXa90bMb2TEen750XKWBkJj8QcshhbHf8sJi9eGU5M6ewYMLAEtRhGudR5ESrhXRJ0IUBdQoJUebzVzi0qJ8thos6h4VUJ4WBB+zfNYiLa1gOiaJi+fEhGEVxFIUXn+IocqJgynII7i0Bl9eK6iTlrPioaGjhv1EdfEGcIbgWtNAr+WHh6BJ4aLFcEkwkhZJLBfqkxPThcC2CuxaqTyHlZQaJWZX5XFB2WsX0S06XlUUPplt0l9yCrqVi5rSy5eOdfzogFz5nItHpx+fsLRPBQzpM25w+jYNOn/aho+0FQDaG7RZnx/Yx0NH2HXQFqVwK9gJZwlkKQkNScGrGfsHvOxrBTU0juLM0evmrE13Oc2bMac7yqiE6eOiwhsHCQSzNaoRouamBhuEyDj592odv56eEnXQBBwKkRbdTXHDd972W6qQHzAP3ASGGHcUoLW1p0kEf8VK3tTME04UUGjSqv4gi/JOBThUrcL61zXiagtaLkgf3jTAJSSqFAWEsqaLgLLXj8OSnxjMbh3JDiypF0ThmILdYhcIh2rAamWWObGOUkzIZqcJmVDwg1kwwoTNGHXtX23kobIf2A8DthB0SbagyCd6sI9+khKMepQK8CDwDIutOHJNOVyLrdNmISQqpmWHr/RrnUnKg4o2XnGOdbNVUYTP34E21Fzj05vCmB9NLSLrm6Nhb6fob1Nb1vfGOZfua1rDfq751aNtoYooYykTCRAYLJpgB/nzw/L2VD65d+SokBS91Usf5Mcbf8VIHdSLkMgOerKheHavsFjUE31BDhZXCQGqkSmrx41ReNkqCKQp0LE9RWbNs9WXUuEko5z8hNY7bL/H3ahuHncC2nj4S+7q0GxZ329Jt5pwMdlJzJ7PCbhOwDevQHcYGo9G+INrGRO9OhxfSc2Xjh+F71lXmyo3D+ltQ7y3bP18BnyF01KeLi91y/x/lLLPFPLhSSqr31Pp+Tc/QZN6rGX0BLtPerx4x0jVYs9cLzo2sCdog1MtDhfsWtKZL2Fav10WtM5pgfCPI0K4aupFzbmvr3tq7r5txWbtvH1hXqabTux2F9d32L7XZXIckB7OSuLNut9RmRWIygfZ3DWrd7qxLxXHEN6bQ8WSSQS7PFootqYGzNctATmjB7N1sBePJhMuU8pXUJv4ris5rmRl2OAtp3dtQJyFBoJpedHZ+FtkaKbXJqY2qpknqmPcM6q7JwJOZFJwye9uWyKax6rHZy6P3kQ9+2WzmVMO/ilcVfq47LrQ1Y5rOudNz/YJnd1+/pry0tNHeg8LaU7otPN6yvordqvYueV+Apmf1FfV2SLPT9JFtV48+st3C0Ee4t+XzOeBUfF9x51XwOdJfb/md2LON8jnobop85N3Vjpe8s4zx1t8sMLz1v0P+wIrCy8/9rYGvRd2M7WvSuw44U7RX9teDr29u7OT+DP9RDOVJ/Iiv8gpoBspW1frc5zSFwgXZaSJQS/cyfb2akqr6H3Po6UY=
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Events"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/events"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Events
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"camera","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"all","title":"Camera"}},{"name":"cameras","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"all","title":"Cameras"}},{"name":"label","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"all","title":"Label"}},{"name":"labels","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"all","title":"Labels"}},{"name":"sub_label","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"all","title":"Sub Label"}},{"name":"sub_labels","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"all","title":"Sub Labels"}},{"name":"zone","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"all","title":"Zone"}},{"name":"zones","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"all","title":"Zones"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":100,"title":"Limit"}},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"After"}},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Before"}},{"name":"time_range","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"00:00,24:00","title":"Time Range"}},{"name":"has_clip","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Has Clip"}},{"name":"has_snapshot","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Has Snapshot"}},{"name":"in_progress","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"In Progress"}},{"name":"include_thumbnails","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":1,"title":"Include Thumbnails"}},{"name":"favorites","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Favorites"}},{"name":"min_score","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Min Score"}},{"name":"max_score","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Score"}},{"name":"min_speed","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Min Speed"}},{"name":"max_speed","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Speed"}},{"name":"recognized_license_plate","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"all","title":"Recognized License Plate"}},{"name":"is_submitted","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Is Submitted"}},{"name":"min_length","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Min Length"}},{"name":"max_length","in":"query","required":false,"schema":{"anyOf":[{"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,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort"}},{"name":"timezone","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"utc","title":"Timezone"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"properties":{"id":{"type":"string","title":"Id"},"label":{"type":"string","title":"Label"},"sub_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sub Label"},"camera":{"type":"string","title":"Camera"},"start_time":{"type":"number","title":"Start Time"},"end_time":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"End Time"},"false_positive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"False Positive"},"zones":{"items":{"type":"string"},"type":"array","title":"Zones"},"thumbnail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail"},"has_clip":{"type":"boolean","title":"Has Clip"},"has_snapshot":{"type":"boolean","title":"Has Snapshot"},"retain_indefinitely":{"type":"boolean","title":"Retain Indefinitely"},"plus_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plus Id"},"model_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Hash"},"detector_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detector Type"},"model_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Type"},"data":{"type":"object","title":"Data"}},"type":"object","required":["id","label","sub_label","camera","start_time","end_time","false_positive","zones","thumbnail","has_clip","has_snapshot","retain_indefinitely","plus_id","model_hash","detector_type","model_type","data"],"title":"EventResponse"},"title":"Response Events Events Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: events-explore-events-explore-get
|
||||
title: "Events Explore"
|
||||
description: "Events Explore"
|
||||
sidebar_label: "Events Explore"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJylVk1v4zYQ/SvCnIXYCdqLbsXG3Q2QRYON20MDQxhJY4tbitSSlLGuwf9eDCnJkp142/RkWHzzOB9vhnMEhzsL2Qus9qSchU0KuiWDTmj1UEEGFL7n9L2V2lB+9ndHDlJo0WBDjgwzHUFhQ5CBFI3gU6Egg28dmQOkYOhbJwxVkG1RWkrBljU1CNkR3KFlM6Ec7chAChVtsZMOsttlCk44ycePgdX7DXPZVitLlq3vlkv+qciWRrTsPmTw3JUlWbvtZPKlB0MKpVaOlGM4tq0UZYh28dWyzfHSIzQG2XfhqAl3tYZz5ES8WVQTrHVGqB2c/H2owKcgsSB5DfYYAD4F2xX5iEZ1+G0bcjq38+n4RXVSAmdjYHruimRkK7Ehg9cu/hARfLND43InuHgT+qYIxRjpGZWsGeVTIFWNFhfO9rbXnF2pauQKgshbbYUT+9cZC60lobpK+SvTJE8DjU/hb636Sg0FPM/meaUHrj+DJZ/XXVMoFO+uynok8CnUaPNSinbiyhDZyeIT2uQDg3oDq7C1tXY/NHoegJ5bxKFQuVAVbYUSjuThqv2XgE8epnifQis7m0edvyf4J9nZJDZCoyuSeY22fi/ZZ2ZIPjGD5xnhqHTa5BH+Psr7niRZM2D08v9QRi8HvgrdtAl18ZVKN0n7PZ/7kw5HwGlcvvCcGQbJdEyMTT7r4ElrXnTW0BFTWU9EeSa310V00sSspucFmaWyz8O0/fk1GSezn+owfkvis5Ss4ntz/vcj8VPAifvp7u5y/P+BUlRhuCcrY7T5L7N/PuMrToGczZA5QOpydvovNDM8dH7z9gB61NHBIEq7uzbIP5O1uKPTNHsbGpLRi/MHouO44tU9blK9U3pjdt8O4z6m77XLxsm1Xj9dEMbazos6lwA7R67WvKoMy4irIYNF3FQWNOIsmf2wonRGQga1c63NFouKGn2zNWKHjm72oiK9wFaEWp2A2WIhdYmy1tZlPy+XtxGz4QVnq0O6+1AgBb4ouru8ub1ZhhmqrWswqKxfkC4imQU6ls/Rd7doJYqgguDQsY/ypV/PuN17lk0K7CGfHY8FWvrdSO/5c1zBOPpKWCzkZAn7iw6ThW2PsgtxcHB7NILBkL2wTmvCikxgiUa/lCW1U6uLtmKWsUYfV2vw/h/2HpHV
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Events Explore"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/events/explore"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Events Explore
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":10,"title":"Limit"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"properties":{"id":{"type":"string","title":"Id"},"label":{"type":"string","title":"Label"},"sub_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sub Label"},"camera":{"type":"string","title":"Camera"},"start_time":{"type":"number","title":"Start Time"},"end_time":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"End Time"},"false_positive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"False Positive"},"zones":{"items":{"type":"string"},"type":"array","title":"Zones"},"thumbnail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail"},"has_clip":{"type":"boolean","title":"Has Clip"},"has_snapshot":{"type":"boolean","title":"Has Snapshot"},"retain_indefinitely":{"type":"boolean","title":"Retain Indefinitely"},"plus_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plus Id"},"model_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Hash"},"detector_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detector Type"},"model_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Type"},"data":{"type":"object","title":"Data"}},"type":"object","required":["id","label","sub_label","camera","start_time","end_time","false_positive","zones","thumbnail","has_clip","has_snapshot","retain_indefinitely","plus_id","model_hash","detector_type","model_type","data"],"title":"EventResponse"},"title":"Response Events Explore Events Explore Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: events-search-events-search-get
|
||||
title: "Events Search"
|
||||
description: "Events Search"
|
||||
sidebar_label: "Events Search"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJy9V01v4zYQ/SvCnIVYCXYvum23wTZAim5jt4cGhkBRY4tbitSSVBCvof9ekPqi7CTgVnBOhujHeW+GX2+OYMheQ/oIt08ojIZtDLJGRQyT4q6AFNCNZxqJomU2/9qjgRhqokiFBpWNcwRBKoQUvjeoDhADE96Hwu8NU1hAuiNcYwyallgRSI9AxOGPnQtgDrUNoI1iYg9tPI6IhnNotzEYZrgd+NOFbS2kZ3X6MlZcmNgVK7orZtx9Udycy9AXuCMNN5CCKZsqF4RxmEStHX+0sZN8XUxQ3hSYjXP0EnlMGNyjelvf9aTqrmOPNhO7L46zipmL6/mYTILuHaOvgZIKFVlUlaBFI9xfrs8966waJMdly/M/hNx3pL6OH1Lge8v4x3H6KsjOoFqiQjRV/srWGFg/OQ6fNcedVItOcADtLx2Jz2tYhZkiYn/52yNJ0iSJbz6kSeItwIZVGD04Ab6ukuiMclYvUZVLyZGIN0vyG9HRZ8tzSq4FqXUpF90SoQLWA9fsAtWZbvKKGYOLHpYQEXc6Wo9cp9vDHsuLb47G0JNN4Wh9LRUTmaaXPyW/MxGt6elBqcjz+7CT55fYbe41LtsJobk7nrPc34Pd5n7GrpDKvWA/sMg4oyg0ZjUn5vJ7cv5SPIwyovtORvTVyZi5MakW3RgBLnBtKVo7olDXUmjUNtRNktifAjVVrLZG2mIbSlHrXcOjhx4MMVApDArjBNQ1Z9T57tU3beccJ3lt27YxfLi5OQ/8N+GscNOiW6Wk+omoUCvr9Q3rdBdorKFMj8AMVvocwCWd/RtQs9Gdbdt4GCNKkYPvP2QnENoYKr23kefxvG2JWhP7Pg3BXoe6YoxmeIDJ/BtSM9sKjy6vjrrHeWs8lber7utp/NqV7yWy8YXZbL6eBezWdr6oXTMWdY7eakNTStuNDR2XKSGFVdeNrfQA06iehjasUdy+n8bUOl2tCqzk1U6xPTF49cQKlCtSM7dSEzBdrbikhJdSm/Rjklx3mK09RTvpit0nAjFYok5scnV9ldjC1FKbirg91h/C0zxmWY5rZ/DZrGpOmNsCTs+xz/Gx7z9dci7INgarz/51POZE41+Kt60d7k65zb1gmuTcO+f/4sG7Bp4Ib1wWNv1XsF4jGQKf934hM17sykImDh1TCHbqbIIiD91HCHhoEUKwg5EPwY72OwQ888whEzwzGwr37GfQus7NYmgWvbULgfvuKwjv+aXg+L3HCI7/E/g3XETQUese9gm6tR+KWSykj/ahKZEUqNxV0M35RCnW/qyzd9FGGW/ZL7cbaNv/ANWFbf0=
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Events Search"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/events/search"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Events Search
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query"}},{"name":"event_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Event Id"}},{"name":"search_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"thumbnail","title":"Search Type"}},{"name":"include_thumbnails","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":1,"title":"Include Thumbnails"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":50,"title":"Limit"}},{"name":"cameras","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"all","title":"Cameras"}},{"name":"labels","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"all","title":"Labels"}},{"name":"zones","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"all","title":"Zones"}},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"After"}},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Before"}},{"name":"time_range","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"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":"is_submitted","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Submitted"}},{"name":"timezone","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"utc","title":"Timezone"}},{"name":"min_score","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Min Score"}},{"name":"max_score","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Score"}},{"name":"min_speed","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Min Speed"}},{"name":"max_speed","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Speed"}},{"name":"recognized_license_plate","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"all","title":"Recognized License Plate"}},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: events-summary-events-summary-get
|
||||
title: "Events Summary"
|
||||
description: "Events Summary"
|
||||
sidebar_label: "Events Summary"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJy9VE2P0zAQ/SvVnK2mu4JLbghWgAQCsYVLVa3cZJp4cWKvZ1JRIv93NE6atttdaRESp8T2mzdvPntgXRHkK7jZYcsEawXOY9BsXPuxhBww3d9R1zQ67O8eHStkUOB10A0yBmHqodUNQg5sGvztWgQFpoUcHjoMe1AQ8KEzAUvIt9oSKqCixkZD3oNu91+2iYP3XjiIg2kriGq6aTtrIa4VlLjVnWXIoeMCFLBhK4DlwW0Uq1FLremusMb/ixbTMlYYnhRzcP5B0+yt+HnsnFrtqXb8PwTcHnxFeQlI3rWEJJzXi4V8SqQiGC9Fhhxuu6JAom1nZ99GMCgoXMvYclLivTVF6onsnsSmP+qMMUYFr66vL4l/aGvKZDa7CcGFv2AFH6QP2Qy6S2RtrPwZxoYuAdYVZ68v6KQpneuoDnc6BL0/aaZPbhAIUUFDlTCf8x2hn5FIVwgT2fPQlIzZUl7j0bfb3GPBZz2xSnENrkfcSa2P6R2y+3wY74b0PeVsapzl8usF4VDb86IOi2J2O2wAEYdcO1kVh2XANeSQDZsiowlHGHaHFdEFK4PB7CnPshIbN98GU2nG+c6U6DLtTarVEZhnmXWFtrUjzl8vFlcDZi0DtXUp3WMooEAcDXIX86v5QlLjHXGjU5eNc3kRyVmgU/kYf3HmrTapC5KgfoxyNa5HiW5kWSsQhfLW9xtN+D3YGOV6GHmJvjSkN/Zk6H/i/nxh7rTtUiiSg2fgJzvtpfCTLXQ0WcshGLGBfCXDUKMuMSSpg+2bokB/anUxu8IyNcL7myXE+Ad2KiuS
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Events Summary"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/events/summary"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Events Summary
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"timezone","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"utc","title":"Timezone"}},{"name":"has_clip","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Has Clip"}},{"name":"has_snapshot","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Has Snapshot"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: export-delete-export-event-id-delete
|
||||
title: "Export Delete"
|
||||
description: "Export Delete"
|
||||
sidebar_label: "Export Delete"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVE2L2zAQ/SthTi2IOBvai26FGLqwpWWb9hJMUKxJrK1saaVx2GD038vYztdmu9CT7fl88+aNOyC1iyBXkL94FwgKAc5jUGRcc69BAvb2tUaLhOvxa417bGht9Hp0gACvgqqRMHC5DhpVI6ePgSDANCDBK6pAQMDn1gTUICm0KCCWFdYKZAd08JwXKZhmBwLIkGVDzoUm9xpSKjg/etdEjJwyn834oTGWwXhGDhJ+tmWJMW5bO3kcg0FA6RrChjhceW9N2Q+aPUXO6c4wUkpJwKf5/Lbwb2WN7tMmeQgu/EdV8IHJJTPg1kjKWH4zhHW8DbCuvPKq5vB927N7zVISJ4tpCHcYIBVJHG0qBHW4oPLBDQAhCajj7j3Wv2GMaodwKvbOgpiMyZK96dzbbZ6wpKuNr/q5htZjXHEuc6Z3YPffYywG+t5qdgz5ulz+uCk47PZ6qYP6J4ujmGukyrH8L+RNFUjIhgvIuqOwEwiIGPZH3bfBgoSKyEeZZRprN90Gs1OE073R6DLlTb+wc6DMMutKZSsXSX6eze6GmIJPZut6zsd5QAA3GjDPpnfTGfPjXaRa9VIbr+71OFfDnlZI+EKZt8r0SujxdOOcq/HuQYA8nXAhgCGyt+s2KuKvYFNi83OL4QByVQjYq2DUhtGuOtAm8rsGuVU24g2Q0+HAh8dRHx8nIN4GeJRBwyLYK9uOjPzBw+WPpld+hUpj6DEM7i9liZ4uEm8Olfk+rX2RP+TLHFL6C+O2wHQ=
|
||||
sidebar_class_name: "delete api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Export Delete"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/export/{event_id}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Export Delete
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"event_id","in":"path","required":true,"schema":{"type":"string","title":"Event Id"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: export-recording-export-camera-name-start-start-time-end-end-time-post
|
||||
title: "Export Recording"
|
||||
description: "Export Recording"
|
||||
sidebar_label: "Export Recording"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJy9Vk2P2zYQ/SvCnFpAXTlGtwfd2mSLBkibxWbbi2EYY3EsM6FIhaS8NgT992BIWR/rjZG2QHywpeFwPt4bProFj6WDfAV3x9pYD+sUTE0WvTT6rYAcKNg3lgpjhdTlpjdsCqzI4kZjRZuN88i2+OMlm0iL+BVfa+M8pFCjxYo8WU7aAu+GHCaxIAWpIYca/R5SsPS5kZYE5N42lIIr9lQh5C34U81bnbdSl5CCl16x4XWIlfzFsbouHXKMtf3bFLqptmQnKT5wqORRPstwbvZ/x7/T4hx9HfeT878ZceJNz8MVRnvSnpewrpUsAnfZR2c028ZstWVmvSQX3hSetlh8CnX0ee97W7LDwhuuSNAOG+UhB0uo+uaeI0+6qXiEpi6yIoW1o83y9gjrLgVnGlvQi9n6pXm2ftzc1XwTp9rSQdJTyBX5uByRCo/vSJd+D/ny9pcR79+tJC3UKQkbuxRkhSVtAn9XJu0teyX37NV1Q5lm+5EKP2UzHJiHodhAZNfxFkuuNtpFRpaLBf8IcoWVNZPIo9YUBTm3a1Ty0DvDt3Mes/y8XF4G/geVFGFbcmdtIPs/TpIgj1Lxk/RUuUsHZYrZKurT+104/nNk+Sj1Fqk9lWShW4/AorV4muD6zsQCmbDKldeY+pOcwzJQG12+7hrASB559SVSx9O3Cn3F1L3fegwzwhvR/XobbyJ81yboj8fH+4uAkds5qXHUkmHWuDzye8NCPggwDzVkUcazdiK9XRY0MmtHqewy0iJrz8rWQQqO7OEs341VkMPe+9rlWSaoMjc7K0v0dHOQgkyGtQy0jo55lilToNob5/PbxeJV9FmnwHP2MGrd3RGrWtFcq6Yac1aUuQ4Mat/zOj3K46CB1DszFSNIgbuKMC5uXt0s2IsxqzBMfx/3BYRnFAyD5enos1qhDPMZ+m978Ff9pQop5PObLwDP5tllRVqwbbhe1ikwehyobbfo6G+ruo7NnxuyJ8hX6xQOaCVuubdVC0I6fhaQ71A5uqh5OPnww0M/4D8mo/LOeznPseYpPqBqevw+0enZVc7Mf8fUE9C+c+aBmqBXe0JBNgAfl1/HTD8FVRm3X4gsVx13/FoUVPurvuvJ2b5//+ERUtj2fxEqI8K5wCdWLHyKpZrQeVDgYGtBoS4b1sUcYkz+fAHZM3Tg
|
||||
sidebar_class_name: "post api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Export Recording"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/export/{camera_name}/start/{start_time}/end/{end_time}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Export Recording
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"camera_name","in":"path","required":true,"schema":{"type":"string","title":"Camera Name"}},{"name":"start_time","in":"path","required":true,"schema":{"type":"number","title":"Start Time"}},{"name":"end_time","in":"path","required":true,"schema":{"type":"number","title":"End Time"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"playback":{"title":"Playback factor","default":"realtime","type":"string","enum":["realtime","timelapse_25x"]},"source":{"title":"Playback source","default":"recordings","type":"string","enum":["recordings","preview"]},"name":{"type":"string","maxLength":256,"title":"Friendly name"},"image_path":{"type":"string","title":"Image Path"}},"type":"object","title":"ExportRecordingsBody"}}}}}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: export-rename-export-event-id-rename-patch
|
||||
title: "Export Rename"
|
||||
description: "Export Rename"
|
||||
sidebar_label: "Export Rename"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVFFv2jAQ/ivonjYpIxSte8hb1zG1UqdVjPUFRcjER3Dn2K7tUFCU/z6dHQiUrtvyksS+O3/fd9+5Ac9KB9kcJlujrYc8AW3QMi+0uuWQAYb1hUXFKlx0fwvcoPILwRf7DcN8sYYEDLOsQo+WijZAe1SkC4cEhIIMDPMUbPGpFhY5ZN7WmIAr1lgxyBrwO0N5zluhSkjACy9pYUKFBrcc2jaP+ej8Z813lPSyXKGVR+VpixkjRRFYpY9OK1rrTzOWOHuBjv4i5nMMFdveoSr9GrLx5ace01crUHG5G4TEtk32mXr5iIU/4TmP1fMjRkHRaVAxEGlbKmHRGa1cRDQejejF0RVWGCIBGfyoiwKdW9VyMO2C4d85x1M+jsfnhR+YFDykDSbWavsfVV8oydEzIelLeKzceYDUxckuU7vvq2CcU/Hb5LAilMcSLbR5LzSzlu2OXHKnI0BoE6hc+ZahvqFzrEQ4FHvDeyTGYEa7f2sy8YpHd3FHDe/ljer+mcaXKN9rh+1Dbmaz+7OCsbenTY02G0SfETb0a83jKHaDS8aGNE542uxHtk3tPseh3ewHu7YSMlh7b1yWphwrPVxZUTKPw43gqFNmRGhbH5ilqdQFk2vtfHY5Gl3EmDwB8tG0n+XJllVGYj+LvQ1AqJUOTeoEgAQIUyQ5Gl4MRxRltPMVU0cVXvI/UefQc49bnxrJRLBOgN50ysy7mxASyI6us06cPAGiRWFNs2QOf1rZtrT8VKPdQTbPE9gwK9iSYM8b4MLRN4dsxaTDM0SHkYN3085Z7weQvI50byBF9tkwWXfS/MLd8e0bZmaNjKMNGOL2dTzpQ3B2n3426NTNmHFVFGj8m7H5kcXur2bXN5DAsrunK80pybJnEpA9R6w6UA/XQFhrQDJV1jScGcSi9PwG86BL2A==
|
||||
sidebar_class_name: "patch api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Export Rename"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"patch"}
|
||||
path={"/export/{event_id}/rename"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Export Rename
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"event_id","in":"path","required":true,"schema":{"type":"string","title":"Event Id"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"type":"string","maxLength":256,"title":"Friendly name"}},"type":"object","required":["name"],"title":"ExportRenameBody"}}}}}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: false-positive-events-event-id-false-positive-put
|
||||
title: "False Positive"
|
||||
description: "False Positive"
|
||||
sidebar_label: "False Positive"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJydVE2L2zAQ/SthTi2IOLu0F90K3dKFloY220swQbEnsbaypZXGocH4v5eRHMfZbLfQk400H++9macOSO0DyDXcHbChALkA69Ar0ra5L0HCTpmAG2eDJn3ADcawTfpudLnZPAtwLYEAp7yqkdBz7Q4aVSNIOCWBAN2ABKeoAgEen1rtsQRJvkUBoaiwViA7oKPjvEBeN3sQQJoMH0Sws/sS+j7n/OBsEzBwyu1iwZ8SQ+G1Yxog4UdbFBjCrjWz70MwCChsQ9gQhyvnjC4i6+wxcE43geE8a0I6dQip2ATf1lqDqpkAHBpCL8CZNjDnV+gsTRsSG3GKsdtHLOhCnPXY+Vw0f6bJgzNWlVxv5Nn3XPbd7e21LD+V0WUkPbvz3vr/16REUtrwnyasw3WAscXFrWqO33ZxNy5F6cV4ohvCPXro87Msynt1nCj3xSaALHQd9q+J/BVDUHuEsdgr68VizFZ8+6+RMK/UeoibTOQsb1L37zQ+JvleanYK+bxaLa8KptleDvUT+3G2HPzI4JAqy1Y+WZMqkJAlJ2fdyZR9dulkEBDQH04Wbr0BCRWRCzLLSqztfOf1XhHOD7pEmymn4/TOgTLLjC2UqWwg+X6xuEkxObt/Z+MABnIggBslAov5zXwRnWMD1Sru3fCAXHG7oD4OlPA3Zc4oHfciAuoG3uv0CLGH5OQ5ekY9F8CgObzrtirggzd9z8dPLfojyHUu4KC8VlvGv+6g1IH/S5Cx1BWy0Vfw5vuwPm9nIF5GfNqShnfkoEw7aPQLj9NXNBqjQlWijxjS9YeiQEeTxCsf8wTGpVg+rKDv/wDg7BLP
|
||||
sidebar_class_name: "put api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"False Positive"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"put"}
|
||||
path={"/events/{event_id}/false_positive"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
False Positive
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"event_id","in":"path","required":true,"schema":{"type":"string","title":"Event Id"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","title":"Success"},"plus_id":{"type":"string","title":"Plus Id"}},"type":"object","required":["success","plus_id"],"title":"EventUploadPlusResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
70
docs/docs/integrations/api/ffprobe-ffprobe-get.api.mdx
Normal file
70
docs/docs/integrations/api/ffprobe-ffprobe-get.api.mdx
Normal file
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: ffprobe-ffprobe-get
|
||||
title: "Ffprobe"
|
||||
description: "Ffprobe"
|
||||
sidebar_label: "Ffprobe"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVU01v2zAM/SsFz0KcFttFtwLrugEbVmzZLkEwMDZtq5MtVaKDBYb++0A5zgfSHnayQT0+Pj6SIzA2EfQa7r2HjQLnKSAb13+uQENd++C29Hv+NsSgwGPAjpiCJI7QY0egwSO3ERSYHjS8DBT2oCDQy2ACVaBrtJEUxLKlDkGPwHsvaZGD6RtQUFGNg2XQAArYsJXXp0ya0kaoond9pCjJd8ulfCqKZTBe9IKGH0NZUoz1YG++H8CgoHQ9U88CR++tKXN7xXOUnPEkKKWUFLy7u7sm/oXWVDnt5iEEF/6DFXwQS9lMuitiNFb+DFMXrwHWlRev2O+/1dnmS7+SOkZMz9RQgLRJao5hCLg/8/GLmwRCUtDF5jX/Z+hXihEbgiPZ29Bsxs1KXtOptts+U8kXw1/nvqbSB9zmRHOyd3L37TY+TPa9VmyGfFqtnq4Ip9leDvXjtNOiirh1su7zenMLGor6CIgUdvO2D8GChpbZR10UFXVuUQfTINNiZypyBXqTp3MC6qKwrkTbusj6/XJ5O2E2ciu1ywYfxIMCKTQJXC5uF0sxw7vIHea9OtzaSftFT8dJMf3lwls0eeBZyXjoaz0ftUxAFEloHLcY6WewKUl4ul7ptjIRt/bsfv/Q/uzWd2iHrFua2WEwAga9lk1sCSsKmWVKui9L8nyWdXU4wnIcxuPDClL6By5Nke0=
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Ffprobe"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/ffprobe"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Ffprobe
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"paths","in":"query","required":false,"schema":{"type":"string","default":"","title":"Paths"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: get-export-exports-export-id-get
|
||||
title: "Get Export"
|
||||
description: "Get Export"
|
||||
sidebar_label: "Get Export"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVE2L2zAQ/SvhnVoQcXZpL7oVGrYLLS3btJdggmJPbG1tSyuNwwaj/15kO86abBd6kjxfevPmjTuwKjzkFutnaxwjFTCWnGJtmvscEgXxjnrfePjd+Vvnu11BDAGrnKqJycVSHRpVEySmMAjoBhJWcQkBR0+tdpRDsmtJwGcl1QqyA59sTPTsdFNAgDVX0TCAW9znCCGNBbw1jScfc25Xq3jk5DOnbcQNiZ9tlpH3h7ZaPIzBEMhMw9RwDFfWVjrr20wefczpLjhCCEHgw+3tdeHfqtJ5n7ZYO2fcf1SFdZFa1gPunFjpKt40U+2vAyqTzbyqOX0/9PzOaQpisuiGqSCHkAZxtinn1OkFl1/NABBBoPbFW7R/I+9VQZiKvTGhSMZiE73h8rbZP1LGs5Fv+76Gp8e49FLmQu/A7r/b+DzQ99pj55Avm82Pq4LDbOdDvSNejPoXqIlLMyq/lzaXkEhG8SfdpOoAAU/ueFZ96ypIlMzWyyTJqTbLg9OFYloedU4mUVb3w7oEyiSpTKaq0niWH1ermyEmjftyMD3fYy8QiA8NeFfLm+UqcmON51r1Mht3btbKrMtpdkzPnNhK6V4CPZhubHM77qyHgLysbyoQEUZ/1+2Vp1+uCiGan1pyJ8htKnBUTqt9BLvtkGsf7znkQVWerqBMO4N3D6M03i8gXod4VkAT539UVTsS8odOs79Mr/qSVE6uBzH4P2UZWX6RebWkke9p6nfrDUL4CwiUvfs=
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get Export"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/exports/{export_id}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get Export
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"export_id","in":"path","required":true,"schema":{"type":"string","title":"Export Id"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
62
docs/docs/integrations/api/get-exports-exports-get.api.mdx
Normal file
62
docs/docs/integrations/api/get-exports-exports-get.api.mdx
Normal file
@ -0,0 +1,62 @@
|
||||
---
|
||||
id: get-exports-exports-get
|
||||
title: "Get Exports"
|
||||
description: "Get Exports"
|
||||
sidebar_label: "Get Exports"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJxlkU9rwzAMxb9KeWfTZINdfNuhlF3351TCcB218ebEnq2UFpPvPpR2ZVt9EUhP0u/JBWz2GXqD1TGGxGgUQqRk2IXhqYXGnvid5lq+xj0xFBLlGIZMGbrgvq4ltJRtclG6ofEyWks570a/eL6IoWDDwDSwyE2M3tl5WfWRpacg2456A10meerfyDXx4oyaodATd+FCCYVouINGRVdBpnSgJAYLxuSh0THHrKuqpT4sd8ntDdPy4FoKlYkOk/ot1FXlgzW+C5n1Q13fnTWNght2QWjZsSdoQEEWnSHr5d2yxqQQQ+bezLYG09MN/x9vBXyKomE6chW9cYPMmGnKxdsGP94aBaGSVClbk+kt+WmS9NdI6QS9aRQOJjmzFcBNMyl0ZFpK8zE+6QSNR2spyuUOxo+y+uZDxOv1yuvVK6bpG02vwTc=
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get Exports"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/exports"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get Exports
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
62
docs/docs/integrations/api/get-faces-faces-get.api.mdx
Normal file
62
docs/docs/integrations/api/get-faces-faces-get.api.mdx
Normal file
@ -0,0 +1,62 @@
|
||||
---
|
||||
id: get-faces-faces-get
|
||||
title: "Get Faces"
|
||||
description: "Get Faces"
|
||||
sidebar_label: "Get Faces"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJxlkctu3DAMRX8luGth7BToRrsukiDbPlYDo+DI9FipbKkSbXQg+N8LzhhBHlpIAHlJnktVCJ0L7BEPK89S0BnExJnEx/m5h8WZ5fdAjst+n1lgkLmkOBcusBVf2lafnovLPmklLH4sznEpwxLuvu9iGLg4C8+ickopeHcd1LwUrakobuSJYOumx3xo+cRy96gQMJhYxrjzwSCRjLBohj1dOK+c1VjFkgMsRpFUbNP0PMXDkP2ZhA+r7zk2lDw281ZomyZER2GMRezXtr2/aToDPw9RScVLYFjAQAfdANvD/aHFZpBikYmulmaa+AP7O1cVckmqEP4nTQrkZ+1wZam7ryNuvjoDJdJArScq/CuHbdPw34XzBfbYGayUPZ0U7thtBiNTz/m6iD98gcU35zjpzlYKiw7+9BHq83W/Tw8/sW3/AQ6xurg=
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get Faces"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/faces"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get Faces
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
70
docs/docs/integrations/api/get-labels-labels-get.api.mdx
Normal file
70
docs/docs/integrations/api/get-labels-labels-get.api.mdx
Normal file
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: get-labels-labels-get
|
||||
title: "Get Labels"
|
||||
description: "Get Labels"
|
||||
sidebar_label: "Get Labels"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVU01v2zAM/SsBz0LsBttFt2IrugEdNmzZLoExMDZtq5MtVaKDBYb++yDZ+TDSHnayIT4+Pj6SIzA2HuQO7q2FQoCx5JCV6T9XIKEh/q1xT9qfPg0xCLDosCMmF1NH6LEjkFBiRw5BgOpBwstA7ggCHL0MylEFskbtSYAvW+oQ5Ah8tDHPs1N9AwIqqnHQDBJAACvWMfphYg2hiFzemt6Tj9mbPI+finzplI2aQcKPoSzJ+3rQq+8zGASUpmfqOcLRWq3K1GL27GPOeFEUQggC3m02t8S/UKsqpa0enDPuP1jBumgrq0l3RYxKxz/F1PlbgDblIor98WudjF4aFsT5RfVMDTkIRRCnN3QOj1dGPplJIAQBnW9eG8AJ+oW8x4bgTPY2NJmx2sZouNQ2+2cqeTH9XeprKj3jigvNxd7J3bfb+DjZ91qxE+TTdvvthnCa7XKoj8Srp7TYURhxa+atTzvOLUjI9CnuyR1OGz84DRJaZutlllXUmXXtVINM64OqyGRoVZrPBSizTJsSdWs8y/d5fjdhingutUkWz/JBQCw0SczXd+s82mGN5w7TZs33tlC/aOw8Lqa/nFmNKk09iRnnznYwd1YIiJriyzju0dNPp0OIz9MJx34r5XGvr474Dx2vL/6AekjSYz8HdCqiQe7iOraEFblEM2XdlyVZvsq6uZ7Ich7H48MWQvgHb6eUQQ==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get Labels"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/labels"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get Labels
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"camera","in":"query","required":false,"schema":{"type":"string","default":"","title":"Camera"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: get-preview-frames-from-cache-preview-camera-name-start-start-ts-end-end-ts-frames-get
|
||||
title: "Get Preview Frames From Cache"
|
||||
description: "Get list of cached preview frames"
|
||||
sidebar_label: "Get Preview Frames From Cache"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJy9VNtu1DAQ/ZVonkCyNtsKXvKGSluQuFTtwssqirzJJHFJ4tSeLKwi/zsax3vrUkSF1Jdc7DNnZs5cRiBZWUiWcGNwrfAnpAIKtLlRPSndQQLXSFGjLEW6jHKZ11hE/YSNSiNbtCBA92gk4z8WkECFlAVINkGy0ug289a7myyXLRqZdbLFLLMkDW1fZLMMu2J68E9gqZBAQC/5j9Bw3COwPSRwwAYCFEfeS6pBgMGHQRksICEzoACb19hKSEagTc+mlozqKhBAiho+uPBc0Rfmck7sfGyje66DbmhXaA4c3DFRtLBH7FOy/8192RUTc8rWttedRcsG5/M5v46rezfkOVpbDk10G8AgINcdYUcMl33fqNwXN763bDPug3DOOQFvzs9Pib/LRhXeLLo0RptnsEJvuKFITXEXSFI1/KUIW3sKaHR+dCu7zdfS98ZxgVnrcKI6wgoNuNSJ7Zk0Rm4OhPykpwDBCWht9beG+YzWygphR/Y01IsRLfjW7X3r1T3mdFTvpc9rch1w6Z5mL++k7tNpvJ/k+5OzLeTDYnFzQjjVtkWqdRhqP3tUQwJxGOJ4PBg7F/v5iMftmLgYuyIep7528W5bWDTr7fQOpoEEaqLeJnFcYKtnpVGVJJytVYE6lr3yhdsDkzhudC6bWltK3s7nZxMm5cEptdc+5AUC2NHUkPPZ2WzOOvXaUit9y4XJ4xUX9l905aOMroxuowteWPBoIY77Pv6n3RhEJ/xFcd9I5fvJZzMGOZcQjEBAcrzHvJR8fLB6sCv4ZLcugqdUACvCdOO4kha/mcY5Pn4Y0GwgWaYC1tIouWJxliMUyvJ3AUkpG4t/yfPVbWjL19FTGW27r+PeW8tmCAX4gZtH25mr+YKud8q9sN9QH79hapQFGi/6dPkuz7GnA7OThcj9vBu+68sFOPcb9JqgnA==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get Preview Frames From Cache"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/preview/{camera_name}/start/{start_ts}/end/{end_ts}/frames"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get list of cached preview frames
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"camera_name","in":"path","required":true,"schema":{"type":"string","title":"Camera Name"}},{"name":"start_ts","in":"path","required":true,"schema":{"type":"number","title":"Start Ts"}},{"name":"end_ts","in":"path","required":true,"schema":{"type":"number","title":"End Ts"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: get-recognized-license-plates-recognized-license-plates-get
|
||||
title: "Get Recognized License Plates"
|
||||
description: "Get Recognized License Plates"
|
||||
sidebar_label: "Get Recognized License Plates"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVE1v2zAM/SsGz0KcBtvFtwIr2g0dVnTZLkEQKDLjKJMlVaKDZYb++0A5n8iyYScbIvnI96inHkg2EaoZ3HsPcwHOY5Cknf1YQwUN0iKgco3Vv7BeGK3QRlx4IwnjXyINEgjwMsgWCQM36MHKFqGC6I2mxcZpizUI0BYqeOsw7EBAwLdOB6yhWkkTUUBUa2wlVD1Iu/uyyji084yjLWGDAZI4HtnOGEhzAaTJ8MFX7lV8GnoljgSM3tmIkTEn4zF/aowqaM+suaZTCmNcdaZ43SeDAOUsoaU8ifdGqyxSuYlc05/mTCklAe8mk2vg79LoOpcVDyG48B+o4AMvhvQwd40kteE/TdjG6wTj1EX0SrxIQdvmXLujnPMkDmcyBMlrOcj57IYBIQloY8PIl3in1M8Yo2wQjmC3U7MYxZSj6dTbLTeo6OJOzDKvofU+72zXJ3kHdW/T+DDI96dmh5Sn6fTlCnDY7eVSH5GK16MPiufBB8VL9gHPirR2eytlS9AaKihvWgcERAzbg2e6YKCCNZGPVVnW2LrRKuhGEo62ukZXSq/zFk+JVVkap6RZu0jV+/H4bsiZs9VWLi9iTxIEcKOByHh0NxqzaN5FamW+f3vH/ovjhSLHPRP+pNIbqfN1yfP1e/4zuM1/LoAn56S+X8qI34JJiY+HR4JVqXWUS3P2TPzA3fXLspWmyzSZ+1YGzTVQzfiCr1HWGDLYUHuvFHo6q7ryI6Mct/n4MIWUfgM/SM+P
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get Recognized License Plates"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/recognized_license_plates"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get Recognized License Plates
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"split_joined","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Split Joined"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,62 @@
|
||||
---
|
||||
id: get-recordings-storage-usage-recordings-storage-get
|
||||
title: "Get Recordings Storage Usage"
|
||||
description: "Get Recordings Storage Usage"
|
||||
sidebar_label: "Get Recordings Storage Usage"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyFkU9r3DAQxb/K8s5i7RRy0a2HEnroJWlOi1km8qytVrYUabx0Ef7uZXZN0n9QHSTQPI3e702F0FBgD/jCvSd0BjFxJvFx/tzDYmA5ZnYx934eyrFIzDTwcSm6/6MwsMAgc0lxLlxgKz60rR49F5d90s6weFqc41JOS9g9bmIYuDgLz6JySil4dzXSfCv6pqK4kSeCrasu80fLB5bd45uj3dPN0e5ZrcJgYhnjhgSDRDLConlnaDYGGBTOZ86aS8WSAyxGkVRs0/Q8xf0p+4GE92ffc2woeazmV6FtmhAdhTEWsfdte3fTdAZ+PkUlES+BYQED/egG0O7v9i1WgxSLTHRFnmni/7P9FkSFXJI+Ev4hTQrkZ216tVc37gPeuZV3I+8M1LPWa32hws85rKtevy6cL7CHzuBM2dOL2j90q8HI1HO+RvWdL7D46BwnjfhMYVEff41Sk3gbx8Onr1jXn6Wk4PA=
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get Recordings Storage Usage"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/recordings/storage"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get Recordings Storage Usage
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: get-review-from-event-review-event-event-id-get
|
||||
title: "Get Review From Event"
|
||||
description: "Get Review From Event"
|
||||
sidebar_label: "Get Review From Event"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJydVcGO2zYQ/RVhTgnArpxFe9EtaZw0QIsGu04uhmGMxbHMVCIVcuTWEPTvwZCyVoZ3XSAn2eSb0Zs3b0Y9MFYBijU80NHQv7BR4FryyMbZTxoKqIi3Pt5t9941WzqSnU7Sn/Fh9HZbEYOCFj02xOQlcw8WG4ICzihQYCwU0CIfQIGn753xpKFg35GCUB6oQSh64FMrcYG9sRUoYMO1HCwlUfZJwzBsJD60zgYKEnK/WMhDUyi9aaUIKOCxK0sKYd/V2cMIBgWls0yWBY5tW5sy1px/CxLTz2i0XhRhk95g9C1qQkpBiQ35myX8nhCDgsDoectGJLrG751vkKEAjUy/RNRTkkcJzVZyOCggq38uzdLqKckBw3ZHZMcG07zYnXM1oZ1F/oEhe0dks4czWgqiI3nDp+d4kO0aMRvW5MUompjK2KXNrKwxwVLAgwI+dM1uG91yQ9GVoLLPghqU1Jn0H2/fy/9BkqVwt/tGJV+4bw3RmmPvLhozE/c5iWY1X7AdacxKSzo9UtWQ5cmLwyDMfr2/v7buV6yNjsbMlt47//O+1cRo6uhgpiZcA2pXXtyiPf29j/N7KfmgphNjmSryMGyelEXv8TTry58uEZSuNKG61cK/KASsog8T5MYKEDGyldz+X1elrvTqETfrx5O8Sd2Xy3if5HvuZdM0rFafrxKm3l429SPxODHZB++aLO4z4Uh8cOPOjVtUHA958lke12fen7foEG3nj+cl2/kaCjgwt6HIc02Nu9t7UyHT3dFocjm2JvbuCVjkee1KrA8ucPHbYvEmYTayn/duPj6gQF6U6C/u3twtRKrWBW4wum5c8S9VdlH/1FWm/zhvazTRHJFXP1a9hlS1jN6Yo5i+HxsFQllQfb/DQF98PQxy/L0jf4JivVFwRG9wJ+zXPWgT5LeGYo91oCtC00zBq4fROq8zUM8TPTvEij+OWHejQv/Qaf6Vi0NxINTkI4d0/bYsqeVZ4NUMi/6TEz4uVzAMPwChcpu7
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get Review From Event"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/review/event/{event_id}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get Review From Event
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"event_id","in":"path","required":true,"schema":{"type":"string","title":"Event Id"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Id"},"camera":{"type":"string","title":"Camera"},"start_time":{"type":"string","format":"date-time","title":"Start Time"},"end_time":{"type":"string","format":"date-time","title":"End Time"},"has_been_reviewed":{"type":"boolean","title":"Has Been Reviewed"},"severity":{"type":"string","enum":["alert","detection"],"title":"SeverityEnum"},"thumb_path":{"type":"string","title":"Thumb Path"},"data":{"title":"Data"}},"type":"object","required":["id","camera","start_time","end_time","has_been_reviewed","severity","thumb_path","data"],"title":"ReviewSegmentResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: get-review-review-review-id-get
|
||||
title: "Get Review"
|
||||
description: "Get Review"
|
||||
sidebar_label: "Get Review"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJydVcGO0zAQ/ZVoTiCZTVnBJTdgV4AEAu0WLlVVTeNpakjsYE8KVZR/R+OkaUKXReKU1n4ev3nv2W6BsQiQreCODoZ+wlqBq8kjG2ffa8igIN74OHf6nL5GbzYFMSio0WNFTF4qtWCxIshghIECYyGDGnkPCjz9aIwnDRn7hhSEfE8VQtYCH2tZGNgbW4ACNlzKQM8tea+h69ZSINTOBgqy5nqxkI+mkHtTC23I4L7Jcwph15TJ3QAGBbmzTJYFjnVdmjx2mX4Lsqad8Ki9aMCm38Hox7gJKQU5VuQf7eFNj+gUBEbPGzYi0iV+53yFDBloZHoWUeci97I0Wcpgp4Cs/r8yt1aPRfYYNlsiO7hK02a3zpWEdrLyHYbkNZFN7k5oaYgO5A0fH+JBtqkkXliSl6hoYsqjS+tJW0OBWwF3CnjfVNtNjMsjii4FlXwWVKekz17/YfZG/ndSrF/utt8o51n8VhCzOXg3M2Yi7kMSTXqesR1orP+M7j0VFVkes9h1wuzF9fVldL9iaXQMZnLrvfP/n1tNjKaMCWaqwiWgdPlsFu3x0y6e4LnknRpHjGUqyEO3PiuL3uNx4ssH1xMUV6pQPGbhRwoBi5jDHvJ3aBQjWcrsv1yVvvqtB9zEj7O8vbp/b+Oml++hzcbTsFx+vijYezs39S3xcGKEGPHeDVdrvDwl5pD24Urb8drsYsz84XStNr6EDPbMdcjSVFPlrnbeFMh0dTCaXIq1iV6dgVmali7Hcu8CZy8Xi+c9Zi0X8s5NjwsokI16uour51cLkaZ2gSuMKRsu9VknsyZH65h+cVqXaGICIpl26HI1PAqgIDs/D2sFQlCm23aLgb74sutk+EdD/gjZaq3ggN7gVriuWtAmyG8N2Q7LQBdMxhMDT+6GYDxNQD3M8OS/FfcPWDaDHt/pOHvFYub3hJp8JNHPv8pzqnmy8uKIityj529vl9B1vwF3Moq3
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get Review"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/review/{review_id}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get Review
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"review_id","in":"path","required":true,"schema":{"type":"string","title":"Review Id"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Id"},"camera":{"type":"string","title":"Camera"},"start_time":{"type":"string","format":"date-time","title":"Start Time"},"end_time":{"type":"string","format":"date-time","title":"End Time"},"has_been_reviewed":{"type":"boolean","title":"Has Been Reviewed"},"severity":{"type":"string","enum":["alert","detection"],"title":"SeverityEnum"},"thumb_path":{"type":"string","title":"Thumb Path"},"data":{"title":"Data"}},"type":"object","required":["id","camera","start_time","end_time","has_been_reviewed","severity","thumb_path","data"],"title":"ReviewSegmentResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: get-snapshot-from-recording-camera-name-recordings-frame-time-snapshot-format-get
|
||||
title: "Get Snapshot From Recording"
|
||||
description: "Get Snapshot From Recording"
|
||||
sidebar_label: "Get Snapshot From Recording"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJydVE1vm0AQ/StozivjRO2Fa9u0lZq2SqxeIgttYIC1YHczO0Sy0P73asA2Jk4qpSdgmHlvPt8ArOsA2QPcYmk0bBU4j6TZOPu9hAxq5DxY7UPjOK/IdTlh4ag0ts7zQndIOre6w3y2hzyvSExsxH6KzitHneY8r5FBgdfixEhCP4CAQAZnkKDAWMjAa25AAeFTbwhLyJh6VBCKBjsN2QC89xIamIytQQEbbsXwacRKfgpWjOrEMWf3Xgrbd49IZxQ3ApVszEuGsdL/LgBt38lM/Pi187XM5UQ5YZ/TNWjq5kT31CPtF3yVbsNrhMYy1ot6vk1IMW4lPnhnAwaJuF6v5VFiKMh4WQ/I4L4vCgyh6tvk7uAMCgpnGS2Lu/a+NcW4TekuSMwwZxFjjAo+XF9fAv/RrSnHsOQLkaN3oIIn2WA2U94lsjatvBnGLlw6tK5Y/NV2/6saN3I5FWn3i7bFbVRHmybS+7NG/nBTghAVdKH+15reYgi6RjiBve06NiPZyN84c7vHHRa8mPjDWNdEffA7W6G5vVN33y7j89S+18hOK7PZ/L4AnGa7HOpX5OT+IAbJDbkuuTtKhmSK3LiD4ozqwA1kkA5nghDTWWPSYb7imB41ZjVMlxdBQUB6PopLT62cCbMPWZqW2LlVRabWjKtnU6JLtTfjhGfHLE1bV+i2cYGzj+v11eSzlSOr3DikQwNAgRBNRa5XV6s1xPgXMa/Xkg==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get Snapshot From Recording"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/{camera_name}/recordings/{frame_time}/snapshot.{format}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get Snapshot From Recording
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"camera_name","in":"path","required":true,"schema":{"type":"string","title":"Camera Name"}},{"name":"frame_time","in":"path","required":true,"schema":{"type":"number","title":"Frame Time"}},{"name":"format","in":"path","required":true,"schema":{"type":"string","enum":["png","jpg"],"title":"Format"}},{"name":"height","in":"query","required":false,"schema":{"type":"integer","title":"Height"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: get-sub-labels-sub-labels-get
|
||||
title: "Get Sub Labels"
|
||||
description: "Get Sub Labels"
|
||||
sidebar_label: "Get Sub Labels"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVMFu2zAM/RWDZyF2g+3iW4EV7YYOG9ZslyAoZJuxlcmWKtHBAkP/PlBOYgdeDzvFoMhHvke+DECy9pBv4d5a2AkwFp0kZbrPFeRQI736vnjVskDt5581Egiw0skWCR1DDNDJFiEHb7Wi14NRHVYgQHWQw1uP7gQCHL71ymEF+V5qjwJ82WArIR9Adqdv+4hDJ8s4qiOs0UEQ11DXaw1hJ4AUaQ68cK/ky9gr8ItDb03n0TPmOsv4p0JfOmWZF9f0ZYne73ud/Dgng4DSdIQdxUms1aqMMqQHzzXDNGcIIQj4sF4vgX9JrapYljw4Z9x/oIJ1LD2pce4KSSrNX4qw9csEbcqb14V4npzq6rl2Vzl3QVxi0jnJa7nI+WzGASEIaH3NyLd4U+pX9F7WCFew91OjGMmGX8PU2xQHLOnmJraR19j6nDfb9STvqO77ND6N8v2r2SXlabP5vgAcd3u71Eek5KUvkud4+DwcUmPO7ogeoAZySCdzgACP7nhxRe805NAQWZ+naYWtWe2dqiXh6qgqNKm0Ku5pSszTVJtS6sZ4yj9m2d2Ys2Mz7U2U+kwDBHCjcdRsdbfKWBZrPLUyXtjZkwsWNySvqyP8Q6nVUsULiAMNZ4ZbmDHcCeDZODoMhfT40+kQODwanXlXystCz6z+G0/Lf4ej1H0kwuyO0imugXzLR9qgrNBFsLH2vizR0qxq4SlGuS7o8WEDIfwFTsKq/Q==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get Sub Labels"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/sub_labels"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get Sub Labels
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"split_joined","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Split Joined"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
62
docs/docs/integrations/api/get-users-users-get.api.mdx
Normal file
62
docs/docs/integrations/api/get-users-users-get.api.mdx
Normal file
@ -0,0 +1,62 @@
|
||||
---
|
||||
id: get-users-users-get
|
||||
title: "Get Users"
|
||||
description: "Get Users"
|
||||
sidebar_label: "Get Users"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJxlkUFPwzAMhf/K9M7RWpC45LYDmrgCO1UVylJvDaRNSNyJKep/R94qBCOHJHKe7e85BWyOGbrBZuIerUKIlAy7MD510DgSv02ZUl72IzEUEuUYxkwZuuC+ruXoKNvkomRC42WylnI+TH71vIihYMPINLLITYze2Uuj6j1LTkG2PQ0Gusyy1E3JLfFqJxBQGIj7sPBBIRruoVFNy3OmdJKbbgqm5KHRM8esq6qjIawPyR0N0/rkOgqViQ6z+i3UVeWDNb4PmfVDXd9dNa2CGw9BSNmxJ2hAQRpdAev13brGrBBD5sFcLI1moBv2P64K+BxFwfTFVfTGjVLhwlIWXw2uvloFIZJAKXuTaZf8PEv4c6J0hm5ahZNJzuwFrmlnhZ5MR+kyiA86Q2NjLUWZ2cn4SRr/+wjx+TPf7eMr5vkbqK669Q==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get Users"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/users"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get Users
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,62 @@
|
||||
---
|
||||
id: get-vapid-pub-key-notifications-pubkey-get
|
||||
title: "Get Vapid Pub Key"
|
||||
description: "Get Vapid Pub Key"
|
||||
sidebar_label: "Get Vapid Pub Key"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJx1kUFrGzEQhf+KeWdhbQq96JZDMKUQStvkYhYja8depdqVKs0uMWL/exjblDihuggNb0bfe1PB9lhgtniM7A/eWfZxLGgVYqJ8fn3rYHAk3s02+W6Xpv3uD5124/sGqUrxSAyFTCXFsVCBqfjSNHJ1VFz2SdQw+DU5R6UcprD6eRVDwcWRaWSR25TCdbh+KdJTUVxPg4Wpixz1YeSGePUshKsf0371nU5QGIj7eMWHQrLcw0DfoOsLOhQK5ZmypFEx5QCDnjkVo3VHQ1wfsj9apvXsO4raJo9FvRcarUN0NvSxsPnaNHcXTavgx0MUA+w5EAygIB9duJv13brBopBi4cGenY52oP9YujFdwackSqZX1ilYP8qkM1O92t3ixq7EcDHcKgiqKGrd20JPOSyLlP9OlE8w21ZhttnbvVBv20WhJ9tRPickIwzunaMk2c42TELyaXESwL89bB5+Y1neAOEa2Vc=
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Get Vapid Pub Key"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/notifications/pubkey"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get Vapid Pub Key
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: go-2-rtc-camera-stream-go-2-rtc-streams-camera-name-get
|
||||
title: "Go2Rtc Camera Stream"
|
||||
description: "Go2Rtc Camera Stream"
|
||||
sidebar_label: "Go2Rtc Camera Stream"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVE1v2zAM/SsBTxsgxGmwXXQr1qIbsC+02S6BETAyY6uzLVWigwWG/vsg2flamgE72aYeKb7HR/fAWHqQS7i1FnIBxpJD1qb9VICE0swdq5XChhyuPDvCZjUGhy+/2p+22NBqVRKDAIsOG2JysXQP8QgknABBgG5BgkWuQICjl047KkCy60iAVxU1CLIH3tmY6tnptgQBrLmOgQ+p1uRrrBVCHkt4a1pPPmbNZ7P4KMgrp22kAxKeOqXI+01XTx5HMAhQpmVqOcLR2lqrxD579jGnP3YSQggC3s3nl4V/Yq2LlDa5d864/6gK1kXFWQ99F8So6/immRp/CaiNOjvFdvdtkzQ+FyqIQ0S3TCU5CHkQ+xg6h7sTNT+boUEIAhpf/kv4L+Q9lgSHYtehSYzJIp6G491m/UyKz4a+TLyGq0dcfixzlHdQ9zqNu0G+1y7bQz4uFt8vCg6zPR/qg5k/spqMPntKZo8tElcmrcZodK5AQjbsRDbuRNafWD2AAE9uu1+GztUgoWK2XmZZQY2ZbpwukWm61QWZDK1O8zsCZZbVRmFdGc/y/Wx2M2DyuEQbk0Yw0gMB8aKBwmx6M51Fuazx3GBy3riKV9idSXAYLNNvzmyNOvkjtdWPzJfjLyJyHLiDAHm66LmA2HaE9v0aPf1wdQgx/NKR24Fc5gK26DSuI4NlD4X28b0AucHa00VXh92CN4+jhd5OQLze7d4pbfTJFutuVOkX7f76I6X9qAgLcqmNAXGrFFk+yb1Y5ziGgyse7hcQwh+nF9I2
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Go2Rtc Camera Stream"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/go2rtc/streams/{camera_name}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Go2Rtc Camera Stream
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"camera_name","in":"path","required":true,"schema":{"type":"string","title":"Camera Name"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,62 @@
|
||||
---
|
||||
id: go-2-rtc-streams-go-2-rtc-streams-get
|
||||
title: "Go2Rtc Streams"
|
||||
description: "Go2Rtc Streams"
|
||||
sidebar_label: "Go2Rtc Streams"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJxtkUFv3CAQhf9K9M5ocVbKhVsOVdRr0p5WVkTw7JoWG8qMV1kh//dqvKuoTcsFAY8335tpEH9iuAMeS0FvkAtVLzHPXwc4nPK+SnhlqeQnfv18JIFBJS55ZmK4hn3X6TYQhxqL+sDhZQmBmI9Lunu+iWEQ8iw0i8p9KSmGraz9wfqngcNIk4drqy7zyfIp758l3L1cSWAwkYx5Q96gipcRDvZKbPlDx1TPVDVxw1ITHEaRws7agaa8O9Z48kK7cxwoW18iVvOn0FmbcvBpzCzuoevur5reIM7HrNwSJREcYKCFrrjd7n7XYTUomWXyW8DZT/S/JH8FbZBLUZnQu9iSfJzVZgNqt5SH25g03c2lN1BCfWvtzTN9r2ld9frXQvUCd+gNzr5G/6awh341GMkPVLfG/KQLHB5DoKLNPPu0KMM/Y9LcH41/+vIN6/ob2rrKNg==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Go2Rtc Streams"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/go2rtc/streams"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Go2Rtc Streams
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: grid-snapshot-camera-name-grid-jpg-get
|
||||
title: "Grid Snapshot"
|
||||
description: "Grid Snapshot"
|
||||
sidebar_label: "Grid Snapshot"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVF1v0zAU/SvVfQIparqJveQNwRhIDNBWeJmq6C65TVwc27NvJqrI/x3ZSZtk3SZ4amqfe879Ou6AsXKQ3cE1lQJhk4A2ZJGFVl9KyKCyosydQuNqzXleYEMWc4UN5Xm825kqr4ghAYMWG2Kyga+DgIEMJhGQgFCQgUGuIQFLD62wVELGtqUEXFFTg5B1wHsTQh1boSpIgAXLcPAhci2+BS7vk1FDS20P7A8t2f2MfovSvcpf0hZbybFcIjVVjMxTra1WnLsCJf2/oGqbe7JTwdXyYhT7pBUvbiO195tA6IxWjlygOF+twk9JrrDChPlABrdtUZBz21YubgYwJFBoxaQ4wNEYKYo4znTnQkw3puW99wm8Oz8/Jf6FUpQxbHFpbWzuv7KCsWGFWPR5l8QoZPgSTI07BUhdzG5R7b9v4wbNxxRmMJwIxVSRBb/xyeEMrcX9ZHJfdZ8g+AQaV722VtfkHFYER7KXobEZi3W49aO2vt9RwbMVuIt19dIDbjPSjO3tu/tyGR/79j0ndoB8Xq9/nBD2s50P9cqKcnE7eDnkRlzraPLBv1xDBmk3saxPg8mXOxOqcGQfD+5urYQMambjsjQtqdHLrRUVMi0fRUk6RSPiyEZglqZSFyhr7Ti7WK3Oeswm2GirY9eHiiCBINRnvVqeLVehQ0Y7bjAu2+DFpwXNyj0OkekPp0aiiLsQ8+mGYu8gm79Px2o3CYQ8A6Tr7tHRTyu9D8e93UMPSuHwXk4M/5v2k9foEWUbqwlteAE7e03GgE34Y0WIeF7pSaVHb8Kbm2EF3y4geb4Dh01T+6nmMftJP6K/asKSbEyjR7wvCjI8iT15DkL+x+W6ulyD938B2jgstQ==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Grid Snapshot"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/{camera_name}/grid.jpg"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Grid Snapshot
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"camera_name","in":"path","required":true,"schema":{"type":"string","title":"Camera Name"}},{"name":"color","in":"query","required":false,"schema":{"type":"string","default":"green","title":"Color"}},{"name":"font_scale","in":"query","required":false,"schema":{"type":"number","default":0.5,"title":"Font Scale"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: hourly-timeline-timeline-hourly-get
|
||||
title: "Hourly Timeline"
|
||||
description: "Get hourly summary for timeline."
|
||||
sidebar_label: "Hourly Timeline"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJy9VcGO0zAQ/ZVqzlGTreCS2wKrXSQQCAqXqkJuMmm9OLHXnqwokf8djZ006XYrFa3g1NR+nvf8PH7ugMTWQb6Ca2NgnUCJrrDSkNQN5HCLNNvp1qr9zLV1Lex+Vmk7I1mjkg3OIQFt0AqGvy8hhwj+MQDGj35iiwQJGGFFjYSWmTtoRI2QQyFqtMJBApK5H1q0e0jA4kMrLZaQV0I5TMAVO6wF5B2IZv+pCiVob7iEIyubLfjkMNK0SoEPG6tEqwhyEEpBAiRJMeBtz+p5Ua9EiQ2q/y3kQySd6hAVoX2JjKatN2iflTHQXgeOKesGK23xH9O+iSRHrsta0ktoZUO4PcN7cH2RZRPPA+VUBDfsb928aPsXHX5LxeTwlwOtZ5RFZ3Tj0HH5RZbxz/HF/NoWBTpXtWr2pQdDAoVuCBsKooxRsggXM713vKYbJXvvfQKvFovTwt+FkmVYNruxVtu/qArGchiQjLpLJCEVf0nC2p0ClC6OZi/w8XDCa58MY8JasZ/eIx0Fgk+gdluufFxvhH5E58QW4VDsPDSYMVvyrB+59eYeCzpqj1XYV6TucZO2H+2N7p7fxrto33NkA+Ruufx8UjCebY200xzIQ+DSDnJIhzhOYxxDAg7t45DDrVUc4UTG5WlaYq3nlZVbQTh/lCXqVBgZTmME5mmqdCHUTjvKX2fZVcSs+fZUOhjai4UEmCh2WTa/mme8eaMd1SL0UX8B7+Jzs+yVwpMnqRvb8ZLXqbeO8BelRgkZuiLI73pTVkAjVW/Lmr8c8WTXbYTDb1Z5z8MxDtisUjqxUZNA+In7o0fsUag2bJwdO4M+PDSXgIfX4BLsIcMvUtEH7yXYST6O8DX/sZLxkK/4bu5QlGiDUXHddVGgmZKcRAlXObTt7c0SvP8DYMzqRQ==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Hourly Timeline"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/timeline/hourly"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get hourly summary for timeline.
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"cameras","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"all","title":"Cameras"}},{"name":"labels","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"all","title":"Labels"}},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"After"}},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Before"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":200,"title":"Limit"}},{"name":"timezone","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"utc","title":"Timezone"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
62
docs/docs/integrations/api/is-healthy-get.api.mdx
Normal file
62
docs/docs/integrations/api/is-healthy-get.api.mdx
Normal file
@ -0,0 +1,62 @@
|
||||
---
|
||||
id: is-healthy-get
|
||||
title: "Is Healthy"
|
||||
description: "Is Healthy"
|
||||
sidebar_label: "Is Healthy"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJxdkc1uwyAQhF8lmjOynUq9cMuhanvtz8myImJvYlQMFNZWLYt3r7CjKg0XYDXsfjMsYHWJkDUO3qMRcJ6CYu3sawcJHY89KcP9fDxeiCEQKHpnI0XIBQ9VlbeOYhu0z68g8T62LcV4Hs3u7SqGQOssk+UsZ/rh0hulbb7FtqdBrfXZEyQiB20vSHmJu96vcfey8UBgIO5dptzIvOIeEiUEIoWJQra1YAwGEj2zj7IsOxpccQ76opiKSXfkSuU1krgVyrI0rlWmd5HlY1XtN00joO3ZraiaTWaFQB60wVXFvqiQBLyLPKjVnVUD3XP/s/Rn+yaVJDaY5eqpRv6ZTJPPy3JSkT6DSSmXv0cKM2TdCEwqaHXKYHWTBHpSHYU1hC+aIXFoW/I5qkmZ8X5mcxPo89MHUvoFuJ+1Kg==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Is Healthy"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Is Healthy
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"text/plain":{"schema":{"type":"string"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: label-clip-camera-name-label-clip-mp-4-get
|
||||
title: "Label Clip"
|
||||
description: "Label Clip"
|
||||
sidebar_label: "Label Clip"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJy9VE2P0zAQ/SvVnECymu5qufiGYAVILKClcKmiaJpMEy9O7LXdiiryf0fjpB+hu0gIiVMi+82bN29m3EPA2oNcwR1VCiEXYCw5DMp0HyqQoHFNuii1skVRYksOiw5bKopiuBmuWntT1BRAgEWHLQVyTNoDY0HCWSQIUB1IsBgaEODocascVSCD25IAXzbUIsgewt5yqA9OdTUICCpoPniTuGafmCtGccyR9Pwz+8fEEmPOwd6azpNn/PViwZ+KfOmUZXtAwtdtWZL3m62e3Y9gEFCaLlAXGI7WalUmN7MHzzH9SUOMMQq4ub6+JP6OWlUpbHbrnHF/wQrWcQeDGnRXFFBp/lOBWn8J0Kac3GK3/7xJvZtaxE6PJ6oLVJODmEdxOEPncH/uoxkEQhTQ+vpPlt+R91gTHMmehyYzZku+jafcZv1AZZi0e5XqGlKPuPxEc7J3cPf5Mt4O9j2V7AB5v1x+uSAcejttahqt2RutLAuj0BhesMPahAYkZP3ZpsSsTzMdM96xeWtvQIAntzss19ZpkNCEYL3MsopaM984VWOg+U5VZDK0KvXtBJRZpk2JujE+yFeLxdWAyXltNiZZP5YFAjjRIH0xv5ov2CZrfGgxTdy4dpOqJgUf2xjoZ8isRpWmIYnpx4pXIKdvgzys8bHmXACrZWzfr9HTN6dj5OPHLbk9yFUuYIdO4ZqFr3qolOf/CuQGtacLWcdVghf348S8nIF4Wu5hMDoeix3q7WjOD9r/9rCx0/8x9WBU2sGGsCKXah/uXpcl2XAWdfFkcMuPM/judgkx/gJbJAxf
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Label Clip"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/{camera_name}/{label}/clip.mp4"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Label Clip
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"camera_name","in":"path","required":true,"schema":{"type":"string","title":"Camera Name"}},{"name":"label","in":"path","required":true,"schema":{"type":"string","title":"Label"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: label-snapshot-camera-name-label-snapshot-jpg-get
|
||||
title: "Label Snapshot"
|
||||
description: "Returns the snapshot image from the latest event for the given camera and label combo"
|
||||
sidebar_label: "Label Snapshot"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJy9VE2P0zAQ/SvWnECKmu4KLrkhWAESC2i3cKmqaJpMExcn9tqTiiryf0d2kn5s2ZUQglMiz5uvN2+mB8bKQbaEWyolwiqBklxhpWGpW8jgjrizrRNck3AtGldrFrLBisTG6ia+K2RyLGhHLYuNtvGxkjtqRYENWRTYlkLhmpQodLPWkIA2ZDHk+FhCBtGWT/HzfHDLW2woz/PBejRvTZVXxJCAQYsNMdnQQg8BDxmceEMCMrRhkGtIwNJDJy2VkLHtKAFX1NQgZD3w3gRXx1a2FSTAklV4eDs08DnE8j455Ig1/XX0TzGK96vg7IxuHbmAv57Pw+d8FPddUZBzm06JuxEMCRS6ZWo5wNEYJYvIarp1wac/1uC99wm8ur6+DPwdlSyjm7ixVts/iArGhkmyHOouiVGq8CeZGncJULo4s2K7/7KJszunKDA9vsiWqSILfuWT6Q2txf0pj3ooEHwCjaueo/yWnMOK4BDsaWgkQyyC1R9z6/WWCj4b9zL2NaQecatjmCO9A7tPt/FuoO93ySbIh8Xi60XAYbYNca3DNk27wTVkkPYn6+DTPgrXp9MyzbYm1OzI7qYt6qyCDGpm47I0LanRs42VFTLNdrIknaKRcUBHYJamSheoau04ez2fXw2YVdiPjY4cj/VDAiHRILz57Go2D3wY7bjBKK1xv+JmiPuxSnh0lvqjQP/ZhRonwPSTU6NQRnHFlvuR2yVk56cmm67CGburBAIvAd/3a3T0zSrvw/NDR3YP2XKVwA6txHWgaNlDKV34LyHboHL0TPMv7kYRvhRPlTxprQ1K26HqxjH8oP2jWxlm+h9TD2TFta4JS7Kx98H2pijI8InXxRUK4joo/v3NArz/BaSkVOg=
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Label Snapshot"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/{camera_name}/{label}/snapshot.jpg"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Returns the snapshot image from the latest event for the given camera and label combo
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"camera_name","in":"path","required":true,"schema":{"type":"string","title":"Camera Name"}},{"name":"label","in":"path","required":true,"schema":{"type":"string","title":"Label"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: label-thumbnail-camera-name-label-best-jpg-get
|
||||
title: "Label Thumbnail"
|
||||
description: "Label Thumbnail"
|
||||
sidebar_label: "Label Thumbnail"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJy9VE2P0zAQ/SvVnECymu4KLr4hWAESC2gpXKoomibTxMWJvbZTUUX+72ic9IuySAiJUyL7zcybN/M8QMDag1zBPVUKIRdgLDkMynTvK5CgcU26CE3frjtUuihKbMlh0WFLRVGM18WafCi2ti5qCiDAosOWAjnOPABjQcJZJAhQHUiwGBoQ4OixV44qkMH1JMCXDbUIcoCwtxzqg1NdDQKCCpoPXqdcs4+cK0ZxrJH4/HP2DylLjDkHe2s6T57xt4sFfyrypVOWNQIJX/qyJO83vZ49TGAQUJouUBcYjtZqVSZJs63nmOHEIcYYBby4vb1O/A21qlLY7M454/4iK1jHYwxq5F1RQKX5TwVq/TVAm/LiFrv9p02a3aVErPR0orpANTmIeRSHM3QO9+c6mpEgRAGtr/8k+T15jzXBMdnT0CTGbMm38VTbrLdUhotxr1JfY+kJl5/SnOQd1X26jTejfL8rdoC8Wy4/XyUcZ3s51LRas+XBT8yOQmPYagfvhAYkZMOZXWI2pMWOGRttvrXcjye3OzisdxokNCFYL7OsotbMN07VGGi+UxWZDK1KwzsBZZZpU6JujA/y5WJxM2Jy9s7GJP2n3kAAFxr5L+Y38wVrZY0PLaa1m7x33dpF68eBBvoRMqtRpb1IjIap7RXIy1dCHgx9bDwXwJQZOwxr9PTV6Rj5+LEntwe5ygXs0ClcM/vVAJXy/F+B3KD2dEXraCp49jDtzvMZiN/TPaxIxwuyQ91PCn2n/S9PHMv9H0uPQiU3NoQVudT7ePeqLMmGs6irx4PnflzEt3dLiPEnsjATVQ==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Label Thumbnail"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/{camera_name}/{label}/best.jpg"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Label Thumbnail
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"camera_name","in":"path","required":true,"schema":{"type":"string","title":"Camera Name"}},{"name":"label","in":"path","required":true,"schema":{"type":"string","title":"Label"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: label-thumbnail-camera-name-label-thumbnail-jpg-get
|
||||
title: "Label Thumbnail"
|
||||
description: "Label Thumbnail"
|
||||
sidebar_label: "Label Thumbnail"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJy9VE2P0zAQ/SvVnECymu4KLr4hWAESC2gpXKoomibTxMWJvbZTUUX+72ic9IuySAiJUyJ75s28N/M8QMDag1zBPVUKIRdgLDkMynTvK5CgcU26CE3frjtUuihKbMlh0WFLRVGM12f3W1sXNQUQYNFhS4Ecww/ACSDhLB0EqA4kWAwNCHD02CtHFcjgehLgy4ZaBDlA2FtO9cGprgYBQQXNB68T1uwjY8UojjVSU/+M/iGhxJhzsrem8+Q5/nax4E9FvnTKslAg4UtfluT9ptezhykYBJSmC9QFDkdrtSqTrtnWc85w6iHGGAW8uL29Bv6GWlUpbXbnnHF/gQrW8SyDGvuuKKDS/KcCtf46QJvy4ha7/adNmt2lRKz0dKK6QDU5iHkUhzN0DvfnOpqxQYgCWl//SfJ78h5rgiPY06FJjNmSb+OptllvqQwX414lXmPpKS4/wZzkHdV9msabUb7fFTuEvFsuP18BjrO9HGpardnyYBrujkJj2G8H74QGJGTDmV1iNqTFjtnRbfOtZVKe3O5gs95pkNCEYL3MsopaM984VWOg+U5VZDK0Kk3wFCizTJsSdWN8kC8Xi5sxJmcDbUwawkQQBHChkcRifjNfsGDW+NBi2r3JgNf8LvgfpxroR8isRpWWI3U0TNxXIC+fCnlw9SX7XAD3zQnDsEZPX52OkY8fe3J7kKtcwA6dwjVTWA1QKc//FcgNak9XvR3tBc8epi16PgPx+54Py9LxquxQ95NM32n/y2PHmv/H0qNayZcNYUUucR/vXpUl2XCWdfWM8PCPK/n2bgkx/gTuQRmX
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Label Thumbnail"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/{camera_name}/{label}/thumbnail.jpg"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Label Thumbnail
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"camera_name","in":"path","required":true,"schema":{"type":"string","title":"Camera Name"}},{"name":"label","in":"path","required":true,"schema":{"type":"string","title":"Label"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: latest-frame-camera-name-latest-extension-get
|
||||
title: "Latest Frame"
|
||||
description: "Latest Frame"
|
||||
sidebar_label: "Latest Frame"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJy1lV1r2zAUhv9KONcmdsvGwJfbWjZo9tGGXawUo9jHtjJZUqXjrlnQfx+SHUch62AD3+RDOjrPq1ey3z0Qayzk97DCijN4SEBpNIy4kh8ryEEwQktFbViHRVGyDg0rZPgzThX4TCgtV7IoGiRIQDNfTWh84z34asghWgsJcAk5aEYtJGDwsecGK8jJ9JiALVvsGOR7oJ32Sy0ZLhtIgDgJP/Au9Fp88r2cSybGJOW/CSj7ztvxEzfabyUMbvXwiY036CDiaoLFEjYb9XygP/Zodif4mgl7wmdy97kONo1KuCRs0IBvOQ7JXghwEfmtZ8RQ4h1aYp2em7yeQDH+l5Jo50Z/D5AY2zH7Y27qyjNOoIqi+zUbdqDEYIMNV3J2m29HTIx+7JngtJsLXWHNekGQv8mOOr6OzFhHi7xpaW4HPgyUGGxJGZybexcgzg8ZtFpJi9Y3u8wy/1WhLQ3X4V7kcNeXJVpb92JxOxZDAqWShJKCBK0FL8OLPN1av2Z/FOiccwm8urw8b/yNCV6FZYsrY5T5h66gjQ8P4oPuColx4X9xws6eFwhVnsyeuTa+lSPTJh8fXHIYY8awXRQON2oQCC6BzjZ/y5EVWssahKnZy6XBjMXaz7ojW222WNLJZbgP+xrQY110yEd7B3df3sb7wb4/waabul5/OWs4nO3pod6EqF5cmyF8O6RW+XQ/5DW1kEO6jyLapUO8L/dTpjpIwKJ5OuR6b4R/Jom0zdO0wk4ta8MbRrh84hWqlGkezu5YmKepUCUTrbKUv86yi6HmwT9ZtQr2j1uDBDxokJ8tL5YZOPcb1LXyGg==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Latest Frame"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/{camera_name}/latest.{extension}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Latest Frame
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"camera_name","in":"path","required":true,"schema":{"type":"string","title":"Camera Name"}},{"name":"extension","in":"path","required":true,"schema":{"type":"string","enum":["webp","png","jpg","jpeg"],"title":"Extension"}},{"name":"bbox","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bbox"}},{"name":"timestamp","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Timestamp"}},{"name":"zones","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Zones"}},{"name":"mask","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Mask"}},{"name":"motion","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Motion"}},{"name":"regions","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Regions"}},{"name":"quality","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":70,"title":"Quality"}},{"name":"height","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Height"}},{"name":"store","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Store"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
70
docs/docs/integrations/api/login-login-post.api.mdx
Normal file
70
docs/docs/integrations/api/login-login-post.api.mdx
Normal file
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: login-login-post
|
||||
title: "Login"
|
||||
description: "Login"
|
||||
sidebar_label: "Login"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVE1P3DAQ/StozulmQe3FN1qQWomKFSy9RKvKm8wmpk5sPBNgFeW/V2PvkgUKbXPIx/h5PO+9mQzAuiZQBZz23MAqA+cxaDau+1aBAutq0/1Md++IIYOAdz0Sf3bVFtQQP03AChSHHjMoXcfYsSxp760pY7L8llwnMSobbLW8+SBHsUGSr54wyJO3HkEBcTBdDRmwYSuBG1kfM/Ca6MGF6j3sYo8Zx2wPcutbLPflp3qLdOhBztWU49T7hSO+EOaR6jhKtoDkXUep5pP5XB4VUhmMF5qg4LovSyTa9PboageGf1clnfLx5OR14h/amipuOzoPwYX/yPpC6wpZGytvhrGl1wDrymeruttebkAVLyUfs6eI6RhrsWg1aa5D0NsDXy5cKlB8bKl+z8LvSKRrhKdkb0OjGEdLWf2b38IrHb3DHRg+yZvUfZvGWZLvT4ftIV+Xy8WrhMnb56bG/pKakBsnA7cbMq+5AQW53a0ThnsMFD3ogwUFDbMnlecVtm62CabWjLN7U6HLtTfRmgmo8ty6UtvGEatP8/lxwqwykF65mib6/FG33uI0kZPe0+RN9oPpNi6asyMOGUididx8djybx6F1xK2OPdnpFg94P1PjyWPGR8691Sa2SqQx7CQp0i9JnBMyEhiGtSa8CXYcJXzXY9iCKlYZ3Otg9FoKK6QtG9SVcCoG+IVbUPAlzc+H2DwCt300/OUsiZhpx2lZoud3sasDNxeX10vIYL37V7aukj1BP0hj6ockmIv046DF2ABWd3Uv7a8g5ZTrNw3d8Qk=
|
||||
sidebar_class_name: "post api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Login"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/login"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Login
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"user":{"type":"string","title":"User"},"password":{"type":"string","title":"Password"}},"type":"object","required":["user","password"],"title":"AppPostLoginBody"}}}}}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
62
docs/docs/integrations/api/logout-logout-get.api.mdx
Normal file
62
docs/docs/integrations/api/logout-logout-get.api.mdx
Normal file
@ -0,0 +1,62 @@
|
||||
---
|
||||
id: logout-logout-get
|
||||
title: "Logout"
|
||||
description: "Logout"
|
||||
sidebar_label: "Logout"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJxlkU9PwzAMxb8Keudo7ZC45LYDQkic+HOqKpSl3hpIm5C4E1PU747cDTQgF0v2c/x7dgGbfYZusJm4R6sQIiXDLoz3HTR82IeJX89hTwyFRDmGMVOGLriuawkdZZtclD5oPE3WUs67yV89nsVQsGFkGlnkJkbv7DKmesvSU5BtT4OBLrM89efLh4UACgNxHwTtBBMN99Co/Hc9UzpQEksFU/LQ6Jlj1lXV0RBWu+T2hml1cB2FykSHWV0KdVX5YI3vQ2Z9U9frk6ZVcOMuCCc79gQNKMigE169Wq9qzAoxZB7MYmg0A12S/zJUwMcoZaZPrqI3bpT2BaScXTXn9ctZhEcypWxNppfk51nSHxOlI3TTKhxMcmYraE07K/RkOkrLGt7pCI2NtRSF42D8JJP/HUFc/qz37vYZ8/wFhWK5Rg==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Logout"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/logout"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Logout
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
70
docs/docs/integrations/api/logs-logs-service-get.api.mdx
Normal file
70
docs/docs/integrations/api/logs-logs-service-get.api.mdx
Normal file
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: logs-logs-service-get
|
||||
title: "Logs"
|
||||
description: "Get logs for the requested service (frigate/nginx/go2rtc)"
|
||||
sidebar_label: "Logs"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJylVctu2zAQ/BVhTwlAWI7RXnQLkCAtkKJF4vYSGAYtrWWmFKmQqzSGoH8vlpJsqbaDFL74IQ53ZofLUQ0kcw/JE1yXJQi4t7mHhYAMfepUScoaSOAOKdI299Hauog2GDl8qdATZpFH96pSjC7WTuWSMDa5Mm9xbmeO0ksQYEt0kut8zSABrrIMH8tu53KZI4GAUjpZIKFjNTUYWSAk0IFAgGIhpaQNCGB65TCDhFyFAny6wUJCUgNty7CNnDI5CEBTFdxdpw4EBH0goFXIvZIizZseO66mETv+zP4x2sqsF/BSoduOFKyl9iMJ0my/r0MPYzFctXtiKq2hGVDf9DRDbk8OZXEO88pajdIcpc5wLStNuzI7F1rWsRDp6BwdyhDm6N7XMR1qYMKhBDRnHcF7AnrSW8P2L7iwL63x6LnUbDrlr/F9eKzSFL1fVzp66MAgILWG0FAQUJZapWHs42fPe+q9vKZpGgGfZrPDwr+kVlnYFt06Z91/VIXS8VUj1erOkKTS/EsRFv4QoG06Wv3A2O5cXDSifyadk3wavYv3thUIjYDC58fuZA/9ht7LHGFX7DQ0mBHNebXZc9vVM6Y0GoWn0FdL3eEGR7y3t3X3dBs3rX3HyHrIl/n8x0HB9mwLpI3luOujjTaQQMy5F9ddpDUgQrr1gVc5DQlsiEqfxHGGhZ10oTV5VRnaWJYqHMYemMSxtqnUG+sp+TydXrWYBV+UtQ1+dlpBABO1QzadXE2m3HtpPRUyjFF3zUL8/5P+9X4Ez3oRdD4SvlFcaqnCiIRm6s6hp/B6AAFJH/sLAdwcL9X1Snr86XTT8OM2Bdi4THm50oMc+I3bcXK/Sl0FF9i+E/Bd2H4M3AbiR7Btcu2RC/7jFEOPyz9p/sVDN+aX0Sk7+2k22yHnTnb/guP7u0GZoQsS2tXrNMVy2NVB3LD23Wjf3c6haf4CHtPKNg==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Logs"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/logs/{service}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get logs for the requested service (frigate/nginx/go2rtc)
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"service","in":"path","required":true,"schema":{"type":"string","enum":["frigate","nginx","go2rtc"],"title":"Service"}},{"name":"download","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Download"}},{"name":"stream","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"title":"Stream"}},{"name":"start","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":0,"title":"Start"}},{"name":"end","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"End"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
62
docs/docs/integrations/api/metrics-metrics-get.api.mdx
Normal file
62
docs/docs/integrations/api/metrics-metrics-get.api.mdx
Normal file
@ -0,0 +1,62 @@
|
||||
---
|
||||
id: metrics-metrics-get
|
||||
title: "Metrics"
|
||||
description: "Expose Prometheus metrics endpoint and update metrics with latest stats"
|
||||
sidebar_label: "Metrics"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJytUk2L2zAQ/SvmnUXsXehFtz0spYdC6banEMqsPInVypaqGacbjP97mSSbdum1ugxIT3pfWqB0EPgtHkrBzqFnCTUWjXmCx+NLycLNp5pH1oFnaUbWGoM0PPUlx0kbmvpmLj0p385+RR2aRMqijSipwCEXrmSvfujhcUV+e50HVjhUlpInYYFfcN91Nt7qeZpDYJH9nJrPVzAcQp6UJzU4lZJiOBO138XuLJAw8Ejwy2rLGfmQTcWFtZAO8GivWuAgXI9cLZUFc03wGFSL+LbtecybfY0HUt4cY8+5pRKxur+Bvm1TDpSGLOrfdd3dBbNziNM+myKNmhgecDCii7duc7fpsDqULDrSWfpEo+E+3qS9iWP54/w/NqWnYpzKL9qWRHEyTWd3yzWr7Wt/9mHMpW0tyzMJf61pXW3758z1BL/dORypRno2w9vd6jAw9VzP4f7gEzweQuBiTRwpzUb9T4mW3a21949fsK6/AWjX8o8=
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Metrics"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/metrics"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Expose Prometheus metrics endpoint and update metrics with latest stats
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: mjpeg-feed-camera-name-get
|
||||
title: "Mjpeg Feed"
|
||||
description: "Mjpeg Feed"
|
||||
sidebar_label: "Mjpeg Feed"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJy1lclu2zAQhl/FmFMLEJaTLgfduiRtgbotUreHBoZBSyOJCSUyJBXEFfjuBamNip3CKZqTZfLXfLNoZhowNNcQX8ISU0ZhTUBIVNQwUX1KIYbySmK+yRDTzSahJSq6qWiJm02OBghIqmiJBpWz0YC7ghgCIRBgFcQgqSmAgMKbmilMITaqRgI6KbCkEDdgdtK9qo1iVQ4EDDPcHbzztmZfnC1rycDIpO5t39SodhPjGeX6kHVWGcxRAYEUM1pzA/GLEXUu9QRRIMsL838orxcj52NrN0Rtt+LuESBa7b5mPuP3kM5kd1TVnINdj9i3jhFCDStRG1rKpyavBlCI/y0qfEwN/wn9y0NCbEn19VNTl44xgQrXUU+ObSkhWGHORPXkab7oMNYdKtRSVBq1M3e6WLifFHWimPT+xfC9ThLUOqv57KITA4FEVAYr452QkrPEj6HoSrt3mtFFa60l8PL0dN/wT8pZ6l+bnSkl1COsglRu9BnW+p2ioYy7J2aw1PsCLpLJ7V7eulEWpG3I5NqS/owqRXfBvPssWgfBEih1/rfRuEStaY4wGHtY6pMxW7lbO7LF9goTM/kcLn1cLbrTBWUe09tm9+Ew3rfpOwQbxuBq9W3PYFvbaVGXbgfNzhFT5xiaQrjN1C8gU0AMURPsHAsENKrbfivVirtpbozUcRSlWIp5plhODc5vWYoiopL5Mo3COIq4SCgvhDbxq8XipNWsXRtlwme6iwIIOFDr6WJ+Ml+4rEihTUn9B9Y14iSISXxD1QzemUhyynzxvTNNF+AlxOFSXRNwnrnzptlSjT8Ut9Ydtw3uok6ZplsetPg17oa9eUt57b13YT+gHNbfMeJugR0jDdfOMfp+Txyj7Yb7UdJ+JB8jHsfoqF67P4o5+eGE36vyMIjg2UXXb89nQA5Xv2+rahcye3fCb8EPkwJpisq70SreJAnKsHh7s8/5PzTTh7MVWPsHr/Bg2A==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Mjpeg Feed"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/{camera_name}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Mjpeg Feed
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"camera_name","in":"path","required":true,"schema":{"type":"string","title":"Camera Name"}},{"name":"fps","in":"query","required":false,"schema":{"type":"integer","default":3,"title":"Fps"}},{"name":"height","in":"query","required":false,"schema":{"type":"integer","default":360,"title":"Height"}},{"name":"bbox","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bbox"}},{"name":"timestamp","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Timestamp"}},{"name":"zones","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Zones"}},{"name":"mask","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Mask"}},{"name":"motion","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Motion"}},{"name":"regions","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Regions"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: motion-activity-review-activity-motion-get
|
||||
title: "Motion Activity"
|
||||
description: "Get motion and audio activity."
|
||||
sidebar_label: "Motion Activity"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJylVU1v2zAM/SsGz0acdtvFt24rugErNrTZLkFQMDadqJMtV6KzBYH/+0DJH0nTtOt2SmQ9PZKPT9QOGFcO0jnc0EbRL1jEkJPLrKpZmQpSuCKOSiOLCKs8wiZXJsKM1UbxdgIxmJosyv7nHFII0LsecGc97bju9lfEEEONFktispLBDiosCVLIsCSLDmJQksBDQ3YLMVh6aJSlHNICtaMYXLamEiHdAW9rOejYqmoFUkGBjWZIAbWGGFixFsCHjrlt4yHakgpj6fXBqqZckt0jfx+I9rmxYA/5X+oLz7PP7DLU/5C0qphWnnqQ6M10jHPrWdt2IVyuNpUjJ6fPp1P5OTTGbZNl5FzR6OimA0MMmamYKhY41rVWmbdGcu/kzO44I7QWJXfFVPpYtRVDsQqRHaPlO1ZS9BNVDIkLLJoJrI07Dz4n6HVAtHFntqdMdGgaUb+HmOU9ZXwg+Hw/0yGDgX4x0oV7dtHdh5DIoF+7jwvfogCJ+hNRIBjX3f4VMbStZPn2/Py4Wz9Qq9z3Irq01tjXtOqwJTkxKi3/TvRMm+xgF6vt18Jf8EOJxc6POtouRpV7Z/SCfDEhQd9ht3quZdfkHK6CnB5yGurFiGay+1KHpa4QusPtdXWUN6h7uoyPQb6ngvWQT7PZtyPC0NuSeG1kzvYDlNeQQhKmbNJP2WTwnyO76cdrYzWksGauXZokOZVmUli1QqbJRuVkEqyVb8oITJNEmwz12jhO302nZwGzkMFTGK9rlzPEIIGC2aaTs8lUNKiN4xK9nbrB9cjN8Oi52Y2ufPnl6fRj+s1JrVF5a/jkd50ycwjKQAw4RuzUWcQgdQlqt1uio+9Wt618DgNVNMuVw6XeG6k/aXvwRG1QN75+Ee4Eenhi/gbcvxl/g+1fgRG7kIVVAoZ0LrdpTZiT9cWEQxdZRjXvnTq6/MIyGO3qcgZt+weBd8eb
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Motion Activity"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/review/activity/motion"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get motion and audio activity.
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"cameras","in":"query","required":false,"schema":{"type":"string","default":"all","title":"Cameras"}},{"name":"before","in":"query","required":false,"schema":{"type":"number","title":"Before"}},{"name":"after","in":"query","required":false,"schema":{"type":"number","title":"After"}},{"name":"scale","in":"query","required":false,"schema":{"type":"integer","default":30,"title":"Scale"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"properties":{"start_time":{"type":"integer","title":"Start Time"},"motion":{"type":"number","title":"Motion"},"camera":{"type":"string","title":"Camera"}},"type":"object","required":["start_time","motion","camera"],"title":"ReviewActivityMotionResponse"},"title":"Response Motion Activity Review Activity Motion Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
62
docs/docs/integrations/api/nvinfo-nvinfo-get.api.mdx
Normal file
62
docs/docs/integrations/api/nvinfo-nvinfo-get.api.mdx
Normal file
@ -0,0 +1,62 @@
|
||||
---
|
||||
id: nvinfo-nvinfo-get
|
||||
title: "Nvinfo"
|
||||
description: "Nvinfo"
|
||||
sidebar_label: "Nvinfo"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJxlkU1PwzAMhv8Kes/RWpC45LYDQlw48HGaJpSl3hpIk5C4FVPU/47cDcRHLpbi1/bz2hVsDgV6g3VK2CrERNmwi+Gug0aYXNjHl3M4EEMhU0kxFCrQFVdtK6GjYrNLUgeNx9FaKmU/+ouHsxgKNgamwCI3KXlnlzHNa5GaimJ7Ggx0neWpPy3vFwIoDMR9FLQTTDLcQ6MJX/lCeaIsjirG7KHRM6eim6ajIa722R0M02pyHcXGJIdZ/RTqpvHRGt/Hwvq6bS9Pmq3C0l9XsGNP0ICCDDrhtavLVYtZIcXCg1kMBTPQT/Jfhir4mCTN9MFN8sYFKV9A6tnV5rx+OYvwyE+tO1PoOft5lu/3kfIRerNVmEx2Zidom+2s0JPpKC9reKMjNNbWUpKVTcaPMvnfEcTl93pvb54wz59IN7iZ
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Nvinfo"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/nvinfo"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Nvinfo
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: plus-models-plus-models-get
|
||||
title: "Plusmodels"
|
||||
description: "Plusmodels"
|
||||
sidebar_label: "Plusmodels"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyNVMtu2zAQ/JVgz4TlBO2Ft7RJH0CDBq3bi2EENLWSmVIiQ66MGgL/vVhSfsEN2pMIcji7M8PVCKTaCHIJt97DSoDzGBQZ13+uQYK3Q3xwNdr4xMunrqxbJBDgVVAdEga+P0KvOgQJjbGE4d3u/RAC9pRv3yGhJhdAgOlBwsuAYQcCAr4MJmANslE2ooCoN9gpkCPQzjPb2jmLqgcBNTZqsHSAkiHLiA+53nqnS73cYb2vl9KKq0Tv+oiReW/mc/7UGHUwnoWChO+D1hhjM9irbxMYBGjXE/bEcOW9NTr7Uj1HvjMee00pJQFvbm4uiX8qa+p87eo+hGzA/7KCD5wFmdJ3jaSM5ZUh7OIlwDp9dqr63dcmBzNZGSmYvoUkDjumJ2wxQFolsd9TISiOZm/vF1cahCSgi+1JNBPfEfqAMaoW4UD2OjSbcbXg03Ss7dbPqOnsXSyzrlJ6wq2ONEd7i7uvy7gr9v2t2B7yabF4vCAs2Z6H+miHWAaBG0PaOB6V/UzQBiRUPC3VARQxbPdjMgQLEjZEPsqqqrFzsyaYVhHOtqZGVylvckhHoKwq67SyGxdJvp3PrwtmxdPUuOzzpAEEcKHS53x2PZuzJ95F6lR+XtOQnkk4U3fIjPA3Vd4qk6PPzYyTvGX+L7D4QrESwK3xwTiuVcQfwabE22XQWXZtolrbk1H/hbt//y22yg5ZF4vdqmCYA+SSH+wGVY0hkxeuW63R08mti/lilkNgH+8XkNIfph65QA==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Plusmodels"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/plus/models"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Plusmodels
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"filterByCurrentModelDetector","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Filterbycurrentmodeldetector"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: preview-gif-camera-name-start-start-ts-end-end-ts-preview-gif-get
|
||||
title: "Preview Gif"
|
||||
description: "Preview Gif"
|
||||
sidebar_label: "Preview Gif"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJy9VE1vm0AQ/StoTq2EDHGbQ7lFSZRWatoodXuJLDSGMWwKC9ld3Fho/3s1C9gQO5XSVrn4Y3f2vZk3M68Fg5mG6A6uKRUISx+qmhQaUclPKURQK9oI+hVnYh3HCZakMJZYUhxrg8oMX0bHMcm0++A/43cZGfChRoUlGVJM1wKDQAQjSPBBSKZEk4MPih4aoSiFyKiGfNBJTiVC1ILZ1vxUGyVkBj4YYQo+OHdY3hfGstbfcQwpvpRANuWK1IjgGwN5Cz1B7yr+Z+xLmT5FLvExTjDJKcZsp85DQ2o7YVhjoY9RCGkocxwp6USJmpsKEVzjo+dgPczIE9LTlFQy1TPvgtbYFMZ7F3opbvX4zqG4W4jmpx/mYRjuc2fEc4d4lhHY/0Nol1ykriupSXNZ8zDkryn2tyZJSOt1U3i3fTD4kFTSkDQcjnVdiMQNdHCv+U27l8paa314P58fAv/AQqTumXepVKVegAq14iUyoss7JYOi4F/CUKkPA4oqmdyi3H5duyWZTjqPxpPe2qX1hzNUCrejifpcdQlyQ0qd/Wlzrklr7FrXhTwf6sTwFnxr99zV6p4SMxnLO1dXR93HLfcwe3k7dZ8v46KT7xjZEPJxsbg5AOx6O23qTedK3pVYc2Zk8opNbjAok0MEQTvyJBs48wjawUNsQDIN2m7pbdDb3CxzgJrUZvC3RhUQQW5MraMgSKmsZmslMjQ024iUqgBr4Tq6D4yCoKgSLPJKm+g0DE+6mCVv/rpyTekLBh+YqCsqnJ3MQhawrrQp0c1i7yDTeida7Dps6NEEdYHCDYrLpu21uINo6s9OBfAhGlkqyZRPdjY4lmTpAxfDSG27Qk3fVWEtH3c2xkKlQuOqGBnZkzR3W/fXxnW00J+0PWKxGywaJzCrvkElOLUXpvnmtt+Bt95z5MOoy+2Yc0hqrDlPyCtS7/r6yrz99Dg7ywlTUk707vIsSag2o2cH7svd2m3z1eUCrP0NgVcB7w==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Preview Gif"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/{camera_name}/start/{start_ts}/end/{end_ts}/preview.gif"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Preview Gif
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"camera_name","in":"path","required":true,"schema":{"type":"string","title":"Camera Name"}},{"name":"start_ts","in":"path","required":true,"schema":{"type":"number","title":"Start Ts"}},{"name":"end_ts","in":"path","required":true,"schema":{"type":"number","title":"End Ts"}},{"name":"max_cache_age","in":"query","required":false,"schema":{"type":"integer","description":"Max cache age in seconds. Default 30 days in seconds.","default":2592000,"title":"Max Cache Age"},"description":"Max cache age in seconds. Default 30 days in seconds."}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: preview-hour-preview-year-month-day-hour-camera-name-tz-name-get
|
||||
title: "Preview Hour"
|
||||
description: "Get all mp4 previews relevant for time period given the timezone"
|
||||
sidebar_label: "Preview Hour"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJy9VVFr2zAQ/ivmnjYwcVq6F72NtbSDdStdNhghmKt9cdTZliop2Vyj/z5OtpN4WQulI09RpNN3uu+++9yCw8KCmMONoY2kX7CIISebGamdVDUIuCQXYVlGlT6LdBdkI0MlbbB20VKZyMmKIk1Gqjwq5IbqyK0o7D6qmiAGpckgw33MQUAPkq7U2qTDn7QhNGmlardK0zTHJk27gDTNsCKDaY0VpWnqHvtVQQ5i0GiwIkeGi2iBj0DADgxikFyFxrA29LCWhnIQzqwpBputqEIQLbhG803rjKwLiMFJV/LGD0ITXQco7+Nthhybl0LL2lFBZg/7HJsRKBf8etQrRtmH3SPw1XR8CFjRZ8baz9G35dX4s8cBe8HXrVa1Jcs3TqdT/hmL8+s6y8ja5bqMbvtgiCFTtaPacThqXcosiC+5t3yn3b3Ce+9jODs9PQT+jqXMw7XowhhlXoAK2rDgnezenZNDWfJKOqrsYUCpstEp1s2XZVDzmCRm+6+m+4WPhz00JmhyYPKT6h4IPobKFs+Rfk3WYkGwBXs6NJARzfjU73Kru3vK3Kjh81BXl7qPW+xgdvR27D5dxnlH37+SbQU/m90cAHa9rcitFJvO4BZuBQKS3nWSdmcUPmlzbHzS8hD6pN0bGp+0vbw9xGDJbAa7WZuSx9Y5bUWS5FSpydLIAh1NNjInlaCWoW+7QJEkpcqwXCnrxLvp9KSLWfDgLFWgvi8LYuBEnR6nk5PJlGnSyroKg+L60eudO7rq3GOk43an2v9h5H0HHP12iS5RBnGF2tqe2/lg7xCDGNmw6CxT9CYnxq4kBgNZxMDUMFLb3qGlb6b0nrcf1mQaEPNFDBs0Eu+YpXkLubS8zkEssbT0DANvbnt5vo2eKmZQYc1v3WC57jvxk5rxd4W7esTMTN6RU4ZGHTnnviiOnHoQYPDUFWFOJsirO32fZaTd3r2DTwCP8NZuLi9m4P0flaUxYQ==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Preview Hour"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/preview/{year_month}/{day}/{hour}/{camera_name}/{tz_name}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get all mp4 previews relevant for time period given the timezone
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"year_month","in":"path","required":true,"schema":{"type":"string","title":"Year Month"}},{"name":"day","in":"path","required":true,"schema":{"type":"integer","title":"Day"}},{"name":"hour","in":"path","required":true,"schema":{"type":"integer","title":"Hour"}},{"name":"camera_name","in":"path","required":true,"schema":{"type":"string","title":"Camera Name"}},{"name":"tz_name","in":"path","required":true,"schema":{"type":"string","title":"Tz Name"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: preview-mp-4-camera-name-start-start-ts-end-end-ts-preview-mp-4-get
|
||||
title: "Preview Mp4"
|
||||
description: "Preview Mp4"
|
||||
sidebar_label: "Preview Mp4"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJy9VNtum0AQ/RU0T62EDInci3iLkqit1LRR6vYlstAYxrApLGR3cWOh/fdqFrAhdiqlrfLiy+7sOTNnZk4LBjMN0S1cUSoQlj5UNSk0opKfUoigVrQR9Csu63kcJ1iSwlhiSXGsDSozfBkdxyTT7oP/jN9lZMCHGhWWZEgxXQsMAhGMIMEHIZkSTQ4+KLpvhKIUIqMa8kEnOZUIUQtmW/NTbZSQGfhghCn44NxheV8Yy1p/xzGk+FwC2ZQrUiOCbwzkLfQEvav4n7EvZfoYucSHOMEkpxiznTr3DanthGGNhT5GIaShzHGkpBMlam4qRHCFD56D9TAjT0hPU1LJVM+8C1pjUxjvnZfiVo+vHIi7hOhtOH8fhvvMGe/c4Z1lBPa/0NklV6jrSmrSXNNpGPLXFPpbkySk9bopvJs+GHxIKmlIGg7Hui5E4qY5uNP8pt3rZK21PsxPTw+Bf2AhUvfMu1SqUs9AhVrxBhnR5Z2SQVHwL2Go1IcBRZVMblFuv67dhkzHnOfiUWPt0vrDGSqF29E4fa66BLkfpc7+tDZXpDV2netCng51YngLvrV77mp1R4mZzOStq6uj7uOWe5i9vJ26T5dx0cl3jGwI+bhYXB8Adr2dNvW6syTvqp5zZmTyih1ucCeTQwRBOzIkGzjnCNrBQGxAMg3abuNt0HvcrHSAmtRmMLdGFRBBbkytoyBIqaxmayUyNDTbiJSqAGvhOroPjIKgqBIs8kqb6E0YnnQxS177deWa0hcMPjBRV1Q4O5mFLGBdaVOim8XePqb1TrTYddjQgwnqAoUbFJdN22txC9HUnJ0K4EM08lOSKZ/sPHAsydIHLoaR2naFmr6rwlo+7jyMhUqFxlUxcrFHae627m9d62idP2l7xF43WDROXxZ9g0pwZs/M8tVNvwKvvafIh0mX2zHnkNRYch6QF6TetfWFefvhcW6WE6aknOjd5VmSUG1Gzw7Ml7u1W+YPlwuw9jeq7gBd
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Preview Mp4"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/{camera_name}/start/{start_ts}/end/{end_ts}/preview.mp4"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Preview Mp4
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"camera_name","in":"path","required":true,"schema":{"type":"string","title":"Camera Name"}},{"name":"start_ts","in":"path","required":true,"schema":{"type":"number","title":"Start Ts"}},{"name":"end_ts","in":"path","required":true,"schema":{"type":"number","title":"End Ts"}},{"name":"max_cache_age","in":"query","required":false,"schema":{"type":"integer","description":"Max cache age in seconds. Default 7 days in seconds.","default":604800,"title":"Max Cache Age"},"description":"Max cache age in seconds. Default 7 days in seconds."}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: preview-thumbnail-preview-file-name-thumbnail-jpg-get
|
||||
title: "Preview Thumbnail"
|
||||
description: "Get a thumbnail from the cached preview frames."
|
||||
sidebar_label: "Preview Thumbnail"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJydVE2P0zAQ/SvRnECymu4KLrkhsSxILKyWwqWKqmkySVyc2GtPClXk/46cr7ZbdiU4JZp5M37z/MYdMJYOkjXcUS4RUgE5ucxKw1I3kMAtcYQRV229bVCqqLC6jriiKMOsojwylvaSfkWFxZrcAgRoQxZD9accEhjzm7nDZopsCqlo02BNm5PszpSbkhgEGAwtmWyg10EAQgJzEQiQgaBBrkCApcdWWsohYduSAJdVVCMkHfDBhELHVjYlCGDJKgQ+SEXRl9DJ+zQ0cEY3jlyouV4uw+dcim9tlpFzRauihxEMAjLdMDUc4GiMklk/e7xzoaY78vDeewFvrq8vG/9AJfO+LLqxVtt/6ArGBr1ZDrxzYpQq/Emm2l0ClM7Ostgcvha9vucyeTFHZMNUkgWfejHF0Fo8nGj5WQ8EwQuoXfmS7HfkHJYEc7Pnob0Y0Spk/fFsvd1RxmdXvu7nGo4ecemxzVHeQd3nx3g/yPe3wybIx9Xq/qLhcLc1caWD5yf/cgUJxKPf4262ro9nvy92JlB2ZPeT0VurIIGK2bgkjnOq9aKwskSmxV7mpGM0sr+fIzCJY6UzVJV2nLxdLq8GTBpWpNC9xCN9EBAOGny3XFwtlkEOox3X2DtrXLP7ca1XE1F48jB0R4v+xxsxqsv0m2OjUPbG6efpRt3W08sBApLTpT+XLhUQhg74rtuio+9WeR/Cjy3ZAyTrVMAercRtmH/dQS5d+M8hKVA5emGsVw+jwV5Hz1GefNQEF+1RtaPGP+lw9lb1u1MR5mR7EkP+XZaR4ZPKi1UPVzjb6vZmBd7/Aetn9QM=
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Preview Thumbnail"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/preview/{file_name}/thumbnail.jpg"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get a thumbnail from the cached preview frames.
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"file_name","in":"path","required":true,"schema":{"type":"string","title":"File Name"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: preview-thumbnail-preview-file-name-thumbnail-webp-get
|
||||
title: "Preview Thumbnail"
|
||||
description: "Get a thumbnail from the cached preview frames."
|
||||
sidebar_label: "Preview Thumbnail"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJydVMtu2zAQ/BVhTy1AWE7QXnQr0CQt0LRB6vZiCMZaWklMKZEhV04Ngf9eUC/bcROgPUnYx3B2OMsOGEsHyRpuKZcIqYCcXGalYakbSOCGOMKIq7beNihVVFhdR1xRlGFWUR4ZSztJT1FhsSa3AAHakMXQ/TmHBMb8ZkbYTJFNIRVtGqxpc5R9oq3ZlMQgwGDAZLKBXwehEhKYu0CADAwNcgUCLD220lIOCduWBLisohoh6YD3JjQ6trIpQQBLViFwLRVFXwOS92kAcEY3jlzouVwuw+dUi+9tlpFzRaui+7EYBGS6YWo4lKMxSmb98PGDCz3dgYf33gt4d3l5DvwTlcz7tujKWm3/ARWMDYKzHHjnxChV+JNMtTsvUDo7yWKz/1b0+p7K5MUckQ1TSRZ86sUUQ2txf6TlFz0QBC+gduVrst+Sc1gSzGAvl/ZiRKuQ9Yez9faBMj658nU/13D0WJceYA7yDuq+PMbHQb6/HTaVfFqt7s4Ah7utiSsdTD/5lytIIB4NH3ezdX08G34RDA8CHNnd5PTWKkigYjYuieOcar0orCyRabGTOekYjewv6FCYxLHSGapKO07eL5cXQ00adqTQvcYjfxAQDhqMt1xcLJZBD6Md19hba9yzu3GxVxNTePY0dAeP/scrMcrL9Jtjo1D2zunn6Ubh1tPbAQKS461/pl0qIEwdGrpui45+WOV9CD+2ZPeQrFMBO7QSt0GAdQe5dOE/h6RA5eiVud7cjxZ7G73EeXJSE3y0Q9WOIv+i/clr1W9PRZiT7UkM+Q9ZRoaPOs+WPdzhbKybqxV4/weEcfZK
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Preview Thumbnail"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/preview/{file_name}/thumbnail.webp"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get a thumbnail from the cached preview frames.
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"file_name","in":"path","required":true,"schema":{"type":"string","title":"File Name"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: preview-ts-preview-camera-name-start-start-ts-end-end-ts-get
|
||||
title: "Preview Ts"
|
||||
description: "Get all mp4 previews relevant for time period."
|
||||
sidebar_label: "Preview Ts"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJy9VNtu2zAM/RWDTxsgxGnRvfht2IpuwC5Fm+0lCAzFYhJ1sqRKdLbA0L8P9CWXdi1QDOhLrEjkIXl4yBZIriMUc7gOuNX4GxYCFMYqaE/aWSjgCimTxmS1v8h8bxSzgAa30lK2ciEjXWPmMWinJiDAeQySnT8rKGBwKSmW47GsZI1BllbWWJaRZKDxQ7Es0ar+h/+skUCAl0HWSBg41RbYEQo4ggEBmpP1kjYgIOB9owMqKCg0KCBWG6wlFC3QzrNrpKDtGgSQJsMXHzqs7BtjpST2Mca0XhrANvUSw1GAWwbKZvEEva/yv7EvreqRF+wdvbMRIzucT6f8OW3obVNVGOOqMdnNYAwCKmcJLbG59N7oqmthfhfZpz0kkVJKAi7Ozx8D/5RGq84tuwzBhReggg8sG9J93gpJasMnTVjHxwbGVSev0u6+rzptnDaYuR5utCVcY4C0SGK8kyHI3RGRX1yfICQBdVw/J5ivGKNcI+zBnjbtyMhm/JoOsd3yDis66fe8q6sPPdgtDjAHent2ny7jY0/fv4KNJp9ms+tHgH1va6SN49EdZ482UEA+TG/eHo1dyrv5yNtxTFKOVuVtr+sEAiKG7Ti2TTBQwIbIxyLPFdZusgp6LQknW63Q5dLrrmMHwyLPjauk2bhIxbvp9Ky3WfDErFxH+lAQCOBAvRKnk7PJlAnyLlItO60NIzfsOZ6XB5uuPaj15Utv4JnwD+XeSN1JqKujHRicj6sQBBSnq6tjj6+Ptg1axTfDhlgIYAoYpW2XMuKPYFLi6/sGww6K+ULAVgYtl8zGvAWlI58VFCtpIj5T65ubQYBvs6cKGXVmWWVbaZqB8V+4e7CHuX2vGHpP2CvHHdrS7ZINSoWhI71/fF9V6OnI7dHqYwHvx+zqcgYp/QUK5JNF
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Preview Ts"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/preview/{camera_name}/start/{start_ts}/end/{end_ts}"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get all mp4 previews relevant for time period.
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"camera_name","in":"path","required":true,"schema":{"type":"string","title":"Camera Name"}},{"name":"start_ts","in":"path","required":true,"schema":{"type":"number","title":"Start Ts"}},{"name":"end_ts","in":"path","required":true,"schema":{"type":"number","title":"End Ts"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
62
docs/docs/integrations/api/profile-profile-get.api.mdx
Normal file
62
docs/docs/integrations/api/profile-profile-get.api.mdx
Normal file
@ -0,0 +1,62 @@
|
||||
---
|
||||
id: profile-profile-get
|
||||
title: "Profile"
|
||||
description: "Profile"
|
||||
sidebar_label: "Profile"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJxlkU1PwzAMhv8Kes/R2iFxyW0HhLghPk5VhbLUWwNpExJ3Yor635H3JQa5WLJfx89rF7DZZugGq4l7tAohUjLswvjYQSOmsHGe3s9xSwyFRDmGMVOGLritawkdZZtclE5ovEzWUs6byd88n8RQsGFkGlnkJkbv7GFQ9ZGlpyDbngYDXWZ56s+XT0cEKAzEfRC6I0003EOjihdBprSjJLYKpuSh0TPHrKuqoyEsNsltDdNi5zoKlYkOs/ot1FXlgzW+D5n1XV0vj5pWwY2bIKTs2BM0oCCDjoD1YrmoMSvEkHkwB0ujGeiK/cpTAe+j1Jm+uYreuFH6DyTl5Ks530COI0SSKmVtMr0lP8+S/poo7aGbVmFnkjNrgWvaWaEn01E6LOKT9tBYWUtRtrYzfpLR/w4hPi8bfrh/xTz/AOp0u1A=
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Profile"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/profile"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Profile
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: reclassify-face-faces-reprocess-post
|
||||
title: "Reclassify Face"
|
||||
description: "Reclassify Face"
|
||||
sidebar_label: "Reclassify Face"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVMtu2zAQ/BVjz6zlBO2Ftz5StECLBInbiyEEa2otM6VEhqScCIL+vVhSkZMmKVofbGI5HO7ODD1AxDqA3MDZgdoYoBRgHXmM2rZfK5DgSRkMQe/66x0qSl/h2pPzVlEI186GCAI83XYU4gdb9SAHULaN1EZeonNGq0RY3ATbci2oPTXIq9g7Agl2e0OKeaKOhguJaBzHkamDs22gwPjT1Yp/KgrKa8ekIOGqU9zLrjOLywkM4p97yLe8PT19TvwTja7SscWZ99b/Bys4z0JGnfuuKKI2vNKRmvAcYKx6sottf74DuZklCtHrtoZRzBXdRqrJw1iO4qGG3mP/SMdvNjcIo4Am1I8kn/iO0O8UAtYEM9nr0CTGYs274/Hu2UQOg/ZUca54rnz1hCuPNEd5s7qvj/Epy/fSZQ+QL+v1xTPC7O1TUy/nRC8+o+KkNBT3lsM+hdlh3IOEImW9mLMOAgL5A/mQfOm8AQn7GF2QRVFRY5c7r2uMtDzoimyBTie7jkBZFMYqNHsbony3Wp1kTCmA83N5fENn99g4HmsYBeh2Z5Mb06QggJvI06yWJ8sVK8e9N5hC2GJDLw76RIjZ3kj3sXAGdUpJ6naYNNhA0iB5+qBCKYD7581h2GKgH96MI5dvO/I9yE0p4IBe45bb3XA694QV+STbL+pBwsf8jN6kDDHcdMn3P58U65dPvFeKXPwrtnxk5cX51RoEbKc/pMZWfMbjHc+Cd1lGm6RI7y3VBjDY1h2/AgmZkz+/AdaQxMI=
|
||||
sidebar_class_name: "post api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Reclassify Face"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/faces/reprocess"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Reclassify Face
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={{"content":{"application/json":{"schema":{"type":"object","title":"Body"}}}}}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: recognize-face-faces-recognize-post
|
||||
title: "Recognize Face"
|
||||
description: "Recognize Face"
|
||||
sidebar_label: "Recognize Face"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVE1v2zAM/SsBz2qcFttFt21tsQEbWrTZLkFQMDKdqLMtVaKDZYH/+0Apn02KbRdbH4/U43uU1sA4j6AncLOkliNMFThPAdm69ksJGgIZN2/tb3qq0ORPfNovehcZFAR66SjyR1euQK/T1AYqQXPoSIFxLVPLstV0NVuPgYvKheaiREZZjmZBTRr5IATYUpRZZWuSP688gYbIwbZzUCDByKBhZlsMK1DAlgUKtxLR92ob4mbPZLYcM6lJTjvdBwnxp38pte8ldaDoXRszxavRSH4lRROsF+FAw2NnDMVYdfXgYQOGIx3Q+9qapHPxHCXmQIR8yrurq9PEP7C2ZQob3ITgwn9kfSVtSYy2lpFlauIpoHbmaBfb1V0FevLajV7tVmzLNKcA/XRvAIaAhwZ9dZkg9AqaOD/n7hb6jWLEOcEu2dvQJMZgLLt/M1/qykdvcAeNsJc3q/t2GddZvnOHbSGfx+P7k4TZ22NTH7ZNNrhFI43SEC+cXL/N/fLIC9BQpJ4sdj0JCiKFJYWYbOlCDRoWzD7qoiipccMq2DkyDZe2JFegt8mtPVAXRe0M1gsXWb8fjS4zZqrAtpVLgm+KAQVyUCY8Gl4ORyKO8Gsw9VmLDZ2r5ajUnYFMv7jwNdrUB4nQelPmBFKZybVtoVMFQlE21+sZRvoe6r6X5ZeOwgr0ZKpgicHiTNhOpP8WhCWFpMxPWoGGT/miXKQuEXjdCZVzT5KolIM+GEOeD+And0zU2hl2f/c4BgWzzUvYuFJiJHHKq/ZDIdn3fwBN7+Xu
|
||||
sidebar_class_name: "post api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Recognize Face"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/faces/recognize"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Recognize Face
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_recognize_face_faces_recognize_post"}}}}}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: recording-clip-camera-name-start-start-ts-end-end-ts-clip-mp-4-get
|
||||
title: "Recording Clip"
|
||||
description: "For iOS devices, use the master.m3u8 HLS link instead of clip.mp4. Safari does not reliably process progressive mp4 files."
|
||||
sidebar_label: "Recording Clip"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFVNuOEzkQ/RWrnkCy0mF2kFb9toJhWQkWNAn7MopannalY3Dbxq6ONmr531H1JReGQUJI8JLuuKtOuc45VT2QahKUd/AWtVGwkaAx1dEEMt5BCa98FObdSmjcmxqTFF1CQTsUrUqEcdH+0f0pXr9ZCWvcJ2FcIlRa+K2orQmLNlwvxEptVTRCe0zCeRIRrVH39iBC9DWmxM8mYkpmj6IN12JrLKYFSPABo+KL/KOhhIi1j9q4pmLsqqpVi1FVTrVYVYlUpPlBqarQ6fGH/wwJbbiuGiSQEFRULRJG7rwHRoASzvBAguHug6IdSIj4uTMRNZQUO5SQ6h22Csoe6BA4NVE0rgEJZMjywYsBS/zLWDnLY435fj9awHXtPcazAisGEut0gT62+9PYN06PyBvOTsG7hIkTrpZLflw6ZNXVrOK2s+J2CgYJtXeEjjhchWBNPehYfEyc058ukXPOEq6vrh4C/6es0UOauInRxx9AhRDZO2TGe2skZSy/GcI2PQywvr74qtzh3XbwxqXAzPV0YhxhgxHyJsv5TMWoDmdEvvHjBSFLaFPzPcO8xZRUg3AEezx0IEOs+Ws+1fb3H7GmC73vhr7G0lPc5gRzondk9/E2Xo70favYHPJ6vX7/AHDUtkXaeZ7fefZoByUU/dm45WKYi6KfxyMX6HTRj37OxbxLQELCuJ/ntosWStgRhVQWhcbWL7bRNIpwsTcafaGCGSQ7BZZFYX2t7M4nKp8vl8/GmA2PzNYPrE8dgQQuNFpxuXi2WDJDwSdq1WC2aeZu560kXlgT4Kv92Z8s+3tX6SQc4f9UBKvM4MmBl36S5A7Kyw04iAESyrOlhU7zyXHRHJXZSGBOGabv71XCD9HmzMefO4wHKO82EvYq8nVxUE+bxO8ayq2yCb9D3JPbydJPxWOdzM517Nu9st0k4Sc8fLXZ2Q+/sPSRu19cd1Jo2E47VBrjQPr48a+6xkBnaQ+WKU/EcXD/vllDzl8AGk3J5w==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Recording Clip"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/{camera_name}/start/{start_ts}/end/{end_ts}/clip.mp4"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
For iOS devices, use the master.m3u8 HLS link instead of clip.mp4. Safari does not reliably process progressive mp4 files.
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"camera_name","in":"path","required":true,"schema":{"type":"string","title":"Camera Name"}},{"name":"start_ts","in":"path","required":true,"schema":{"type":"number","title":"Start Ts"}},{"name":"end_ts","in":"path","required":true,"schema":{"type":"number","title":"End Ts"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: recordings-camera-name-recordings-get
|
||||
title: "Recordings"
|
||||
description: "Return specific camera recordings between the given 'after'/'end' times. If not provided the last hour will be used"
|
||||
sidebar_label: "Recordings"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFVFFv0zAQ/ivWPYEUNW3pYMvbgAkmMUCl8LJWlZtcEg8nzuxLRxX5vyM7aZOqKxISEk9N7e/uO3/33TVAPDMQ3cMdJoLDKoAETaxFRUKVEMEcqdYlMxXGIhUxi3mBmjONsdKJKDPDNkhPiCWjHFkmtliyJfCUUC8hXAKWyRIYiQLNiN2mrFTEKq22IsHEh0huiOWq1uxJSMk2yGqDCQSgKtTcVXGbQAQ94Xrd1rAueYHr9eAiQ4IAKq55gYTaPasBh4IIBjEQgHBPqzjlEIDGx1poTCAiXWMAJs6x4BA1QLvKhRrSoswgABIk3cG7VoPPLpe1wYHDv3qf/bFGvTtKn3Jpnstf1sXGxyWY8loSRJM3F9PXk8nlm/Fo9upqdtlTX3uKIekGU6Xx37FezDrWq571bcth7cplNpUqDRqXazoeu59jy3yr4xiNSWvJ5h0YAohVSViSg/OqkiL2vQ0fjItp+vqstTaA2XR6mvgHlyLxYexGa6X/IitU2vmJRFt3gsSFdF+CsDCnAKnio1te7r6k3k/HpnCN6E5ESZi55qxssD/jWvPdwDmfVFsg2AAKk/3JZHdoDM8QDsnOQ70YbOFubc+tNg8Y05EX7v27WuoOt+rT9PK26p5/xvtWvufI9pCPi8XXk4RtbwukXLmZ3s8r5RBB2AxG1Ib9WEMABvV2P8+1lhBBTlSZKAwTLNQo1SLjhCO3VFTIK+Hb0gOjMJQq5jJXhqKL8XjSYlZuZlLlle2qhgAcUWu38WgyGjsVKmWo4N5Q3dDNh9UdmbTpLfkfd2fXFcJfFFaSC284L0jT6X0P0fFKHAi+CsBJ5UBNs+EGv2tprTtu14trQyIM38jBgvmJu8EK3HJZe0FdJ85gD5urB6/cHy0c+nmWs1q/mHcuf8nOvX9v5nI35NxXM1TDj3COPEHty2gR13GMFQ1iTzaOq//g7g83C7D2N4xFgOU=
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Recordings"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/{camera_name}/recordings"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Return specific camera recordings between the given "after"/"end" times. If not provided the last hour will be used
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"camera_name","in":"path","required":true,"schema":{"type":"string","title":"Camera Name"}},{"name":"after","in":"query","required":false,"schema":{"type":"number","default":1752611870.43948,"title":"After"}},{"name":"before","in":"query","required":false,"schema":{"type":"number","default":1752615470.43949,"title":"Before"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: recordings-summary-camera-name-recordings-summary-get
|
||||
title: "Recordings Summary"
|
||||
description: "Returns hourly summary for recordings of given camera"
|
||||
sidebar_label: "Recordings Summary"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJydVE1v00AQ/SvWnEBaxWkFF98QVIBEAaWBSxVFU3tsb1l7t7vjCGPtf0drO7GtNJXglGj95s2bNx8dMBYOknu4pUwi7ARk5FIrDUtdQwIb4sbWLip1Y1Ubuaaq0LZRrm1kKdU2k3XhIp1HhTxQHaVYkUUQoA1ZDByfM0hggu5Hhv1+gO5rrGi/fwZQEIMAgxYrYrJBZAcBDQnMYkGADEINcgkCLD010lIGCduGBLi0pAoh6YBbE0IdW1kXIIAlq/DwvueKvgYu78UpB8uK/uj6lOCpIdsuMuSo3IspMsqxUQwJNJzOUm6P1N7vAqEzunbkAsX1eh1+lk24a9KUnMsbFW1GMAhIdc1Uc4CjMUqmvd/xowsx3STLe+8FvLm+Pif+iUpmfVh0Y622/8AKxoYesxx0Z8QoVfgnmSp3DlA6XXzFuv2W9z1duhY6ML7ImqkgC37nxfENrcV2ZuUXPQgEL6ByxUuNviXnsCA4kV2G9mZE2/DVT7n1wyOlvBiB+76uIfWI2000k72Du5fL+DDY91yyI+TTdvv9jHDobUVc6rBnx53hEhKIu9ma+HhasXhcMRDgyB6Ou9VYBQmUzMYlcZxRpVe5lQUyrQ4yIx2jkX17JmASx0qnqErtOHm7Xl8NmF1YmVz3Do/qQUBINIzdenW1Wgc3jHZcYT9Y49ZtpqNyd1K5GNpuGtH/vk6jx0y/OTYKZT8+fVnd6N49JMsjM/EF20ZpOwGh9ADvugd09MMq78PzcC2CrZl0+KBm9+IXtcvzckDV9B4F4w5oZcA/H3vRiVebcSZfR5fqO45e3c5zHvXMq+0XriTMyPYyBsS7NCXDs9iz+xD0n2bx480WvP8Lek8zFw==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Recordings Summary"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/{camera_name}/recordings/summary"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Returns hourly summary for recordings of given camera
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"camera_name","in":"path","required":true,"schema":{"type":"string","title":"Camera Name"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","default":"utc","title":"Timezone"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: regenerate-description-events-event-id-description-regenerate-put
|
||||
title: "Regenerate Description"
|
||||
description: "Regenerate Description"
|
||||
sidebar_label: "Regenerate Description"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJydVE1v2zAM/SsBTxtgxGmxXXwb0GIrsGFFl+5SBIFiM7E6WVIlOlhg+L8PlL/kpu2GnRJY5CPfI/kaIHHwkD3A9RE1edgkYCw6QdLomwIycHhAzR9wW6DPnbT8tMUQvu1+t7LYzl6jJFsTJGCFExUSOq7VgBYVQgZDMiQgNWRgBZWQgMOnWjosICNXYwI+L7ESkDVAJ8t5npzUB0iAJCn+EJpf3BTQtsmI7k3tchywn2p0pxn4Xig/Qxf69H0f+nteB3VdsUhU1tVOC6k8JOC1sL40xJoNjdyNxK8mOa45mxvrYXWtFLSbBArci1oRZHPgAexHR6DlUIfeGu3Rc6OXqxX/RIpzdJ3n6P2+Vou7PhgSyI0m1BToWatkHiabPnrOaSLy1vHcSXYVfAcWab4zRqHQcXt9TJtAhd6LA741om99SNsmQ4zZPWJOs5k8jJUn0EjezyyuzEd+bctwHy4vz+X4KZQsAtnFtXPG/b8WBZKQiv9JwsqfByiTz15f26NoBaQmPKCDdjPJIZwTp0ixr6ZrMAjsD/8k7gD2xqmwGIs1v/5tFMyrK93HRZOY5O3UfZ3GVSffS8WGkC/r9e0ZYDfb+VCn81pE9xV2hUrDdjXYDZWQQdq5VNoMRtOmEV46uRRfM7rjYE+1U5BBSWR9lqYFVma5d/IgCJdHWaBJhZVhmlNglqbK5EKVxlP2cbW66GI27D57EwbSk4UEuFBHaLW8WK5YPGs8VSLsYW9fr3KdSTIOmvA3pVYJGfYlNNb0Ojx0Rss3lUWWW8xQIzE2CTANTmyanfB471Tb8ufORFmiQnqxU5GN/sJT7LlHoerAliU4Cic5+uXMZ3zGK4V3d/0yvl9A8jLPYef0Ka45dDOSDWdWoijQhR665095jpaixDNX4ObH1bq9X0Pb/gEOw3rp
|
||||
sidebar_class_name: "put api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Regenerate Description"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"put"}
|
||||
path={"/events/{event_id}/description/regenerate"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Regenerate Description
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"event_id","in":"path","required":true,"schema":{"type":"string","title":"Event Id"}},{"name":"source","in":"query","required":false,"schema":{"anyOf":[{"type":"string","enum":["thumbnails","snapshot"],"title":"RegenerateDescriptionEnum"},{"type":"null"}],"default":"thumbnails","title":"Source"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"}},"type":"object","required":["success","message"],"title":"GenericResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: register-face-faces-name-register-post
|
||||
title: "Register Face"
|
||||
description: "Register Face"
|
||||
sidebar_label: "Register Face"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVE1v2zAM/SsBTxug1mmxXXTbR4sN2NaizXYJjICx6USdbbkSHSww/N8HSo6TNO0+LrEi8ZGP5CM7YFx50HO42lDNHlIFtiGHbGz9OQcNjlbGM7lFgRmFH79Y1FjRYjE+NdYzKGjQYUVMThx2IEag40eBqUFDg7wGBY4eW+MoB82uJQU+W1OFoDvgbSMYz87UK1DAhku5+CZO+j6NWPL83uZbATx1ldmaqWZ5qtqSTYOOk8K66ixHDiH2wRonqbIhL/8KI5FOKQgYGTQsTY1ue0DqWhB9r3YQu3ygjI/ym0e36R4kxBf/XNS+F/+OfGNrH3leTqfyyclnzjTSJ9Bw32YZeV+05eRuMIajYmDTlCYLbU0evGAOKhGjvLm8PHX8A0uTB9jkyjnr/sPrk/rmxGhKORmmyp8alDY7esV6e1MEJR23pFfjjamZVuSgT/ddQOfwsEtfbCQIvYLKr/6ksq/kPa4IRmcvm4ZiTGby+jcFSF4x9GB3oIZ9eWN1X07jYyzfc8F2Jp9ms9sTh7G3x029GzQ2ucZMdFIRr60M+zjIvAYNSRBm0okw+2QnTFDgyW12U966EjSsmRuvkySnyp4XzqyQ6XxjcrIJNia0bG+ok6S0GZZr61m/nU4vok0qS6KwoepDRqBAAkXW0/OL86lUSFhWGMQ27JinCR2lOzaR6RcnTYkmaCHw6YZc5xByBQV62FdjuqkCISo2XbdET99d2fdy/diS24Kepwo26AwuhfO8g9x4OeegCyw9ndAZBwhe3Q06eT0B9TzNnRxqEcMGy3aoy0/a7pZrUP+aMCcX4senDzHKWdDoHvrcVpT2RNC7LKOGD8xPJlzaNOrl9uZ+BgqWwzKubC4YcRz8qv1Rz9O+738DvFY1Ew==
|
||||
sidebar_class_name: "post api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Register Face"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/faces/{name}/register"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Register Face
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_register_face_faces__name__register_post"}}}}}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: register-notifications-notifications-register-post
|
||||
title: "Register Notifications"
|
||||
description: "Register Notifications"
|
||||
sidebar_label: "Register Notifications"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVE1v2zAM/SsBz1qcFttFt30U2IBtLdpsl8AYFJtx1MmSKtFtA8P/faDkOkmzFpsvluinJ/Lx0T2QaiLIFXx3pDe6UqSdjVAKcB5D2n2pQULARkfC8Mse4p7tJpB3kUBAwLsOI31w9Q5kD5WzhJZ4qbw347HiNjrLsVhtsVW8op1HkODWt1gxD2kyHEhEwzAMTB29sxEj488XC37VGKugPZOChJuuqjDGTWdm1yMYxD/nkG95e35+SvxTGV2nY7OLEFz4D1bwgWUlnfOukZQ2vNKEbTwFGFcdfVV2d7kBuZokihS0bWAQU0RbwgYDDOUgnmIqBLU70PGrywnCIKCNzYHkI98e+g1jVA3CRPYyNIkxW/LXYX/31EQ2gw5Ys9m4rnz1iCv3NHt5s7ovl/Epy/e3y54gn5fLqxPC3Nvjpl6P1p0dz4GAFmnreAJGT3tFW5BQHDm/eHI+CIgY7jHE1KUuGJCwJfJRFkWNrZtvgm4U4fxe1+gK5XVq3h4oi8K4SpmtiyTfLRZnGVMKYDdd7yfq4lG1novsBwHablzqzVg3COAkcm2L+dl8wTpyCa1KlrSqxdfKPlJn6jnhIxXeKJ2sk5LuR0VWYJ9RTJqUArgaxvT9WkX8EcwwcPiuw7ADuSoF3Kug1ZqTX7Fzt6hqDEnE37gDCR/ziL1J/mK46ZInno8bq5lPvK8q9PQqtjzo79XlzRIErMefVetqPhPUA5eiHrKozufqZJ9jPRhlm44nRELm5OcPNHfaDQ==
|
||||
sidebar_class_name: "post api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Register Notifications"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/notifications/register"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Register Notifications
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={{"content":{"application/json":{"schema":{"type":"object","title":"Body"}}}}}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,62 @@
|
||||
---
|
||||
id: reindex-embeddings-reindex-put
|
||||
title: "Reindex Embeddings"
|
||||
description: "Reindex Embeddings"
|
||||
sidebar_label: "Reindex Embeddings"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJx1kU9LAzEQxb+KvHPoroKX3Dx48CZqT6WUNDvtRrNJTGaXlrDfXaat4h/MJTC8mfm9eRVs9gV6hfuJAhesFWKibNjF8NBBI5MLHR02NGyp61zYl81nKY0MhUwlxVCoQFfctK18HRWbXZIh0HgeraVSdqO/erqIoWBjYAoscpOSd/a0s3kt0lNRbE+Dga6zPPVr5NMZ4er+iwoKA3EfhfkMlgz30GguuFAolCfKYrdizB4aPXMqumk6GuJil93eMC0m11FsTHKY1XehbhofrfF9LKxv2/b6rFkruLCLAs2OPUEDCrLozNourhctZoUUCw/m5C6Ygf6z8cNpBR+TSJkO3CRvXJBRJ6h6sbj6DEnSEzgp1bo1hZbZz7OU30fKR+jVWmEy2ZmtcK7Ws0JPpqN8uskbHaFxZy0lOeBk/Cir/8Qjlr+O/bh8wTx/AG6RyQc=
|
||||
sidebar_class_name: "put api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Reindex Embeddings"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"put"}
|
||||
path={"/reindex"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Reindex Embeddings
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: rename-face-faces-old-name-rename-put
|
||||
title: "Rename Face"
|
||||
description: "Rename Face"
|
||||
sidebar_label: "Rename Face"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVE1v2zAM/SsBTxugxWmxXXTbR4cN2Noiy3YJjECxmUSdLKmSnDQw/N8HSnacNG23+RA75CP1+EiqgSDWHvgcrraog4ecgbHoRJBGfy2Bg0MtKlysRJF+/GJhVLmIxkXntHUABlY4UWFAR/kaIA9w6MHAQGrgYEXYAAOH97V0WAIPrkYGvthgJYA3EPaW4nxwUq+BQZBBkeFGlaNrStS2eYpHHz6Yck9Bj9MVRgfUgVzCWiWLWFB2540m23CadVRukOjpn8ZdIvsCj2vc9TxYDzLLOyzCSVnzIVk+BE+jYJ9FgZF521ISh94a7ROFy8mEXiX6wklLrIHDj7oo0PtVrUbTDgz/XmQ65e3l5XniX0LJMoaNrpwz7j+yPpKuxCCkoi8ZsPLnAGWKE6/Q+5tVnJRTpVt2sEgdcI0O2nyQWjgn9kft+GYSQWgZVH79Uue+o/dijXBI9jw0ijGakfdvbaa60tEd7qjdg7xJ3efL+JTke+qwHvJlNrs9S5h6e9rUNGQjmjJihmFjaJP7LQ0b4JDFXc6afj3bLO0yMPDotv0S104Bh00I1vMsK7Ey45WTaxFwvJUlmkxYGTs2AHmWKVMItTE+8HeTyUXC5AxohKbD3l49iMoqPN27YQpA6pWJPerqBwbEK9U4GV+MJ4SyxodKxNHsMpyWfyLNoeEBH0JmlZBxbiL5ppNmDlEaYMCP7q5OnZwB1UWoplkKjz+dalsy39fo9sDnOYOtcFIsifO8gVJ6+i6Br4TyeEbosG7watpN1esRsKeJ9sOjaXS2QtWdLr9xf3zVxn3ZoCjRRQ7J/TGd9CZO9RB+tuTUzhTxvijQhhex+dGA3f6cAYNldyVXpqQQJ3Ykn9glpiYWHi+AaGtACb2uaS05pJT0/AFpjUE5
|
||||
sidebar_class_name: "put api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Rename Face"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"put"}
|
||||
path={"/faces/{old_name}/rename"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Rename Face
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"old_name","in":"path","required":true,"schema":{"type":"string","title":"Old Name"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"new_name":{"type":"string","title":"New Name"}},"type":"object","required":["new_name"],"title":"RenameFaceBody"}}}}}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: reprocess-license-plate-lpr-reprocess-put
|
||||
title: "Reprocess License Plate"
|
||||
description: "Reprocess License Plate"
|
||||
sidebar_label: "Reprocess License Plate"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVE1rGzEQ/SvLnFoQXse0F90KDTSQUpM6vRhj5N2xrVS7UkazpmbRfy+j9UeMk0BOXjRfb9574x7YbCLoOdzusOUICwU+IBm2vr2rQQNhIF9hjEtnK2wjLoMzjEsXaHmOhY5BQTBkGmQk6dhDaxoEDSidl7YGBbYFDc8d0h4UED53lrAGzdShglhtsTGge+B9kMLIZNsNKGDLTh4yxuKuhpQWUh+DbyNGKZmMx/JTY6zIBkEPGn53laBbd654OCSDgsq3jC1LugnB2SovWz5FqenPMFJKScGXyeS68R/jbJ3LilsiTx/oCoGEYLYD7hrZWCdflrGJ1wnOVxdR0+5/rTO9lywldXqxLeMGCdIiqeObITL7F1Te+wEgJAVN3LzH+k+M0WwQTs3eEUjIKGYSTefZfvWEFV8oPs97DaMPeYtzmzO9A7tvr/F9oO+1YceUH7PZ9KrhoO2lqA9HNxf3g9OLqThdUCJvvRzD0ea8BQ2lC1SeTgAURKTd0fsdOdCwZQ5Rl2WNjR+tyW4M42hna/SlCTZrdk7UZel8ZdzWR9Zfx+ObIWchZ7P2mfbDSqBABg2wx6Ob0VgoCj5yY7LbDpf39kYXm5/0ZPzHZXDGZltkZP1h2zm4QFnC474LBYJUQn2/MhEfyaUkz8OBCwu1jWblRPC1cRGv5p6OBj49HLzxuQD1Op6/uL/8N9kZ12U6hKOdISuzQM/F9ls0NVIGMdR9qyoM/KLq6kqly0np6eMMUvoPiDbBQw==
|
||||
sidebar_class_name: "put api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Reprocess License Plate"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"put"}
|
||||
path={"/lpr/reprocess"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Reprocess License Plate
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"event_id","in":"query","required":true,"schema":{"type":"string","title":"Event Id"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
62
docs/docs/integrations/api/restart-restart-post.api.mdx
Normal file
62
docs/docs/integrations/api/restart-restart-post.api.mdx
Normal file
@ -0,0 +1,62 @@
|
||||
---
|
||||
id: restart-restart-post
|
||||
title: "Restart"
|
||||
description: "Restart"
|
||||
sidebar_label: "Restart"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJxlkU1PwzAMhv8Kes/RWpC45MaRE4iP0zQhL/VoIG1C4k5MUf87crchPnKxZL+On9euEHotsGvcpISNQUycSXwcbztYZC5CWV7OMcUiMJpOcSxcYCuu2lZDx8Vln7QVFo+Tc1zKbgoXDycxDFwchUdROaUUvFsmNW9FeyqK63kg2DrrM3++fDgywGBg6aPinXASSQ+LJn8rCuc9Z/VVMeUAi14kFds0HQ9xtcv+lYRXe99xbCh5zOan0DZNiI5CH4vY67a9PGo2Bn7cRUUVL4FhAQMddCRsV5erFrNZuAZaPI008C/4X6Yq5JC0LvwpTQrkR+1fSOrJ1/p8BT2PEmmq1i0Vfs5hnjX9MXE+wK43BnvKnrYKt97MBj1Tx3lZxDsfYHHjHCcF2VOYdPS/S6jP7xXf3z0+YZ6/AG22vMk=
|
||||
sidebar_class_name: "post api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Restart"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/restart"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Restart
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
70
docs/docs/integrations/api/review-ids-review-ids-get.api.mdx
Normal file
70
docs/docs/integrations/api/review-ids-review-ids-get.api.mdx
Normal file
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: review-ids-review-ids-get
|
||||
title: "Review Ids"
|
||||
description: "Review Ids"
|
||||
sidebar_label: "Review Ids"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJydVd+P0kAQ/leaedKkUu6iL31Tj5yXaDQc+kIIGboD7Nl2e7tTlJD9381sS2kDh9EnyvabH9/3zWwPwLhxkM5hSjtNv2ARg6nIImtTPihIwYbzpVZu2XvcEEMMFVosiMlKhgOUWBCkoJWDGHQJKTzXZPcQg6XnWltSkLKtKQaXbalASA/A+0piHFtdbiAG1pzLwYNy4P1CQl1lSkdO0LfjsfwocpnVlfQIKTzWWUbOres8mrZgiCEzJVPJAseqynUWKCVPTmIO5x2gtSitaqYi1KqsCMG6qazV9W7Bx5BhQfYqq48NwsfgGC0vWYti5/i1sQUypKCQ6U1AnZI8Smg0k0MfA5Xq/9JMStUl2aJbrojK1mLqk10ZkxOWvchP6KIPRGU0PaKFEO3Iat5f6oPKupAZw5yszI0ipiy4t+jRahNMBOxj4G1drJYV8vaaojNBRd8E5WPh2ejfvr2T/16SNeFm9UQZDwZyLtZ23g2M6Yl7SaIe50G3bRs9ao1Oj7QpqORuRn0f0Jy1ikYPyvUf74nBe+Hx9vb2fAF+YK5VGO9oYq2x/zL9wylXxKjzMO+X1yA32eAtlvuv67D8Q4N83J3okmlDFvzi5MNx2Y78P5umQdGkcJtrhn8h53DTqBcgL0ODGNFM3v5tBoRXU7rF9dw7yduo+zKNu0a+S8W63ZnNvp0lbLwdmnqyXxoj3hq5jY/3riwFJKcLOQyj3R1v4trmkMKWuXJpkigqzGht9QaZRjutyCRY6eDRCZgmSW4yzLfGcfpuPL5pMAu5ydemv1QQgxRq2hyPbkZjkaQyjgsM09V+BwYMBuQ6y5h+c1LlqIPzoZlDy27e+/KIG9KXnB4OK3T03ebey3HzhRHOSjtc5WLnGnNHZyW7lYBX09b51xHEl1v5SfvuS7bDvA68RYwdWi1lIJ3LPG8JFdlQvwl5n2VUcS/qbP0kS+fn/WQG3v8B98iOjA==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Review Ids"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/review_ids"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Review Ids
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"ids","in":"query","required":true,"schema":{"type":"string","title":"Ids"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"properties":{"id":{"type":"string","title":"Id"},"camera":{"type":"string","title":"Camera"},"start_time":{"type":"string","format":"date-time","title":"Start Time"},"end_time":{"type":"string","format":"date-time","title":"End Time"},"has_been_reviewed":{"type":"boolean","title":"Has Been Reviewed"},"severity":{"type":"string","enum":["alert","detection"],"title":"SeverityEnum"},"thumb_path":{"type":"string","title":"Thumb Path"},"data":{"title":"Data"}},"type":"object","required":["id","camera","start_time","end_time","has_been_reviewed","severity","thumb_path","data"],"title":"ReviewSegmentResponse"},"title":"Response Review Ids Review Ids Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: review-preview-review-event-id-preview-get
|
||||
title: "Review Preview"
|
||||
description: "Review Preview"
|
||||
sidebar_label: "Review Preview"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVE1v2zAM/SsBTxsgxGnRXXwbsG4rsGJFl+1SBAFr07Y62VIlOltg6L8P9FeSpSuwkw2JfHzvkVQHjGWA9AFuKdcIGwXWkUfWtrnJIQVPO02/tm78jp8t7ajhrc63801JDAoceqyJyQtmBw3WBClM0aBAN5CCQ65AgafnVnvKIWXfkoKQVVQjpB3w3kleYK+bEhSwZiMH1wK0uMkhRjWjF9bXyBP2c0t+fwJeoAmvolPT1mJBqQtQULsrsSGnAlvDkI7HE4WPQ7UYN1IjONsECoJ6uVrJJ6eQee3EQEjhW5tlFELRmsX9GAwKMtswNSzh6JzRWe938hQkpzswjTFGBVeXl+fAP9DovE9bXHtv/X+ggvPSY9YD75wYtZE/zVSH8wBjs5NbbPZfi769p0ZKS8YT3TCV5CFuoprO0HvcHxn5xQ4EISqoQ/la228pBCwJZrBXJkTMWKzlNh5q28cnyvhkKh56XUPpMW5zgDnYO7j7bxkfBvteKjaFfF6v784Ah96eNvW+X6XF3bBSQo64srKG03ZxBSkkw33STXsVEzenBPK7af1abyCFitmFNElyqu2y8LpEpuVO52QTdLpv2yEwTRJjMzSVDZy+W60uhpiNbFdhe+dHVaBACg3MV8uL5UpccjZwjf3Ajet5JupE89xJpt+cOIO6H4ieUDcKfoA5Nz16SibNGwXCVuK67hEDffcmRjke3gJxItcBH83Ra/CT9sdPxw5N24sSpTv0WqJfzvyL/rx18OZ+HK63C1Avy5pmqNkf15zYzNr6takIc/I9h+H6fZaROyZ7tuVCfh6ZT9driPEPvigAYA==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Review Preview"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/review/{event_id}/preview"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Review Preview
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"event_id","in":"path","required":true,"schema":{"type":"string","title":"Event Id"}},{"name":"format","in":"query","required":false,"schema":{"type":"string","enum":["gif","mp4"],"default":"gif","title":"Format"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
70
docs/docs/integrations/api/review-review-get.api.mdx
Normal file
70
docs/docs/integrations/api/review-review-get.api.mdx
Normal file
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: review-review-get
|
||||
title: "Review"
|
||||
description: "Review"
|
||||
sidebar_label: "Review"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJy1Vk1v2zgQ/SvGnNXYDbYX3dpt0BbYRYvE7aGBYYykkc0uJarkyLuuof++GFKSqTpJnaY9CSIf5828+SAPwLhxkN7CNe0U/QurBExDFlmZ+l0BKVi/vu4/G2JIoEGLFTFZOXmAGiuCFHKsyKKDBFQNKXxtye4hAUtfW2WpgLRE7SgBl2+pQkgPwPtGDjq2qt5AAgWV2GqGFFBrSIAVawH82VvuumRk05iR/h1kfwXDMdc3U9PvoPrs7cZMQWYqHk+maqYN2ZhtcWS6HuxOJFSV4qcwjZJ5Q7FpRzuyivdPEI3qtpLCRE2WfVhMuZSl1OjAfNPzXAk4diCj0lh6PH3dVtkktlfBUGwbS/aQp5p+6e103UpOu8bUjpzgLxcL+RTkcqsaH3IKN22ek3Nlq2fXPRgSyE3NVLPAsWm0yn3jzr84OXM49QGtRZ8UpspzNVbanVVgVsVdmRj8fVdAl/Rt/hAutKtgHaPlNSuR7RRfGluhdEWBTM88KsqsHJ0tZbGTYih+zsxVXYxGtujWGVG9HrvsaC0zRhPW0cm36GaviOrZsXeSY13/moJNgLdtla0b5O1Dii4FNfsgqC6ROIP+/e5r+e/EWDhusi+U86QmbyW1Y+4miYnEvUuiJO7lyNvejdX3M+aGNhXVPNZoFwPCWq/o8HlDMjvE/z8uL08L/xNqVfiynl1Za+xjqn5a3QUxKu3r/O7y1yaf7GK9f1/6K26aGJkF3w3DbnXUf2iycTya4KBoUbnNQ4n+m5zDTVDNQ+6HejFmS9n9Ue4lrkDd46KsHeUN6t4fxusg311kY88slx9ODIbcTpPavzYSqIi3Rt4Zw8tCGgHmdth3ZHfDO6O1GlLYMjcunc8LqsxFadUGmS52qiAzx0b53ByB6XyuTY56axynLxaL5wGzkuFdmriJIAEhCu4tLp5fLESKxjiu0FdVP/xHzycBjWli+o/njUbls+0dOfRR3fa3u6gv/sjK4ZCho49Wd50sh8tEYi2Uw0xH18k/tJ+8sXaoW++3BHwPenwjnQMeHjnnYKPpcJYf/UPjHGw0bc6Bj/f8OeDh4j5iV/JjlYAhvZUe3hIWZH0OwqGXeU5N7P3JyBErYx2/uVpC1/0PdJLR3A==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Review"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/review"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Review
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"cameras","in":"query","required":false,"schema":{"type":"string","default":"all","title":"Cameras"}},{"name":"labels","in":"query","required":false,"schema":{"type":"string","default":"all","title":"Labels"}},{"name":"zones","in":"query","required":false,"schema":{"type":"string","default":"all","title":"Zones"}},{"name":"reviewed","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Reviewed"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","title":"Limit"}},{"name":"severity","in":"query","required":false,"schema":{"type":"string","enum":["alert","detection"],"title":"SeverityEnum"}},{"name":"before","in":"query","required":false,"schema":{"type":"number","title":"Before"}},{"name":"after","in":"query","required":false,"schema":{"type":"number","title":"After"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"properties":{"id":{"type":"string","title":"Id"},"camera":{"type":"string","title":"Camera"},"start_time":{"type":"string","format":"date-time","title":"Start Time"},"end_time":{"type":"string","format":"date-time","title":"End Time"},"has_been_reviewed":{"type":"boolean","title":"Has Been Reviewed"},"severity":{"type":"string","enum":["alert","detection"],"title":"SeverityEnum"},"thumb_path":{"type":"string","title":"Thumb Path"},"data":{"title":"Data"}},"type":"object","required":["id","camera","start_time","end_time","has_been_reviewed","severity","thumb_path","data"],"title":"ReviewSegmentResponse"},"title":"Response Review Review Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
id: review-summary-review-summary-get
|
||||
title: "Review Summary"
|
||||
description: "Review Summary"
|
||||
sidebar_label: "Review Summary"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztVk1v00AQ/SvRnE2cRuXiW0UrigSiagMHqqia2JNky9rr7o4DJvJ/R+N1/JGkagT0ximx/WbezLy3H1tgXDmI7uGWNop+wDwAk5NFVib7kEAEtn7/4Io0RVs+7D2uiCGAHC2mxGQl0xYyTAkiiDEliw4CUBlE8FSQLSEAS0+FspRAtETtKAAXrylFiLbAZS6Bjq3KVhBAQkssNEMEqDUEwIq1AN41masqaNk0Lki/BtlHn7jP9ctk9BpU3+q8fSZWKQnbPyErOO6RzXapq2ouCV1uMkdOUkwnE/lJyMVW5WIFiOCuiGNyblno0W0DhgBikzFlLHDMc63i2jnho5OYba+s3IqvWHkGjY6n59emsO7wo/cYJQ+oyXKvJ5Uxrcj2mrhtoKOLGloFXXBCTLGv/ZQEly28CoANoz6Bfia4jtuHnUbsQ3usEu/BZvFIMQ9Uvt8fytFGh4Uf1jPvu7oVoFn5MjtjvJJJoiQA9c1AmKFMCZbH/LY0NkWxW4JMb8TAva4vsRyI9F/hTmGZ58Fo/lbnSyw7fffZ2xGJ7i+V11+yjVXm+1O+88dCuz9UlWQ9n04Pt5OvqFVSbxajK2uN/fO9JCFGpeWfYkqPGFWbePAVs/Lzsj6pht6VfXdPzWreTQWtrRVql5DxBcpkU7c6thZ20E/kHK6o0+B5aD2M0Uy+vqiIkf1cqBtcT49uvH66z7dx6cd3jGwHuZ7Nbg4Sem2HonoXjBobSHHEayPXiN1FgdcQQeg9HboW58hudteHwmqIYM2cuygME0rNeGnVCpnGG5WQCTFXtVYdMApDbWLUa+M4ejuZnHnMXE7NpanH3bQCAQiRL3cyPhtPZDS5cZxi7bLm4D3oZNBoKx/TTw5zjap2QV3Qtulyt2VLd02WeQBSoXzbbhfo6IvVVSWv/bku3SfK4UL3TvbvVA4uUxvURd2JjOAZdHsZOgW8u82cgu3dRzr4XB6sEjxE97Ji1oQJ2bofH3cRx5RzL+pggUuW1i3vr2ZQVb8B3yilZw==
|
||||
sidebar_class_name: "get api-method"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import ParamsDetails from "@theme/ParamsDetails";
|
||||
import RequestSchema from "@theme/RequestSchema";
|
||||
import StatusCodes from "@theme/StatusCodes";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Review Summary"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/review/summary"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Review Summary
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={[{"name":"cameras","in":"query","required":false,"schema":{"type":"string","default":"all","title":"Cameras"}},{"name":"labels","in":"query","required":false,"schema":{"type":"string","default":"all","title":"Labels"}},{"name":"zones","in":"query","required":false,"schema":{"type":"string","default":"all","title":"Zones"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","default":"utc","title":"Timezone"}}]}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"last24Hours":{"properties":{"reviewed_alert":{"type":"integer","title":"Reviewed Alert"},"reviewed_detection":{"type":"integer","title":"Reviewed Detection"},"total_alert":{"type":"integer","title":"Total Alert"},"total_detection":{"type":"integer","title":"Total Detection"}},"type":"object","required":["reviewed_alert","reviewed_detection","total_alert","total_detection"],"title":"Last24HoursReview"},"root":{"additionalProperties":{"properties":{"day":{"type":"string","format":"date-time","title":"Day"},"reviewed_alert":{"type":"integer","title":"Reviewed Alert"},"reviewed_detection":{"type":"integer","title":"Reviewed Detection"},"total_alert":{"type":"integer","title":"Total Alert"},"total_detection":{"type":"integer","title":"Total Detection"}},"type":"object","required":["day","reviewed_alert","reviewed_detection","total_alert","total_detection"],"title":"DayReview"},"type":"object","title":"Root"}},"type":"object","required":["last24Hours","root"],"title":"ReviewSummaryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,33 @@
|
||||
---
|
||||
id: appconfigsetbody
|
||||
title: "AppConfigSetBody"
|
||||
description: ""
|
||||
sidebar_label: "AppConfigSetBody"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"requires_restart":1}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"AppConfigSetBody"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
schema={{"properties":{"requires_restart":{"type":"integer","title":"Requires Restart","default":1}},"type":"object","title":"AppConfigSetBody"}}
|
||||
schemaType={"response"}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
|
||||
@ -0,0 +1,33 @@
|
||||
---
|
||||
id: apppostloginbody
|
||||
title: "AppPostLoginBody"
|
||||
description: ""
|
||||
sidebar_label: "AppPostLoginBody"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"user":"string","password":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"AppPostLoginBody"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
schema={{"properties":{"user":{"type":"string","title":"User"},"password":{"type":"string","title":"Password"}},"type":"object","required":["user","password"],"title":"AppPostLoginBody"}}
|
||||
schemaType={"response"}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
|
||||
@ -0,0 +1,33 @@
|
||||
---
|
||||
id: apppostusersbody
|
||||
title: "AppPostUsersBody"
|
||||
description: ""
|
||||
sidebar_label: "AppPostUsersBody"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"username":"string","password":"string","role":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"AppPostUsersBody"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
schema={{"properties":{"username":{"type":"string","title":"Username"},"password":{"type":"string","title":"Password"},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role","default":"viewer"}},"type":"object","required":["username","password"],"title":"AppPostUsersBody"}}
|
||||
schemaType={"response"}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
|
||||
@ -0,0 +1,33 @@
|
||||
---
|
||||
id: appputpasswordbody
|
||||
title: "AppPutPasswordBody"
|
||||
description: ""
|
||||
sidebar_label: "AppPutPasswordBody"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"password":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"AppPutPasswordBody"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
schema={{"properties":{"password":{"type":"string","title":"Password"}},"type":"object","required":["password"],"title":"AppPutPasswordBody"}}
|
||||
schemaType={"response"}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
|
||||
33
docs/docs/integrations/api/schemas/appputrolebody.schema.mdx
Normal file
33
docs/docs/integrations/api/schemas/appputrolebody.schema.mdx
Normal file
@ -0,0 +1,33 @@
|
||||
---
|
||||
id: appputrolebody
|
||||
title: "AppPutRoleBody"
|
||||
description: ""
|
||||
sidebar_label: "AppPutRoleBody"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"role":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"AppPutRoleBody"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
schema={{"properties":{"role":{"type":"string","title":"Role"}},"type":"object","required":["role"],"title":"AppPutRoleBody"}}
|
||||
schemaType={"response"}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
|
||||
@ -0,0 +1,33 @@
|
||||
---
|
||||
id: body-recognize-face-faces-recognize-post
|
||||
title: "Body_recognize_face_faces_recognize_post"
|
||||
description: ""
|
||||
sidebar_label: "Body_recognize_face_faces_recognize_post"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"file":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Body_recognize_face_faces_recognize_post"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
schema={{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_recognize_face_faces_recognize_post"}}
|
||||
schemaType={"response"}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
|
||||
@ -0,0 +1,33 @@
|
||||
---
|
||||
id: body-register-face-faces-name-register-post
|
||||
title: "Body_register_face_faces__name__register_post"
|
||||
description: ""
|
||||
sidebar_label: "Body_register_face_faces__name__register_post"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"file":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"Body_register_face_faces__name__register_post"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
schema={{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_register_face_faces__name__register_post"}}
|
||||
schemaType={"response"}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
|
||||
33
docs/docs/integrations/api/schemas/dayreview.schema.mdx
Normal file
33
docs/docs/integrations/api/schemas/dayreview.schema.mdx
Normal file
@ -0,0 +1,33 @@
|
||||
---
|
||||
id: dayreview
|
||||
title: "DayReview"
|
||||
description: ""
|
||||
sidebar_label: "DayReview"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"day":"2024-07-29T15:51:28.071Z","reviewed_alert":0,"reviewed_detection":0,"total_alert":0,"total_detection":0}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"DayReview"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
schema={{"properties":{"day":{"type":"string","format":"date-time","title":"Day"},"reviewed_alert":{"type":"integer","title":"Reviewed Alert"},"reviewed_detection":{"type":"integer","title":"Reviewed Detection"},"total_alert":{"type":"integer","title":"Total Alert"},"total_detection":{"type":"integer","title":"Total Detection"}},"type":"object","required":["day","reviewed_alert","reviewed_detection","total_alert","total_detection"],"title":"DayReview"}}
|
||||
schemaType={"response"}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
|
||||
@ -0,0 +1,33 @@
|
||||
---
|
||||
id: eventcreateresponse
|
||||
title: "EventCreateResponse"
|
||||
description: ""
|
||||
sidebar_label: "EventCreateResponse"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"success":true,"message":"string","event_id":"string"}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"EventCreateResponse"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
schema={{"properties":{"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"},"event_id":{"type":"string","title":"Event Id"}},"type":"object","required":["success","message","event_id"],"title":"EventCreateResponse"}}
|
||||
schemaType={"response"}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
|
||||
@ -0,0 +1,33 @@
|
||||
---
|
||||
id: eventmultideleteresponse
|
||||
title: "EventMultiDeleteResponse"
|
||||
description: ""
|
||||
sidebar_label: "EventMultiDeleteResponse"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"success":true,"deleted_events":["string"],"not_found_events":["string"]}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"EventMultiDeleteResponse"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
schema={{"properties":{"success":{"type":"boolean","title":"Success"},"deleted_events":{"items":{"type":"string"},"type":"array","title":"Deleted Events"},"not_found_events":{"items":{"type":"string"},"type":"array","title":"Not Found Events"}},"type":"object","required":["success","deleted_events","not_found_events"],"title":"EventMultiDeleteResponse"}}
|
||||
schemaType={"response"}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
|
||||
33
docs/docs/integrations/api/schemas/eventresponse.schema.mdx
Normal file
33
docs/docs/integrations/api/schemas/eventresponse.schema.mdx
Normal file
@ -0,0 +1,33 @@
|
||||
---
|
||||
id: eventresponse
|
||||
title: "EventResponse"
|
||||
description: ""
|
||||
sidebar_label: "EventResponse"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"id":"string","label":"string","sub_label":"string","camera":"string","start_time":0,"end_time":0,"false_positive":true,"zones":["string"],"thumbnail":"string","has_clip":true,"has_snapshot":true,"retain_indefinitely":true,"plus_id":"string","model_hash":"string","detector_type":"string","model_type":"string","data":{}}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"EventResponse"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
schema={{"properties":{"id":{"type":"string","title":"Id"},"label":{"type":"string","title":"Label"},"sub_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sub Label"},"camera":{"type":"string","title":"Camera"},"start_time":{"type":"number","title":"Start Time"},"end_time":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"End Time"},"false_positive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"False Positive"},"zones":{"items":{"type":"string"},"type":"array","title":"Zones"},"thumbnail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail"},"has_clip":{"type":"boolean","title":"Has Clip"},"has_snapshot":{"type":"boolean","title":"Has Snapshot"},"retain_indefinitely":{"type":"boolean","title":"Retain Indefinitely"},"plus_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plus Id"},"model_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Hash"},"detector_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detector Type"},"model_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Type"},"data":{"type":"object","title":"Data"}},"type":"object","required":["id","label","sub_label","camera","start_time","end_time","false_positive","zones","thumbnail","has_clip","has_snapshot","retain_indefinitely","plus_id","model_hash","detector_type","model_type","data"],"title":"EventResponse"}}
|
||||
schemaType={"response"}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
|
||||
@ -0,0 +1,33 @@
|
||||
---
|
||||
id: eventscreatebody
|
||||
title: "EventsCreateBody"
|
||||
description: ""
|
||||
sidebar_label: "EventsCreateBody"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
schema: true
|
||||
sample: {"source_type":"string","sub_label":"string","score":0,"duration":0,"include_recording":true,"draw":{}}
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import Schema from "@theme/Schema";
|
||||
import Heading from "@theme/Heading";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"EventsCreateBody"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<Schema
|
||||
schema={{"properties":{"source_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Type","default":"api"},"sub_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sub Label"},"score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Score","default":0},"duration":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration","default":30},"include_recording":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include Recording","default":true},"draw":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Draw","default":{}}},"type":"object","title":"EventsCreateBody"}}
|
||||
schemaType={"response"}
|
||||
>
|
||||
|
||||
</Schema>
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user