diff options
author | Rigel Kent <sendmemail@rigelk.eu> | 2020-12-08 21:16:10 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-12-08 21:16:10 +0100 |
commit | f2eb23cd87cf32b8fe545178143b5f49e06a58da (patch) | |
tree | af7d59945af70e28fd85047e2c688c59a908f548 /support/doc/api | |
parent | c977fd3ec931c059111ddb2b8d6ddbb20b6b99a1 (diff) | |
download | PeerTube-f2eb23cd87cf32b8fe545178143b5f49e06a58da.tar.gz PeerTube-f2eb23cd87cf32b8fe545178143b5f49e06a58da.tar.zst PeerTube-f2eb23cd87cf32b8fe545178143b5f49e06a58da.zip |
emit more specific status codes on video upload (#3423)
- reduce http status codes list to potentially useful codes
- convert more codes to typed ones
- factorize html generator for error responses
Diffstat (limited to 'support/doc/api')
-rw-r--r-- | support/doc/api/openapi.yaml | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 2d6b4df27..ba420b4a9 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -1312,20 +1312,24 @@ paths: | |||
1312 | application/json: | 1312 | application/json: |
1313 | schema: | 1313 | schema: |
1314 | $ref: '#/components/schemas/VideoUploadResponse' | 1314 | $ref: '#/components/schemas/VideoUploadResponse' |
1315 | '400': | ||
1316 | description: invalid file field, schedule date or parameter | ||
1315 | '403': | 1317 | '403': |
1316 | description: user video quota is exceeded with this video | 1318 | description: video didn't pass upload filter |
1317 | '408': | 1319 | '408': |
1318 | description: upload has timed out | 1320 | description: upload has timed out |
1319 | '413': | 1321 | '413': |
1320 | description: video file too large | 1322 | description: video file too large, due to quota or max body size limit set by the reverse-proxy |
1321 | headers: | 1323 | headers: |
1322 | X-File-Maximum-Size: | 1324 | X-File-Maximum-Size: |
1323 | schema: | 1325 | schema: |
1324 | type: string | 1326 | type: string |
1325 | format: Nginx size | 1327 | format: Nginx size |
1326 | description: Maximum file size for the video | 1328 | description: Maximum file size for the video |
1329 | '415': | ||
1330 | description: video type unsupported | ||
1327 | '422': | 1331 | '422': |
1328 | description: invalid input file | 1332 | description: video unreadable |
1329 | requestBody: | 1333 | requestBody: |
1330 | content: | 1334 | content: |
1331 | multipart/form-data: | 1335 | multipart/form-data: |
@@ -1534,10 +1538,12 @@ paths: | |||
1534 | application/json: | 1538 | application/json: |
1535 | schema: | 1539 | schema: |
1536 | $ref: '#/components/schemas/VideoUploadResponse' | 1540 | $ref: '#/components/schemas/VideoUploadResponse' |
1537 | '409': | ||
1538 | description: HTTP or Torrent/magnetURI import not enabled | ||
1539 | '400': | 1541 | '400': |
1540 | description: '`magnetUri` or `targetUrl` or a torrent file missing' | 1542 | description: '`magnetUri` or `targetUrl` or a torrent file missing' |
1543 | '403': | ||
1544 | description: video didn't pass pre-import filter | ||
1545 | '409': | ||
1546 | description: HTTP or Torrent/magnetURI import not enabled | ||
1541 | 1547 | ||
1542 | /videos/live: | 1548 | /videos/live: |
1543 | post: | 1549 | post: |
@@ -3572,7 +3578,7 @@ components: | |||
3572 | name: name | 3578 | name: name |
3573 | in: path | 3579 | in: path |
3574 | required: true | 3580 | required: true |
3575 | description: The name of the account | 3581 | description: The username or handle of the account |
3576 | schema: | 3582 | schema: |
3577 | type: string | 3583 | type: string |
3578 | example: chocobozzz | chocobozzz@example.org | 3584 | example: chocobozzz | chocobozzz@example.org |
@@ -5175,7 +5181,7 @@ components: | |||
5175 | properties: | 5181 | properties: |
5176 | name: | 5182 | name: |
5177 | type: string | 5183 | type: string |
5178 | description: The name for the default channel | 5184 | description: The username for the default channel |
5179 | pattern: '/^[ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789\\-_.:]+$/' | 5185 | pattern: '/^[ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789\\-_.:]+$/' |
5180 | displayName: | 5186 | displayName: |
5181 | type: string | 5187 | type: string |