Skip to content

Commit

Permalink
Use Swagger documentation for Frigate HTTP API (#14178)
Browse files Browse the repository at this point in the history
* Updated documentation

* docusaurus.config and sidebars converted to Typescript to allow for typings

* Added type for sidebars.ts

* Replaced integrations/api.md with automatically generated openAPI specification. Make sidebar collapsible to increase readability

* Fix HTTP API links in the documentation

* Added rust as language in the openapi sidebar

* Make sure configuration/pwa is present

* Fix API slug

* Fix links

* Revert sidebarCollapsible configuration

* Make HTTP API sidebar collapsed by default. Added CSS for OpenAPI methods

* Proper localhost server path

* Proper localhost server path

* No introduction page

* Lint
  • Loading branch information
iursevla authored Oct 7, 2024
1 parent ddcec82 commit 757150d
Show file tree
Hide file tree
Showing 14 changed files with 13,932 additions and 6,298 deletions.
7 changes: 6 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Website

This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
This website is built using [Docusaurus 3.5](https://docusaurus.io/docs), a modern static website generator.

For installation and contributing instructions, please follow the [Contributing Docs](https://docs.frigate.video/development/contributing).

# Development

1. Run `npm i` to install dependencies
2. Run `npm run start` to start the website
2 changes: 1 addition & 1 deletion docs/docs/configuration/record.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ Footage can be exported from Frigate by right-clicking (desktop) or long pressin

### Time-lapse export

Time lapse exporting is available only via the [HTTP API](../integrations/api.md#post-apiexportcamerastartstart-timestampendend-timestamp).
Time lapse exporting is available only via the [HTTP API](../integrations/api/export-recording-export-camera-name-start-start-time-end-end-time-post.api.mdx).

When exporting a time-lapse the default speed-up is 25x with 30 FPS. This means that every 25 seconds of (real-time) recording is condensed into 1 second of time-lapse video (always without audio) with a smoothness of 30 FPS.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/configuration/snapshots.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: snapshots
title: Snapshots
---

Frigate can save a snapshot image to `/media/frigate/clips` for each object that is detected named as `<camera>-<id>.jpg`. They are also accessible [via the api](../integrations/api.md#get-apieventsidsnapshotjpg)
Frigate can save a snapshot image to `/media/frigate/clips` for each object that is detected named as `<camera>-<id>.jpg`. They are also accessible [via the api](../integrations/api/event-snapshot-events-event-id-snapshot-jpg-get.api.mdx)

For users with Frigate+ enabled, snapshots are accessible in the UI in the Frigate+ pane to allow for quick submission to the Frigate+ service.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/development/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ npm run test
#### 1. Installation

```console
npm install
cd docs && npm install
```

#### 2. Local Development
Expand Down
Loading

0 comments on commit 757150d

Please sign in to comment.