aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--support/doc/api/openapi.yaml65
1 files changed, 48 insertions, 17 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 84e42a9f5..344ee033e 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -1824,10 +1824,10 @@ paths:
1824 reason: 1824 reason:
1825 description: Reason why the user reports this video 1825 description: Reason why the user reports this video
1826 type: string 1826 type: string
1827 minLength: 4 1827 minLength: 2
1828 maxLength: 3000
1828 predefinedReasons: 1829 predefinedReasons:
1829 $ref: '#/components/schemas/PredefinedAbuseReasons' 1830 $ref: '#/components/schemas/PredefinedAbuseReasons'
1830
1831 video: 1831 video:
1832 type: object 1832 type: object
1833 properties: 1833 properties:
@@ -1883,6 +1883,8 @@ paths:
1883 moderationComment: 1883 moderationComment:
1884 type: string 1884 type: string
1885 description: Update the report comment visible only to the moderation team 1885 description: Update the report comment visible only to the moderation team
1886 minLength: 2
1887 maxLength: 3000
1886 responses: 1888 responses:
1887 '204': 1889 '204':
1888 description: successful operation 1890 description: successful operation
@@ -1940,6 +1942,8 @@ paths:
1940 message: 1942 message:
1941 description: Message to send 1943 description: Message to send
1942 type: string 1944 type: string
1945 minLength: 2
1946 maxLength: 3000
1943 required: 1947 required:
1944 - message 1948 - message
1945 responses: 1949 responses:
@@ -4448,6 +4452,8 @@ components:
4448 reason: 4452 reason:
4449 type: string 4453 type: string
4450 example: The video is a spam 4454 example: The video is a spam
4455 minLength: 2
4456 maxLength: 3000
4451 predefinedReasons: 4457 predefinedReasons:
4452 $ref: '#/components/schemas/AbusePredefinedReasons' 4458 $ref: '#/components/schemas/AbusePredefinedReasons'
4453 reporterAccount: 4459 reporterAccount:
@@ -4457,6 +4463,8 @@ components:
4457 moderationComment: 4463 moderationComment:
4458 type: string 4464 type: string
4459 example: Decided to ban the server since it spams us regularly 4465 example: Decided to ban the server since it spams us regularly
4466 minLength: 2
4467 maxLength: 3000
4460 video: 4468 video:
4461 $ref: '#/components/schemas/VideoInfo' 4469 $ref: '#/components/schemas/VideoInfo'
4462 createdAt: 4470 createdAt:
@@ -4468,6 +4476,8 @@ components:
4468 type: integer 4476 type: integer
4469 message: 4477 message:
4470 type: string 4478 type: string
4479 minLength: 2
4480 maxLength: 3000
4471 byModerator: 4481 byModerator:
4472 type: boolean 4482 type: boolean
4473 createdAt: 4483 createdAt:
@@ -4489,12 +4499,16 @@ components:
4489 format: date-time 4499 format: date-time
4490 name: 4500 name:
4491 type: string 4501 type: string
4502 minLength: 3
4503 maxLength: 120
4492 uuid: 4504 uuid:
4493 type: string 4505 type: string
4494 format: uuid 4506 format: uuid
4495 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d 4507 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4496 description: 4508 description:
4497 type: string 4509 type: string
4510 minLength: 3
4511 maxLength: 10000
4498 duration: 4512 duration:
4499 type: integer 4513 type: integer
4500 views: 4514 views:
@@ -4509,8 +4523,12 @@ components:
4509 properties: 4523 properties:
4510 displayName: 4524 displayName:
4511 type: string 4525 type: string
4526 minLength: 1
4527 maxLength: 120
4512 description: 4528 description:
4513 type: string 4529 type: string
4530 minLength: 3
4531 maxLength: 1000
4514 isLocal: 4532 isLocal:
4515 type: boolean 4533 type: boolean
4516 ownerAccount: 4534 ownerAccount:
@@ -4534,12 +4552,16 @@ components:
4534 format: date-time 4552 format: date-time
4535 description: 4553 description:
4536 type: string 4554 type: string
4555 minLength: 3
4556 maxLength: 1000
4537 uuid: 4557 uuid:
4538 type: string 4558 type: string
4539 format: uuid 4559 format: uuid
4540 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d 4560 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4541 displayName: 4561 displayName:
4542 type: string 4562 type: string
4563 minLength: 1
4564 maxLength: 120
4543 isLocal: 4565 isLocal:
4544 type: boolean 4566 type: boolean
4545 videoLength: 4567 videoLength:
@@ -4563,6 +4585,8 @@ components:
4563 format: url 4585 format: url
4564 text: 4586 text:
4565 type: string 4587 type: string
4588 minLength: 1
4589 maxLength: 10000
4566 threadId: 4590 threadId:
4567 type: integer 4591 type: integer
4568 inReplyToCommentId: 4592 inReplyToCommentId:
@@ -5381,34 +5405,41 @@ components:
5381 - username 5405 - username
5382 - password 5406 - password
5383 - email 5407 - email
5384 VideoChannelCreate: 5408
5409 VideoChannelCommon:
5385 properties: 5410 properties:
5386 name:
5387 type: string
5388 displayName: 5411 displayName:
5389 type: string 5412 type: string
5413 minLength: 1
5414 maxLength: 120
5390 description: 5415 description:
5391 type: string 5416 type: string
5417 minLength: 3
5418 maxLength: 1000
5392 support: 5419 support:
5393 type: string 5420 type: string
5394 description: 'A text shown by default on all videos of this channel, to tell the audience how to support it' 5421 description: 'A text shown by default on all videos of this channel, to tell the audience how to support it'
5395 example: Please support my work on <insert crowdfunding plateform>! <3 5422 example: Please support my work on <insert crowdfunding plateform>! <3
5423 minLength: 3
5424 maxLength: 1000
5425 VideoChannelCreate:
5426 allOf:
5427 - $ref: '#/components/schemas/VideoChannelCommon'
5428 - properties:
5429 name:
5430 type: string
5431 minLength: 1
5432 maxLength: 120
5396 required: 5433 required:
5397 - name 5434 - name
5398 - displayName 5435 - displayName
5399 VideoChannelUpdate: 5436 VideoChannelUpdate:
5400 properties: 5437 allOf:
5401 displayName: 5438 - $ref: '#/components/schemas/VideoChannelCommon'
5402 type: string 5439 - properties:
5403 description: 5440 bulkVideosSupportUpdate:
5404 type: string 5441 type: boolean
5405 support: 5442 description: 'Update the support field for all videos of this channel'
5406 type: string
5407 description: 'A text shown by default on all videos of this channel, to tell the audience how to support it'
5408 example: Please support my work on <insert crowdfunding plateform>! <3
5409 bulkVideosSupportUpdate:
5410 type: boolean
5411 description: 'Update the support field for all videos of this channel'
5412 5443
5413 MRSSPeerLink: 5444 MRSSPeerLink:
5414 type: object 5445 type: object