diff options
Diffstat (limited to 'support/doc/api')
-rw-r--r-- | support/doc/api/openapi.yaml | 33 |
1 files changed, 22 insertions, 11 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index a63ee7983..84e42a9f5 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -1226,6 +1226,8 @@ paths: | |||
1226 | name: | 1226 | name: |
1227 | description: Video name | 1227 | description: Video name |
1228 | type: string | 1228 | type: string |
1229 | minLength: 3 | ||
1230 | maxLength: 120 | ||
1229 | tags: | 1231 | tags: |
1230 | description: Video tags (maximum 5 tags each between 2 and 30 characters) | 1232 | description: Video tags (maximum 5 tags each between 2 and 30 characters) |
1231 | type: array | 1233 | type: array |
@@ -1397,6 +1399,8 @@ paths: | |||
1397 | name: | 1399 | name: |
1398 | description: Video name | 1400 | description: Video name |
1399 | type: string | 1401 | type: string |
1402 | minLength: 3 | ||
1403 | maxLength: 120 | ||
1400 | tags: | 1404 | tags: |
1401 | description: Video tags (maximum 5 tags each between 2 and 30 characters) | 1405 | description: Video tags (maximum 5 tags each between 2 and 30 characters) |
1402 | type: array | 1406 | type: array |
@@ -1523,6 +1527,8 @@ paths: | |||
1523 | name: | 1527 | name: |
1524 | description: Video name | 1528 | description: Video name |
1525 | type: string | 1529 | type: string |
1530 | minLength: 3 | ||
1531 | maxLength: 120 | ||
1526 | tags: | 1532 | tags: |
1527 | description: Video tags (maximum 5 tags each between 2 and 30 characters) | 1533 | description: Video tags (maximum 5 tags each between 2 and 30 characters) |
1528 | type: array | 1534 | type: array |
@@ -1627,6 +1633,8 @@ paths: | |||
1627 | name: | 1633 | name: |
1628 | description: Live video/replay name | 1634 | description: Live video/replay name |
1629 | type: string | 1635 | type: string |
1636 | minLength: 3 | ||
1637 | maxLength: 120 | ||
1630 | tags: | 1638 | tags: |
1631 | description: Live video/replay tags (maximum 5 tags each between 2 and 30 characters) | 1639 | description: Live video/replay tags (maximum 5 tags each between 2 and 30 characters) |
1632 | type: array | 1640 | type: array |
@@ -2379,6 +2387,8 @@ paths: | |||
2379 | displayName: | 2387 | displayName: |
2380 | description: Video playlist display name | 2388 | description: Video playlist display name |
2381 | type: string | 2389 | type: string |
2390 | minLength: 1 | ||
2391 | maxLength: 120 | ||
2382 | thumbnailfile: | 2392 | thumbnailfile: |
2383 | description: Video playlist thumbnail file | 2393 | description: Video playlist thumbnail file |
2384 | type: string | 2394 | type: string |
@@ -2432,6 +2442,8 @@ paths: | |||
2432 | displayName: | 2442 | displayName: |
2433 | description: Video playlist display name | 2443 | description: Video playlist display name |
2434 | type: string | 2444 | type: string |
2445 | minLength: 1 | ||
2446 | maxLength: 120 | ||
2435 | thumbnailfile: | 2447 | thumbnailfile: |
2436 | description: Video playlist thumbnail file | 2448 | description: Video playlist thumbnail file |
2437 | type: string | 2449 | type: string |
@@ -4208,6 +4220,8 @@ components: | |||
4208 | example: 9c9de5e8-0a1e-484a-b099-e80766180a6d | 4220 | example: 9c9de5e8-0a1e-484a-b099-e80766180a6d |
4209 | name: | 4221 | name: |
4210 | type: string | 4222 | type: string |
4223 | minLength: 3 | ||
4224 | maxLength: 120 | ||
4211 | Video: | 4225 | Video: |
4212 | properties: | 4226 | properties: |
4213 | id: | 4227 | id: |
@@ -4249,6 +4263,8 @@ components: | |||
4249 | name: | 4263 | name: |
4250 | type: string | 4264 | type: string |
4251 | example: What is PeerTube? | 4265 | example: What is PeerTube? |
4266 | minLength: 3 | ||
4267 | maxLength: 120 | ||
4252 | thumbnailPath: | 4268 | thumbnailPath: |
4253 | type: string | 4269 | type: string |
4254 | example: /static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg | 4270 | example: /static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg |
@@ -4310,10 +4326,14 @@ components: | |||
4310 | account: | 4326 | account: |
4311 | $ref: '#/components/schemas/Account' | 4327 | $ref: '#/components/schemas/Account' |
4312 | tags: | 4328 | tags: |
4329 | example: [flowers, gardening] | ||
4313 | type: array | 4330 | type: array |
4331 | minItems: 1 | ||
4332 | maxItems: 5 | ||
4314 | items: | 4333 | items: |
4315 | type: string | 4334 | type: string |
4316 | example: [flowers, gardening] | 4335 | minLength: 2 |
4336 | maxLength: 30 | ||
4317 | files: | 4337 | files: |
4318 | type: array | 4338 | type: array |
4319 | description: 'WebTorrent/raw video files. Can be empty if WebTorrent is disabled on the server. In this case, video files will be in the "streamingPlaylists[].files" property' | 4339 | description: 'WebTorrent/raw video files. Can be empty if WebTorrent is disabled on the server. In this case, video files will be in the "streamingPlaylists[].files" property' |
@@ -4438,16 +4458,7 @@ components: | |||
4438 | type: string | 4458 | type: string |
4439 | example: Decided to ban the server since it spams us regularly | 4459 | example: Decided to ban the server since it spams us regularly |
4440 | video: | 4460 | video: |
4441 | type: object | 4461 | $ref: '#/components/schemas/VideoInfo' |
4442 | properties: | ||
4443 | id: | ||
4444 | type: integer | ||
4445 | name: | ||
4446 | type: string | ||
4447 | uuid: | ||
4448 | type: string | ||
4449 | format: uuid | ||
4450 | example: 9c9de5e8-0a1e-484a-b099-e80766180a6d | ||
4451 | createdAt: | 4462 | createdAt: |
4452 | type: string | 4463 | type: string |
4453 | format: date-time | 4464 | format: date-time |