diff options
Diffstat (limited to 'support/doc/api/openapi.yaml')
| -rw-r--r-- | support/doc/api/openapi.yaml | 580 |
1 files changed, 112 insertions, 468 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 89e510cb4..c84dc3307 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
| @@ -25,26 +25,10 @@ paths: | |||
| 25 | produces: | 25 | produces: |
| 26 | - application/json | 26 | - application/json |
| 27 | parameters: | 27 | parameters: |
| 28 | - name: name | 28 | - $ref: "accounts.yaml#/parameters/name" |
| 29 | in: path | 29 | - $ref: "commons.yaml#/parameters/start" |
| 30 | required: true | 30 | - $ref: "commons.yaml#/parameters/count" |
| 31 | type: string | 31 | - $ref: "commons.yaml#/parameters/sort" |
| 32 | description: 'The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for example)' | ||
| 33 | - name: start | ||
| 34 | in: query | ||
| 35 | required: false | ||
| 36 | type: number | ||
| 37 | description: 'starting page' | ||
| 38 | - name: stop | ||
| 39 | in: query | ||
| 40 | required: false | ||
| 41 | type: number | ||
| 42 | description: 'stopping page' | ||
| 43 | - name: sort | ||
| 44 | in: query | ||
| 45 | required: false | ||
| 46 | type: number | ||
| 47 | description: 'sorting' | ||
| 48 | responses: | 32 | responses: |
| 49 | '200': | 33 | '200': |
| 50 | description: successful operation | 34 | description: successful operation |
| @@ -59,11 +43,7 @@ paths: | |||
| 59 | produces: | 43 | produces: |
| 60 | - application/json | 44 | - application/json |
| 61 | parameters: | 45 | parameters: |
| 62 | - name: name | 46 | - $ref: "accounts.yaml#/parameters/name" |
| 63 | in: path | ||
| 64 | required: true | ||
| 65 | type: string | ||
| 66 | description: 'The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for example)' | ||
| 67 | responses: | 47 | responses: |
| 68 | '200': | 48 | '200': |
| 69 | description: successful operation | 49 | description: successful operation |
| @@ -141,22 +121,10 @@ paths: | |||
| 141 | in: path | 121 | in: path |
| 142 | required: true | 122 | required: true |
| 143 | type: string | 123 | type: string |
| 144 | description: 'The id of the account' | 124 | description: 'The state of the job' |
| 145 | - name: start | 125 | - $ref: "commons.yaml#/parameters/start" |
| 146 | in: query | 126 | - $ref: "commons.yaml#/parameters/count" |
| 147 | required: false | 127 | - $ref: "commons.yaml#/parameters/sort" |
| 148 | type: number | ||
| 149 | description: 'starting page' | ||
| 150 | - name: count | ||
| 151 | in: query | ||
| 152 | required: false | ||
| 153 | type: number | ||
| 154 | description: '' | ||
| 155 | - name: sort | ||
| 156 | in: query | ||
| 157 | required: false | ||
| 158 | type: number | ||
| 159 | description: 'sorting' | ||
| 160 | responses: | 128 | responses: |
| 161 | '200': | 129 | '200': |
| 162 | description: successful operation | 130 | description: successful operation |
| @@ -192,21 +160,9 @@ paths: | |||
| 192 | produces: | 160 | produces: |
| 193 | - application/json | 161 | - application/json |
| 194 | parameters: | 162 | parameters: |
| 195 | - name: start | 163 | - $ref: "commons.yaml#/parameters/start" |
| 196 | in: query | 164 | - $ref: "commons.yaml#/parameters/count" |
| 197 | required: false | 165 | - $ref: "commons.yaml#/parameters/sort" |
| 198 | type: number | ||
| 199 | description: 'starting page' | ||
| 200 | - name: stop | ||
| 201 | in: query | ||
| 202 | required: false | ||
| 203 | type: number | ||
| 204 | description: 'stopping page' | ||
| 205 | - name: sort | ||
| 206 | in: query | ||
| 207 | required: false | ||
| 208 | type: number | ||
| 209 | description: 'sorting' | ||
| 210 | responses: | 166 | responses: |
| 211 | '200': | 167 | '200': |
| 212 | description: successful operation | 168 | description: successful operation |
| @@ -223,21 +179,9 @@ paths: | |||
| 223 | produces: | 179 | produces: |
| 224 | - application/json | 180 | - application/json |
| 225 | parameters: | 181 | parameters: |
| 226 | - name: start | 182 | - $ref: "commons.yaml#/parameters/start" |
| 227 | in: query | 183 | - $ref: "commons.yaml#/parameters/count" |
| 228 | required: false | 184 | - $ref: "commons.yaml#/parameters/sort" |
| 229 | type: number | ||
| 230 | description: 'starting page' | ||
| 231 | - name: stop | ||
| 232 | in: query | ||
| 233 | required: false | ||
| 234 | type: number | ||
| 235 | description: 'stopping page' | ||
| 236 | - name: sort | ||
| 237 | in: query | ||
| 238 | required: false | ||
| 239 | type: number | ||
| 240 | description: 'sorting' | ||
| 241 | responses: | 185 | responses: |
| 242 | '200': | 186 | '200': |
| 243 | description: successful operation | 187 | description: successful operation |
| @@ -261,7 +205,7 @@ paths: | |||
| 261 | $ref: '#/definitions/Follow' | 205 | $ref: '#/definitions/Follow' |
| 262 | responses: | 206 | responses: |
| 263 | '204': | 207 | '204': |
| 264 | description: successful operation | 208 | $ref: "commons.yaml#/responses/emptySuccess" |
| 265 | /users: | 209 | /users: |
| 266 | post: | 210 | post: |
| 267 | security: | 211 | security: |
| @@ -294,21 +238,9 @@ paths: | |||
| 294 | produces: | 238 | produces: |
| 295 | - application/json | 239 | - application/json |
| 296 | parameters: | 240 | parameters: |
| 297 | - name: start | 241 | - $ref: "commons.yaml#/parameters/start" |
| 298 | in: query | 242 | - $ref: "commons.yaml#/parameters/count" |
| 299 | required: false | 243 | - $ref: "commons.yaml#/parameters/sort" |
| 300 | type: number | ||
| 301 | description: 'starting page' | ||
| 302 | - name: stop | ||
| 303 | in: query | ||
| 304 | required: false | ||
| 305 | type: number | ||
| 306 | description: 'stopping page' | ||
| 307 | - name: sort | ||
| 308 | in: query | ||
| 309 | required: false | ||
| 310 | type: number | ||
| 311 | description: 'sorting' | ||
| 312 | responses: | 244 | responses: |
| 313 | '200': | 245 | '200': |
| 314 | description: successful operation | 246 | description: successful operation |
| @@ -327,14 +259,10 @@ paths: | |||
| 327 | produces: | 259 | produces: |
| 328 | - application/json | 260 | - application/json |
| 329 | parameters: | 261 | parameters: |
| 330 | - name: id | 262 | - $ref: "users.yaml#/parameters/id" |
| 331 | in: path | ||
| 332 | required: true | ||
| 333 | type: string | ||
| 334 | description: 'The user id ' | ||
| 335 | responses: | 263 | responses: |
| 336 | '204': | 264 | '204': |
| 337 | description: successful operation | 265 | $ref: "commons.yaml#/responses/emptySuccess" |
| 338 | get: | 266 | get: |
| 339 | security: | 267 | security: |
| 340 | - OAuth2: [ ] | 268 | - OAuth2: [ ] |
| @@ -345,11 +273,7 @@ paths: | |||
| 345 | produces: | 273 | produces: |
| 346 | - application/json | 274 | - application/json |
| 347 | parameters: | 275 | parameters: |
| 348 | - name: id | 276 | - $ref: "users.yaml#/parameters/id" |
| 349 | in: path | ||
| 350 | required: true | ||
| 351 | type: string | ||
| 352 | description: 'The user id ' | ||
| 353 | responses: | 277 | responses: |
| 354 | '200': | 278 | '200': |
| 355 | description: successful operation | 279 | description: successful operation |
| @@ -365,11 +289,7 @@ paths: | |||
| 365 | produces: | 289 | produces: |
| 366 | - application/json | 290 | - application/json |
| 367 | parameters: | 291 | parameters: |
| 368 | - name: id | 292 | - $ref: "users.yaml#/parameters/id" |
| 369 | in: path | ||
| 370 | required: true | ||
| 371 | type: string | ||
| 372 | description: 'The user id ' | ||
| 373 | - in: body | 293 | - in: body |
| 374 | name: body | 294 | name: body |
| 375 | required: true | 295 | required: true |
| @@ -377,7 +297,7 @@ paths: | |||
| 377 | $ref: '#/definitions/UpdateUser' | 297 | $ref: '#/definitions/UpdateUser' |
| 378 | responses: | 298 | responses: |
| 379 | '204': | 299 | '204': |
| 380 | description: successful operation | 300 | $ref: "commons.yaml#/responses/emptySuccess" |
| 381 | /users/me: | 301 | /users/me: |
| 382 | get: | 302 | get: |
| 383 | security: | 303 | security: |
| @@ -412,7 +332,7 @@ paths: | |||
| 412 | $ref: '#/definitions/UpdateMe' | 332 | $ref: '#/definitions/UpdateMe' |
| 413 | responses: | 333 | responses: |
| 414 | '204': | 334 | '204': |
| 415 | description: successful operation | 335 | $ref: "commons.yaml#/responses/emptySuccess" |
| 416 | /users/me/video-quota-used: | 336 | /users/me/video-quota-used: |
| 417 | get: | 337 | get: |
| 418 | security: | 338 | security: |
| @@ -461,21 +381,9 @@ paths: | |||
| 461 | produces: | 381 | produces: |
| 462 | - application/json | 382 | - application/json |
| 463 | parameters: | 383 | parameters: |
| 464 | - name: start | 384 | - $ref: "commons.yaml#/parameters/start" |
| 465 | in: query | 385 | - $ref: "commons.yaml#/parameters/count" |
| 466 | required: false | 386 | - $ref: "commons.yaml#/parameters/sort" |
| 467 | type: number | ||
| 468 | description: 'starting page' | ||
| 469 | - name: stop | ||
| 470 | in: query | ||
| 471 | required: false | ||
| 472 | type: number | ||
| 473 | description: 'stopping page' | ||
| 474 | - name: sort | ||
| 475 | in: query | ||
| 476 | required: false | ||
| 477 | type: number | ||
| 478 | description: 'sorting' | ||
| 479 | responses: | 387 | responses: |
| 480 | '200': | 388 | '200': |
| 481 | description: successful operation | 389 | description: successful operation |
| @@ -499,7 +407,7 @@ paths: | |||
| 499 | $ref: '#/definitions/RegisterUser' | 407 | $ref: '#/definitions/RegisterUser' |
| 500 | responses: | 408 | responses: |
| 501 | '204': | 409 | '204': |
| 502 | description: successful operation | 410 | $ref: "commons.yaml#/responses/emptySuccess" |
| 503 | /users/me/avatar/pick: | 411 | /users/me/avatar/pick: |
| 504 | post: | 412 | post: |
| 505 | security: | 413 | security: |
| @@ -534,21 +442,9 @@ paths: | |||
| 534 | required: false | 442 | required: false |
| 535 | type: number | 443 | type: number |
| 536 | description: category id of the video | 444 | description: category id of the video |
| 537 | - name: start | 445 | - $ref: "commons.yaml#/parameters/start" |
| 538 | in: query | 446 | - $ref: "commons.yaml#/parameters/count" |
| 539 | required: false | 447 | - $ref: "commons.yaml#/parameters/sort" |
| 540 | type: number | ||
| 541 | description: 'starting page' | ||
| 542 | - name: stop | ||
| 543 | in: query | ||
| 544 | required: false | ||
| 545 | type: number | ||
| 546 | description: 'stopping page' | ||
| 547 | - name: sort | ||
| 548 | in: query | ||
| 549 | required: false | ||
| 550 | type: number | ||
| 551 | description: 'sorting' | ||
| 552 | responses: | 448 | responses: |
| 553 | '200': | 449 | '200': |
| 554 | description: successful operation | 450 | description: successful operation |
| @@ -625,21 +521,9 @@ paths: | |||
| 625 | produces: | 521 | produces: |
| 626 | - application/json | 522 | - application/json |
| 627 | parameters: | 523 | parameters: |
| 628 | - name: start | 524 | - $ref: "commons.yaml#/parameters/start" |
| 629 | in: query | 525 | - $ref: "commons.yaml#/parameters/count" |
| 630 | required: false | 526 | - $ref: "commons.yaml#/parameters/sort" |
| 631 | type: number | ||
| 632 | description: 'starting page' | ||
| 633 | - name: stop | ||
| 634 | in: query | ||
| 635 | required: false | ||
| 636 | type: number | ||
| 637 | description: 'stopping page' | ||
| 638 | - name: sort | ||
| 639 | in: query | ||
| 640 | required: false | ||
| 641 | type: number | ||
| 642 | description: 'sorting' | ||
| 643 | responses: | 527 | responses: |
| 644 | '200': | 528 | '200': |
| 645 | description: successful operation | 529 | description: successful operation |
| @@ -658,70 +542,21 @@ paths: | |||
| 658 | produces: | 542 | produces: |
| 659 | - application/json | 543 | - application/json |
| 660 | parameters: | 544 | parameters: |
| 661 | - name: id | 545 | - $ref: "videos.yaml#/parameters/id" |
| 662 | in: path | 546 | - $ref: "videos.yaml#/parameters/thumbnailfile" |
| 663 | required: true | 547 | - $ref: "videos.yaml#/parameters/previewfile" |
| 664 | type: string | 548 | - $ref: "videos.yaml#/parameters/category" |
| 665 | description: 'The video id' | 549 | - $ref: "videos.yaml#/parameters/licence" |
| 666 | - name: thumbnailfile | 550 | - $ref: "videos.yaml#/parameters/language" |
| 667 | in: formData | 551 | - $ref: "videos.yaml#/parameters/description" |
| 668 | type: file | 552 | - $ref: "videos.yaml#/parameters/waitTranscoding" |
| 669 | description: 'Video thumbnail file' | 553 | - $ref: "videos.yaml#/parameters/support" |
| 670 | - name: previewfile | 554 | - $ref: "videos.yaml#/parameters/nsfw" |
| 671 | in: formData | 555 | - $ref: "videos.yaml#/parameters/name" |
| 672 | type: file | 556 | - $ref: "videos.yaml#/parameters/tags" |
| 673 | description: 'Video preview file' | 557 | - $ref: "videos.yaml#/parameters/commentsEnabled" |
| 674 | - name: category | 558 | - $ref: "videos.yaml#/parameters/privacy" |
| 675 | in: formData | 559 | - $ref: "videos.yaml#/parameters/scheduleUpdate" |
| 676 | type: number | ||
| 677 | description: 'Video category' | ||
| 678 | - name: licence | ||
| 679 | in: formData | ||
| 680 | type: number | ||
| 681 | description: 'Video licence' | ||
| 682 | - name: language | ||
| 683 | in: formData | ||
| 684 | type: string | ||
| 685 | description: 'Video language' | ||
| 686 | - name: description | ||
| 687 | in: formData | ||
| 688 | type: string | ||
| 689 | description: 'Video description' | ||
| 690 | - name: waitTranscoding | ||
| 691 | in: formData | ||
| 692 | type: boolean | ||
| 693 | description: 'Whether or not we wait transcoding before publish the video' | ||
| 694 | - name: support | ||
| 695 | in: formData | ||
| 696 | type: string | ||
| 697 | description: 'Text describing how to support the video uploader' | ||
| 698 | - name: nsfw | ||
| 699 | in: formData | ||
| 700 | type: boolean | ||
| 701 | description: 'Whether or not this video contains sensitive content' | ||
| 702 | - name: name | ||
| 703 | in: formData | ||
| 704 | type: string | ||
| 705 | description: 'Video name' | ||
| 706 | - name: tags | ||
| 707 | in: formData | ||
| 708 | type: string[] | ||
| 709 | description: 'Video tags' | ||
| 710 | - name: commentsEnabled | ||
| 711 | in: formData | ||
| 712 | type: boolean | ||
| 713 | description: 'Enable or disable comments for this video' | ||
| 714 | - name: privacy | ||
| 715 | in: formData | ||
| 716 | type: string | ||
| 717 | enum: [Public, Unlisted] | ||
| 718 | description: 'Video privacy' | ||
| 719 | - name: scheduleUpdate | ||
| 720 | in: formData | ||
| 721 | required: false | ||
| 722 | description: 'Schedule an update at a specific datetime' | ||
| 723 | type: | ||
| 724 | $ref: '#/definitions/ScheduleVideoUpdate' | ||
| 725 | responses: | 560 | responses: |
| 726 | '200': | 561 | '200': |
| 727 | description: successful operation | 562 | description: successful operation |
| @@ -735,11 +570,7 @@ paths: | |||
| 735 | produces: | 570 | produces: |
| 736 | - application/json | 571 | - application/json |
| 737 | parameters: | 572 | parameters: |
| 738 | - name: id | 573 | - $ref: "videos.yaml#/parameters/id" |
| 739 | in: path | ||
| 740 | required: true | ||
| 741 | type: string | ||
| 742 | description: 'The video id ' | ||
| 743 | responses: | 574 | responses: |
| 744 | '200': | 575 | '200': |
| 745 | description: successful operation | 576 | description: successful operation |
| @@ -755,14 +586,10 @@ paths: | |||
| 755 | produces: | 586 | produces: |
| 756 | - application/json | 587 | - application/json |
| 757 | parameters: | 588 | parameters: |
| 758 | - name: id | 589 | - $ref: "videos.yaml#/parameters/id" |
| 759 | in: path | ||
| 760 | required: true | ||
| 761 | type: string | ||
| 762 | description: 'The video id ' | ||
| 763 | responses: | 590 | responses: |
| 764 | '204': | 591 | '204': |
| 765 | description: successful operation | 592 | $ref: "commons.yaml#/responses/emptySuccess" |
| 766 | "/videos/{id}/description": | 593 | "/videos/{id}/description": |
| 767 | get: | 594 | get: |
| 768 | tags: | 595 | tags: |
| @@ -772,11 +599,7 @@ paths: | |||
| 772 | produces: | 599 | produces: |
| 773 | - application/json | 600 | - application/json |
| 774 | parameters: | 601 | parameters: |
| 775 | - name: id | 602 | - $ref: "videos.yaml#/parameters/id" |
| 776 | in: path | ||
| 777 | required: true | ||
| 778 | type: string | ||
| 779 | description: 'The video id ' | ||
| 780 | responses: | 603 | responses: |
| 781 | '200': | 604 | '200': |
| 782 | description: successful operation | 605 | description: successful operation |
| @@ -791,14 +614,10 @@ paths: | |||
| 791 | produces: | 614 | produces: |
| 792 | - application/json | 615 | - application/json |
| 793 | parameters: | 616 | parameters: |
| 794 | - name: id | 617 | - $ref: "videos.yaml#/parameters/id" |
| 795 | in: path | ||
| 796 | required: true | ||
| 797 | type: string | ||
| 798 | description: 'The video id ' | ||
| 799 | responses: | 618 | responses: |
| 800 | '204': | 619 | '204': |
| 801 | description: successful operation | 620 | $ref: "commons.yaml#/responses/emptySuccess" |
| 802 | /videos/upload: | 621 | /videos/upload: |
| 803 | post: | 622 | post: |
| 804 | security: | 623 | security: |
| @@ -815,75 +634,25 @@ paths: | |||
| 815 | type: file | 634 | type: file |
| 816 | required: true | 635 | required: true |
| 817 | description: 'Video file' | 636 | description: 'Video file' |
| 818 | - name: thumbnailfile | ||
| 819 | in: formData | ||
| 820 | type: file | ||
| 821 | required: true | ||
| 822 | description: 'Video thumbnail file' | ||
| 823 | - name: previewfile | ||
| 824 | in: formData | ||
| 825 | type: file | ||
| 826 | required: true | ||
| 827 | description: 'Video preview file' | ||
| 828 | - name: category | ||
| 829 | in: formData | ||
| 830 | type: number | ||
| 831 | description: 'Video category' | ||
| 832 | - name: waitTranscoding | ||
| 833 | in: formData | ||
| 834 | type: boolean | ||
| 835 | description: 'Whether or not we wait transcoding before publish the video' | ||
| 836 | - name: licence | ||
| 837 | in: formData | ||
| 838 | type: number | ||
| 839 | description: 'Video licence' | ||
| 840 | - name: language | ||
| 841 | in: formData | ||
| 842 | type: string | ||
| 843 | description: 'Video language' | ||
| 844 | - name: description | ||
| 845 | in: formData | ||
| 846 | type: string | ||
| 847 | description: 'Video description' | ||
| 848 | - name: support | ||
| 849 | in: formData | ||
| 850 | type: string | ||
| 851 | description: 'Text describing how to support the video uploader' | ||
| 852 | - name: channelId | 637 | - name: channelId |
| 853 | in: formData | 638 | in: formData |
| 854 | required: true | 639 | required: true |
| 855 | type: number | 640 | type: number |
| 856 | description: 'Channel id that will contain this video' | 641 | description: 'Channel id that will contain this video' |
| 857 | - name: nsfw | 642 | - $ref: "videos.yaml#/parameters/thumbnailfile" |
| 858 | in: formData | 643 | - $ref: "videos.yaml#/parameters/previewfile" |
| 859 | required: true | 644 | - $ref: "videos.yaml#/parameters/category" |
| 860 | type: boolean | 645 | - $ref: "videos.yaml#/parameters/licence" |
| 861 | description: 'Whether or not this video contains sensitive content' | 646 | - $ref: "videos.yaml#/parameters/language" |
| 862 | - name: name | 647 | - $ref: "videos.yaml#/parameters/description" |
| 863 | in: formData | 648 | - $ref: "videos.yaml#/parameters/waitTranscoding" |
| 864 | required: true | 649 | - $ref: "videos.yaml#/parameters/support" |
| 865 | type: string | 650 | - $ref: "videos.yaml#/parameters/nsfw" |
| 866 | description: 'Video name' | 651 | - $ref: "videos.yaml#/parameters/name" |
| 867 | - name: tags | 652 | - $ref: "videos.yaml#/parameters/tags" |
| 868 | in: formData | 653 | - $ref: "videos.yaml#/parameters/commentsEnabled" |
| 869 | type: string[] | 654 | - $ref: "videos.yaml#/parameters/privacy" |
| 870 | description: 'Video tags' | 655 | - $ref: "videos.yaml#/parameters/scheduleUpdate" |
| 871 | - name: commentsEnabled | ||
| 872 | in: formData | ||
| 873 | type: boolean | ||
| 874 | description: 'Enable or disable comments for this video' | ||
| 875 | - name: privacy | ||
| 876 | in: formData | ||
| 877 | required: true | ||
| 878 | type: | ||
| 879 | $ref: '#/definitions/VideoPrivacy' | ||
| 880 | description: 'Video privacy' | ||
| 881 | - name: scheduleUpdate | ||
| 882 | in: formData | ||
| 883 | required: false | ||
| 884 | description: 'Schedule an update at a specific datetime' | ||
| 885 | type: | ||
| 886 | $ref: '#/definitions/ScheduleVideoUpdate' | ||
| 887 | responses: | 656 | responses: |
| 888 | '200': | 657 | '200': |
| 889 | description: successful operation | 658 | description: successful operation |
| @@ -900,21 +669,9 @@ paths: | |||
| 900 | produces: | 669 | produces: |
| 901 | - application/json | 670 | - application/json |
| 902 | parameters: | 671 | parameters: |
| 903 | - name: start | 672 | - $ref: "commons.yaml#/parameters/start" |
| 904 | in: query | 673 | - $ref: "commons.yaml#/parameters/count" |
| 905 | required: false | 674 | - $ref: "commons.yaml#/parameters/sort" |
| 906 | type: number | ||
| 907 | description: 'starting page' | ||
| 908 | - name: stop | ||
| 909 | in: query | ||
| 910 | required: false | ||
| 911 | type: number | ||
| 912 | description: 'stopping page' | ||
| 913 | - name: sort | ||
| 914 | in: query | ||
| 915 | required: false | ||
| 916 | type: number | ||
| 917 | description: 'sorting' | ||
| 918 | responses: | 675 | responses: |
| 919 | '200': | 676 | '200': |
| 920 | description: successful operation | 677 | description: successful operation |
| @@ -933,15 +690,11 @@ paths: | |||
| 933 | produces: | 690 | produces: |
| 934 | - application/json | 691 | - application/json |
| 935 | parameters: | 692 | parameters: |
| 936 | - name: id | 693 | - $ref: "videos.yaml#/parameters/id" |
| 937 | in: path | ||
| 938 | required: true | ||
| 939 | type: string | ||
| 940 | description: 'The video id ' | ||
| 941 | responses: | 694 | responses: |
| 942 | '204': | 695 | '204': |
| 943 | description: successful operation | 696 | $ref: "commons.yaml#/responses/emptySuccess" |
| 944 | "/videos/{videoId}/blacklist": | 697 | "/videos/{id}/blacklist": |
| 945 | post: | 698 | post: |
| 946 | security: | 699 | security: |
| 947 | - OAuth2: [ ] | 700 | - OAuth2: [ ] |
| @@ -952,14 +705,10 @@ paths: | |||
| 952 | produces: | 705 | produces: |
| 953 | - application/json | 706 | - application/json |
| 954 | parameters: | 707 | parameters: |
| 955 | - name: videoId | 708 | - $ref: "videos.yaml#/parameters/id" |
| 956 | in: path | ||
| 957 | required: true | ||
| 958 | type: string | ||
| 959 | description: 'The video id ' | ||
| 960 | responses: | 709 | responses: |
| 961 | '204': | 710 | '204': |
| 962 | description: successful operation | 711 | $ref: "commons.yaml#/responses/emptySuccess" |
| 963 | delete: | 712 | delete: |
| 964 | security: | 713 | security: |
| 965 | - OAuth2: [ ] | 714 | - OAuth2: [ ] |
| @@ -970,14 +719,10 @@ paths: | |||
| 970 | produces: | 719 | produces: |
| 971 | - application/json | 720 | - application/json |
| 972 | parameters: | 721 | parameters: |
| 973 | - name: videoId | 722 | - $ref: "videos.yaml#/parameters/id" |
| 974 | in: path | ||
| 975 | required: true | ||
| 976 | type: string | ||
| 977 | description: 'The video id ' | ||
| 978 | responses: | 723 | responses: |
| 979 | '204': | 724 | '204': |
| 980 | description: successful operation | 725 | $ref: "commons.yaml#/responses/emptySuccess" |
| 981 | /videos/blacklist: | 726 | /videos/blacklist: |
| 982 | get: | 727 | get: |
| 983 | security: | 728 | security: |
| @@ -989,21 +734,9 @@ paths: | |||
| 989 | produces: | 734 | produces: |
| 990 | - application/json | 735 | - application/json |
| 991 | parameters: | 736 | parameters: |
| 992 | - name: start | 737 | - $ref: "commons.yaml#/parameters/start" |
| 993 | in: query | 738 | - $ref: "commons.yaml#/parameters/count" |
| 994 | required: false | 739 | - $ref: "commons.yaml#/parameters/sort" |
| 995 | type: number | ||
| 996 | description: 'starting page' | ||
| 997 | - name: stop | ||
| 998 | in: query | ||
| 999 | required: false | ||
| 1000 | type: number | ||
| 1001 | description: 'stopping page' | ||
| 1002 | - name: sort | ||
| 1003 | in: query | ||
| 1004 | required: false | ||
| 1005 | type: number | ||
| 1006 | description: 'sorting' | ||
| 1007 | responses: | 740 | responses: |
| 1008 | '200': | 741 | '200': |
| 1009 | description: successful operation | 742 | description: successful operation |
| @@ -1020,21 +753,9 @@ paths: | |||
| 1020 | produces: | 753 | produces: |
| 1021 | - application/json | 754 | - application/json |
| 1022 | parameters: | 755 | parameters: |
| 1023 | - name: start | 756 | - $ref: "commons.yaml#/parameters/start" |
| 1024 | in: query | 757 | - $ref: "commons.yaml#/parameters/count" |
| 1025 | required: false | 758 | - $ref: "commons.yaml#/parameters/sort" |
| 1026 | type: number | ||
| 1027 | description: 'starting page' | ||
| 1028 | - name: stop | ||
| 1029 | in: query | ||
| 1030 | required: false | ||
| 1031 | type: number | ||
| 1032 | description: 'stopping page' | ||
| 1033 | - name: sort | ||
| 1034 | in: query | ||
| 1035 | required: false | ||
| 1036 | type: number | ||
| 1037 | description: 'sorting' | ||
| 1038 | responses: | 759 | responses: |
| 1039 | '200': | 760 | '200': |
| 1040 | description: successful operation | 761 | description: successful operation |
| @@ -1058,7 +779,7 @@ paths: | |||
| 1058 | $ref: '#/definitions/VideoChannelInput' | 779 | $ref: '#/definitions/VideoChannelInput' |
| 1059 | responses: | 780 | responses: |
| 1060 | '204': | 781 | '204': |
| 1061 | description: successful operation | 782 | $ref: "commons.yaml#/responses/emptySuccess" |
| 1062 | "/video-channels/{id}": | 783 | "/video-channels/{id}": |
| 1063 | get: | 784 | get: |
| 1064 | tags: | 785 | tags: |
| @@ -1068,11 +789,7 @@ paths: | |||
| 1068 | produces: | 789 | produces: |
| 1069 | - application/json | 790 | - application/json |
| 1070 | parameters: | 791 | parameters: |
| 1071 | - name: id | 792 | - $ref: "video-channels.yaml#/parameters/id" |
| 1072 | in: path | ||
| 1073 | required: true | ||
| 1074 | type: string | ||
| 1075 | description: 'The video channel id ' | ||
| 1076 | responses: | 793 | responses: |
| 1077 | '200': | 794 | '200': |
| 1078 | description: successful operation | 795 | description: successful operation |
| @@ -1088,18 +805,14 @@ paths: | |||
| 1088 | produces: | 805 | produces: |
| 1089 | - application/json | 806 | - application/json |
| 1090 | parameters: | 807 | parameters: |
| 1091 | - name: id | 808 | - $ref: "video-channels.yaml#/parameters/id" |
| 1092 | in: path | ||
| 1093 | required: true | ||
| 1094 | type: string | ||
| 1095 | description: 'The video channel id ' | ||
| 1096 | - in: body | 809 | - in: body |
| 1097 | name: body | 810 | name: body |
| 1098 | schema: | 811 | schema: |
| 1099 | $ref: '#/definitions/VideoChannelInput' | 812 | $ref: '#/definitions/VideoChannelInput' |
| 1100 | responses: | 813 | responses: |
| 1101 | '204': | 814 | '204': |
| 1102 | description: successful operation | 815 | $ref: "commons.yaml#/responses/emptySuccess" |
| 1103 | delete: | 816 | delete: |
| 1104 | security: | 817 | security: |
| 1105 | - OAuth2: [ ] | 818 | - OAuth2: [ ] |
| @@ -1110,14 +823,10 @@ paths: | |||
| 1110 | produces: | 823 | produces: |
| 1111 | - application/json | 824 | - application/json |
| 1112 | parameters: | 825 | parameters: |
| 1113 | - name: id | 826 | - $ref: "video-channels.yaml#/parameters/id" |
| 1114 | in: path | ||
| 1115 | required: true | ||
| 1116 | type: string | ||
| 1117 | description: 'The video channel id ' | ||
| 1118 | responses: | 827 | responses: |
| 1119 | '204': | 828 | '204': |
| 1120 | description: successful operation | 829 | $ref: "commons.yaml#/responses/emptySuccess" |
| 1121 | "/video-channels/{id}/videos": | 830 | "/video-channels/{id}/videos": |
| 1122 | get: | 831 | get: |
| 1123 | tags: | 832 | tags: |
| @@ -1127,11 +836,7 @@ paths: | |||
| 1127 | produces: | 836 | produces: |
| 1128 | - application/json | 837 | - application/json |
| 1129 | parameters: | 838 | parameters: |
| 1130 | - name: id | 839 | - $ref: "video-channels.yaml#/parameters/id" |
| 1131 | in: path | ||
| 1132 | required: true | ||
| 1133 | type: string | ||
| 1134 | description: 'The video channel id ' | ||
| 1135 | responses: | 840 | responses: |
| 1136 | '200': | 841 | '200': |
| 1137 | description: successful operation | 842 | description: successful operation |
| @@ -1146,11 +851,7 @@ paths: | |||
| 1146 | produces: | 851 | produces: |
| 1147 | - application/json | 852 | - application/json |
| 1148 | parameters: | 853 | parameters: |
| 1149 | - name: name | 854 | - $ref: "accounts.yaml#/parameters/name" |
| 1150 | in: path | ||
| 1151 | required: true | ||
| 1152 | type: string | ||
| 1153 | description: 'The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for example)' | ||
| 1154 | responses: | 855 | responses: |
| 1155 | '200': | 856 | '200': |
| 1156 | description: successful operation | 857 | description: successful operation |
| @@ -1158,7 +859,7 @@ paths: | |||
| 1158 | type: array | 859 | type: array |
| 1159 | items: | 860 | items: |
| 1160 | $ref: '#/definitions/VideoChannel' | 861 | $ref: '#/definitions/VideoChannel' |
| 1161 | "/videos/{videoId}/comment-threads": | 862 | "/videos/{id}/comment-threads": |
| 1162 | get: | 863 | get: |
| 1163 | tags: | 864 | tags: |
| 1164 | - VideoComment | 865 | - VideoComment |
| @@ -1167,26 +868,10 @@ paths: | |||
| 1167 | produces: | 868 | produces: |
| 1168 | - application/json | 869 | - application/json |
| 1169 | parameters: | 870 | parameters: |
| 1170 | - name: videoId | 871 | - $ref: "videos.yaml#/parameters/id" |
| 1171 | in: path | 872 | - $ref: "commons.yaml#/parameters/start" |
| 1172 | required: true | 873 | - $ref: "commons.yaml#/parameters/count" |
| 1173 | type: string | 874 | - $ref: "commons.yaml#/parameters/sort" |
| 1174 | description: 'The video id ' | ||
| 1175 | - name: start | ||
| 1176 | in: query | ||
| 1177 | required: false | ||
| 1178 | type: number | ||
| 1179 | description: 'starting page' | ||
| 1180 | - name: stop | ||
| 1181 | in: query | ||
| 1182 | required: false | ||
| 1183 | type: number | ||
| 1184 | description: 'stopping page' | ||
| 1185 | - name: sort | ||
| 1186 | in: query | ||
| 1187 | required: false | ||
| 1188 | type: number | ||
| 1189 | description: 'sorting' | ||
| 1190 | responses: | 875 | responses: |
| 1191 | '200': | 876 | '200': |
| 1192 | description: successful operation | 877 | description: successful operation |
| @@ -1202,17 +887,13 @@ paths: | |||
| 1202 | produces: | 887 | produces: |
| 1203 | - application/json | 888 | - application/json |
| 1204 | parameters: | 889 | parameters: |
| 1205 | - name: videoId | 890 | - $ref: "videos.yaml#/parameters/id" |
| 1206 | in: path | ||
| 1207 | required: true | ||
| 1208 | type: string | ||
| 1209 | description: 'The video id ' | ||
| 1210 | responses: | 891 | responses: |
| 1211 | '200': | 892 | '200': |
| 1212 | description: successful operation | 893 | description: successful operation |
| 1213 | schema: | 894 | schema: |
| 1214 | $ref: '#/definitions/CommentThreadPostResponse' | 895 | $ref: '#/definitions/CommentThreadPostResponse' |
| 1215 | "/videos/{videoId}/comment-threads/{threadId}": | 896 | "/videos/{id}/comment-threads/{threadId}": |
| 1216 | get: | 897 | get: |
| 1217 | tags: | 898 | tags: |
| 1218 | - VideoComment | 899 | - VideoComment |
| @@ -1221,22 +902,14 @@ paths: | |||
| 1221 | produces: | 902 | produces: |
| 1222 | - application/json | 903 | - application/json |
| 1223 | parameters: | 904 | parameters: |
| 1224 | - name: videoId | 905 | - $ref: "videos.yaml#/parameters/id" |
| 1225 | in: path | 906 | - $ref: "video-comments.yaml#/parameters/threadId" |
| 1226 | required: true | ||
| 1227 | type: string | ||
| 1228 | description: 'The video id ' | ||
| 1229 | - name: threadId | ||
| 1230 | in: path | ||
| 1231 | required: true | ||
| 1232 | type: string | ||
| 1233 | description: 'The thread id ' | ||
| 1234 | responses: | 907 | responses: |
| 1235 | '200': | 908 | '200': |
| 1236 | description: successful operation | 909 | description: successful operation |
| 1237 | schema: | 910 | schema: |
| 1238 | $ref: '#/definitions/VideoCommentThreadTree' | 911 | $ref: '#/definitions/VideoCommentThreadTree' |
| 1239 | "/videos/{videoId}/comments/{commentId}": | 912 | "/videos/{id}/comments/{commentId}": |
| 1240 | post: | 913 | post: |
| 1241 | security: | 914 | security: |
| 1242 | - OAuth2: [ ] | 915 | - OAuth2: [ ] |
| @@ -1247,16 +920,8 @@ paths: | |||
| 1247 | produces: | 920 | produces: |
| 1248 | - application/json | 921 | - application/json |
| 1249 | parameters: | 922 | parameters: |
| 1250 | - name: videoId | 923 | - $ref: "videos.yaml#/parameters/id" |
| 1251 | in: path | 924 | - $ref: "video-comments.yaml#/parameters/commentId" |
| 1252 | required: true | ||
| 1253 | type: string | ||
| 1254 | description: 'The video id ' | ||
| 1255 | - name: commentId | ||
| 1256 | in: path | ||
| 1257 | required: true | ||
| 1258 | type: string | ||
| 1259 | description: 'The comment id ' | ||
| 1260 | responses: | 925 | responses: |
| 1261 | '200': | 926 | '200': |
| 1262 | description: successful operation | 927 | description: successful operation |
| @@ -1272,19 +937,11 @@ paths: | |||
| 1272 | produces: | 937 | produces: |
| 1273 | - application/json | 938 | - application/json |
| 1274 | parameters: | 939 | parameters: |
| 1275 | - name: videoId | 940 | - $ref: "videos.yaml#/parameters/id" |
| 1276 | in: path | 941 | - $ref: "video-comments.yaml#/parameters/commentId" |
| 1277 | required: true | ||
| 1278 | type: string | ||
| 1279 | description: 'The video id ' | ||
| 1280 | - name: commentId | ||
| 1281 | in: path | ||
| 1282 | required: true | ||
| 1283 | type: string | ||
| 1284 | description: 'The comment id ' | ||
| 1285 | responses: | 942 | responses: |
| 1286 | '204': | 943 | '204': |
| 1287 | description: successful operation | 944 | $ref: "commons.yaml#/responses/emptySuccess" |
| 1288 | "/videos/{id}/rate": | 945 | "/videos/{id}/rate": |
| 1289 | put: | 946 | put: |
| 1290 | security: | 947 | security: |
| @@ -1296,14 +953,10 @@ paths: | |||
| 1296 | produces: | 953 | produces: |
| 1297 | - application/json | 954 | - application/json |
| 1298 | parameters: | 955 | parameters: |
| 1299 | - name: id | 956 | - $ref: "videos.yaml#/parameters/id" |
| 1300 | in: path | ||
| 1301 | required: true | ||
| 1302 | type: string | ||
| 1303 | description: 'The video id ' | ||
| 1304 | responses: | 957 | responses: |
| 1305 | '204': | 958 | '204': |
| 1306 | description: successful operation | 959 | $ref: "commons.yaml#/responses/emptySuccess" |
| 1307 | definitions: | 960 | definitions: |
| 1308 | VideoConstantNumber: | 961 | VideoConstantNumber: |
| 1309 | properties: | 962 | properties: |
| @@ -1725,13 +1378,4 @@ definitions: | |||
| 1725 | name: | 1378 | name: |
| 1726 | type: string | 1379 | type: string |
| 1727 | description: | 1380 | description: |
| 1728 | type: string | 1381 | type: string \ No newline at end of file |
| 1729 | ScheduleVideoUpdate: | ||
| 1730 | properties: | ||
| 1731 | updateAt: | ||
| 1732 | type: dateTime | ||
| 1733 | description: 'When to update the video' | ||
| 1734 | required: true | ||
| 1735 | privacy: | ||
| 1736 | $ref: '#/definitions/VideoPrivacy' | ||
| 1737 | required: false \ No newline at end of file | ||