diff options
Diffstat (limited to 'support/doc/api')
-rw-r--r-- | support/doc/api/openapi.yaml | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 8521f684e..bd36c41cd 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -247,8 +247,8 @@ tags: | |||
247 | ### Import | 247 | ### Import |
248 | 248 | ||
249 | - _URL_-based: where the URL points to any service supported by [youtube-dl](https://ytdl-org.github.io/youtube-dl/) | 249 | - _URL_-based: where the URL points to any service supported by [youtube-dl](https://ytdl-org.github.io/youtube-dl/) |
250 | - _magnet_-based: where the URI resolves to a BitTorrent ressource containing a single supported video file | 250 | - _magnet_-based: where the URI resolves to a BitTorrent resource containing a single supported video file |
251 | - _torrent_-based: where the metainfo file resolves to a BitTorrent ressource containing a single supported video file | 251 | - _torrent_-based: where the metainfo file resolves to a BitTorrent resource containing a single supported video file |
252 | 252 | ||
253 | The import function is practical when the desired video/audio is available online. It makes PeerTube | 253 | The import function is practical when the desired video/audio is available online. It makes PeerTube |
254 | download it for you, saving you as much bandwidth and avoiding any instability or limitation your network might have. | 254 | download it for you, saving you as much bandwidth and avoiding any instability or limitation your network might have. |
@@ -2053,7 +2053,7 @@ paths: | |||
2053 | x-summary: video file too large, due to quota or max body size limit set by the reverse-proxy | 2053 | x-summary: video file too large, due to quota or max body size limit set by the reverse-proxy |
2054 | description: | | 2054 | description: | |
2055 | If the response has no body, it means the reverse-proxy didn't let it through. Otherwise disambiguate via `type`: | 2055 | If the response has no body, it means the reverse-proxy didn't let it through. Otherwise disambiguate via `type`: |
2056 | - `quota_reached` for quota limits wether daily or global | 2056 | - `quota_reached` for quota limits whether daily or global |
2057 | headers: | 2057 | headers: |
2058 | X-File-Maximum-Size: | 2058 | X-File-Maximum-Size: |
2059 | schema: | 2059 | schema: |
@@ -5277,7 +5277,7 @@ components: | |||
5277 | moderator: Moderator scope | 5277 | moderator: Moderator scope |
5278 | user: User scope | 5278 | user: User scope |
5279 | schemas: | 5279 | schemas: |
5280 | # Resuable core properties | 5280 | # Reusable core properties |
5281 | id: | 5281 | id: |
5282 | type: integer | 5282 | type: integer |
5283 | minimum: 1 | 5283 | minimum: 1 |
@@ -5443,7 +5443,7 @@ components: | |||
5443 | - 1 | 5443 | - 1 |
5444 | - 2 | 5444 | - 2 |
5445 | - 3 | 5445 | - 3 |
5446 | description: 'The live latency mode (Default = `1`, HIght latency = `2`, Small Latency = `3`)' | 5446 | description: 'The live latency mode (Default = `1`, High latency = `2`, Small Latency = `3`)' |
5447 | 5447 | ||
5448 | VideoStateConstant: | 5448 | VideoStateConstant: |
5449 | properties: | 5449 | properties: |
@@ -7754,7 +7754,7 @@ components: | |||
7754 | - 5 | 7754 | - 5 |
7755 | nullable: true | 7755 | nullable: true |
7756 | description: > | 7756 | description: > |
7757 | Error type if an error occured during the live session: | 7757 | Error type if an error occurred during the live session: |
7758 | - `1`: Bad socket health (transcoding is too slow) | 7758 | - `1`: Bad socket health (transcoding is too slow) |
7759 | - `2`: Max duration exceeded | 7759 | - `2`: Max duration exceeded |
7760 | - `3`: Quota exceeded | 7760 | - `3`: Quota exceeded |