aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api
diff options
context:
space:
mode:
authorRigel Kent <sendmemail@rigelk.eu>2021-06-06 10:21:06 +0200
committerRigel Kent <sendmemail@rigelk.eu>2021-06-06 10:21:06 +0200
commitc756bae079e02873f6433582ca14a092fec0db27 (patch)
tree2b24e065144fdb11b8b1ef58ef3157530bd6b2d1 /support/doc/api
parentfc21ef5c62d845576a916414468b3a57370a57b2 (diff)
downloadPeerTube-c756bae079e02873f6433582ca14a092fec0db27.tar.gz
PeerTube-c756bae079e02873f6433582ca14a092fec0db27.tar.zst
PeerTube-c756bae079e02873f6433582ca14a092fec0db27.zip
add video upload types, add doc middleware to more routes
Diffstat (limited to 'support/doc/api')
-rw-r--r--support/doc/api/openapi.yaml43
1 files changed, 35 insertions, 8 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 6c5a15087..b43b6bfa0 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -1802,6 +1802,7 @@ paths:
1802 '/videos/{id}/views': 1802 '/videos/{id}/views':
1803 post: 1803 post:
1804 summary: Add a view to a video 1804 summary: Add a view to a video
1805 operationId: addView
1805 tags: 1806 tags:
1806 - Video 1807 - Video
1807 parameters: 1808 parameters:
@@ -1813,6 +1814,7 @@ paths:
1813 '/videos/{id}/watching': 1814 '/videos/{id}/watching':
1814 put: 1815 put:
1815 summary: Set watching progress of a video 1816 summary: Set watching progress of a video
1817 operationId: setProgress
1816 tags: 1818 tags:
1817 - Video 1819 - Video
1818 security: 1820 security:
@@ -1851,7 +1853,10 @@ paths:
1851 '408': 1853 '408':
1852 description: upload has timed out 1854 description: upload has timed out
1853 '413': 1855 '413':
1854 description: video file too large, due to quota or max body size limit set by the reverse-proxy 1856 x-summary: video file too large, due to quota or max body size limit set by the reverse-proxy
1857 description: |
1858 If the response has no body, it means the reverse-proxy didn't let it through. Otherwise disambiguate via `type`:
1859 - `quota_reached` for quota limits wether daily or global
1855 headers: 1860 headers:
1856 X-File-Maximum-Size: 1861 X-File-Maximum-Size:
1857 schema: 1862 schema:
@@ -1951,7 +1956,11 @@ paths:
1951 type: number 1956 type: number
1952 example: 0 1957 example: 0
1953 '413': 1958 '413':
1954 description: video file too large, due to quota, absolute max file size or concurrent partial upload limit 1959 x-summary: video file too large, due to quota, absolute max file size or concurrent partial upload limit
1960 description: |
1961 Disambiguate via `type`:
1962 - `max_file_size_reached` for the absolute file size limit
1963 - `quota_reached` for quota limits whether daily or global
1955 '415': 1964 '415':
1956 description: video type unsupported 1965 description: video type unsupported
1957 put: 1966 put:
@@ -2027,10 +2036,14 @@ paths:
2027 example: 0 2036 example: 0
2028 '403': 2037 '403':
2029 description: video didn't pass upload filter 2038 description: video didn't pass upload filter
2030 '413': 2039 '404':
2031 description: video file too large, due to quota or max body size limit set by the reverse-proxy 2040 description: upload not found
2041 '409':
2042 description: chunk doesn't match range
2032 '422': 2043 '422':
2033 description: video unreadable 2044 description: video unreadable
2045 '429':
2046 description: too many concurrent requests
2034 delete: 2047 delete:
2035 summary: Cancel the resumable upload of a video, deleting any data uploaded so far 2048 summary: Cancel the resumable upload of a video, deleting any data uploaded so far
2036 description: Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to cancel the upload of a video 2049 description: Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to cancel the upload of a video
@@ -2063,6 +2076,8 @@ paths:
2063 schema: 2076 schema:
2064 type: number 2077 type: number
2065 example: 0 2078 example: 0
2079 '404':
2080 description: upload not found
2066 2081
2067 /videos/imports: 2082 /videos/imports:
2068 post: 2083 post:
@@ -2116,8 +2131,20 @@ paths:
2116 application/json: 2131 application/json:
2117 schema: 2132 schema:
2118 $ref: '#/components/schemas/VideoUploadResponse' 2133 $ref: '#/components/schemas/VideoUploadResponse'
2134 '400':
2135 x-summary: validation error, or conflicting `saveReplay` and `permanentLive` parameter set
2136 description: |
2137 Disambiguate via `type`:
2138 - default type for a validation error
2139 - `live_conflicting_permanent_and_save_replay` for conflicting parameters set
2119 '403': 2140 '403':
2120 description: live is not enabled, allow replay is not enabled, or max instance/user live videos limit is exceeded 2141 x-summary: live is not enabled, allow replay is not enabled, or max instance/user live videos limit is exceeded
2142 description: |
2143 Disambiguate via `type`:
2144 - `live_not_enabled` for a disabled live feature
2145 - `live_not_allowing_replay` for a disabled replay feature
2146 - `max_instance_lives_limit_reached` for the absolute concurrent live limit
2147 - `max_user_lives_limit_reached` for the user concurrent live limit
2121 requestBody: 2148 requestBody:
2122 content: 2149 content:
2123 multipart/form-data: 2150 multipart/form-data:
@@ -2318,7 +2345,7 @@ paths:
2318 type: string 2345 type: string
2319 - name: videoIs 2346 - name: videoIs
2320 in: query 2347 in: query
2321 description: only list blacklisted or deleted videos 2348 description: only list deleted or blocklisted videos
2322 schema: 2349 schema:
2323 type: string 2350 type: string
2324 enum: 2351 enum:
@@ -4396,7 +4423,7 @@ components:
4396 name: sort 4423 name: sort
4397 in: query 4424 in: query
4398 required: false 4425 required: false
4399 description: Sort blacklists by criteria 4426 description: Sort blocklists by criteria
4400 schema: 4427 schema:
4401 type: string 4428 type: string
4402 enum: 4429 enum:
@@ -4859,7 +4886,7 @@ components:
4859 enum: 4886 enum:
4860 - 0 4887 - 0
4861 - 1 4888 - 1
4862 description: 'Admin flags for the user (None = `0`, Bypass video blacklist = `1`)' 4889 description: 'Admin flags for the user (None = `0`, Bypass video blocklist = `1`)'
4863 example: 1 4890 example: 1
4864 4891
4865 VideoStateConstant: 4892 VideoStateConstant: