diff options
Diffstat (limited to 'support/doc')
-rw-r--r-- | support/doc/api/openapi.yaml | 109 |
1 files changed, 105 insertions, 4 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 86c781f31..feab909dd 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -492,7 +492,8 @@ paths: | |||
492 | get: | 492 | get: |
493 | summary: Get current user information | 493 | summary: Get current user information |
494 | security: | 494 | security: |
495 | - OAuth2: [] | 495 | - OAuth2: |
496 | - user | ||
496 | tags: | 497 | tags: |
497 | - User | 498 | - User |
498 | responses: | 499 | responses: |
@@ -507,7 +508,8 @@ paths: | |||
507 | put: | 508 | put: |
508 | summary: Update current user information | 509 | summary: Update current user information |
509 | security: | 510 | security: |
510 | - OAuth2: [] | 511 | - OAuth2: |
512 | - user | ||
511 | tags: | 513 | tags: |
512 | - User | 514 | - User |
513 | responses: | 515 | responses: |
@@ -523,7 +525,8 @@ paths: | |||
523 | get: | 525 | get: |
524 | summary: Get current user used quota | 526 | summary: Get current user used quota |
525 | security: | 527 | security: |
526 | - OAuth2: [] | 528 | - OAuth2: |
529 | - user | ||
527 | tags: | 530 | tags: |
528 | - User | 531 | - User |
529 | responses: | 532 | responses: |
@@ -558,7 +561,71 @@ paths: | |||
558 | get: | 561 | get: |
559 | summary: Get videos of the current user | 562 | summary: Get videos of the current user |
560 | security: | 563 | security: |
561 | - OAuth2: [] | 564 | - OAuth2: |
565 | - user | ||
566 | tags: | ||
567 | - User | ||
568 | parameters: | ||
569 | - $ref: '#/components/parameters/start' | ||
570 | - $ref: '#/components/parameters/count' | ||
571 | - $ref: '#/components/parameters/sort' | ||
572 | responses: | ||
573 | '200': | ||
574 | description: successful operation | ||
575 | content: | ||
576 | application/json: | ||
577 | schema: | ||
578 | type: array | ||
579 | items: | ||
580 | $ref: '#/components/schemas/Video' | ||
581 | /users/me/subscriptions: | ||
582 | get: | ||
583 | summary: Get subscriptions of the current user | ||
584 | security: | ||
585 | - OAuth2: | ||
586 | - user | ||
587 | tags: | ||
588 | - User | ||
589 | parameters: | ||
590 | - $ref: '#/components/parameters/start' | ||
591 | - $ref: '#/components/parameters/count' | ||
592 | - $ref: '#/components/parameters/sort' | ||
593 | responses: | ||
594 | '200': | ||
595 | description: successful operation | ||
596 | post: | ||
597 | summary: Add subscription to the current user | ||
598 | security: | ||
599 | - OAuth2: | ||
600 | - user | ||
601 | tags: | ||
602 | - User | ||
603 | responses: | ||
604 | '200': | ||
605 | description: successful operation | ||
606 | /users/me/subscriptions/exist: | ||
607 | get: | ||
608 | summary: Get if subscriptions exist for the current user | ||
609 | security: | ||
610 | - OAuth2: | ||
611 | - user | ||
612 | tags: | ||
613 | - User | ||
614 | parameters: | ||
615 | - $ref: '#/components/parameters/subscriptionsUris' | ||
616 | responses: | ||
617 | '200': | ||
618 | description: successful operation | ||
619 | content: | ||
620 | application/json: | ||
621 | schema: | ||
622 | type: object | ||
623 | /users/me/subscriptions/videos: | ||
624 | get: | ||
625 | summary: Get videos of subscriptions of the current user | ||
626 | security: | ||
627 | - OAuth2: | ||
628 | - user | ||
562 | tags: | 629 | tags: |
563 | - User | 630 | - User |
564 | parameters: | 631 | parameters: |
@@ -574,6 +641,31 @@ paths: | |||
574 | type: array | 641 | type: array |
575 | items: | 642 | items: |
576 | $ref: '#/components/schemas/Video' | 643 | $ref: '#/components/schemas/Video' |
644 | '/users/me/subscriptions/{uri}': | ||
645 | get: | ||
646 | summary: Get subscription of the current user for a given uri | ||
647 | security: | ||
648 | - OAuth2: | ||
649 | - user | ||
650 | tags: | ||
651 | - User | ||
652 | responses: | ||
653 | '200': | ||
654 | description: successful operation | ||
655 | content: | ||
656 | application/json: | ||
657 | schema: | ||
658 | $ref: '#/components/schemas/VideoChannel' | ||
659 | delete: | ||
660 | summary: Delete subscription of the current user for a given uri | ||
661 | security: | ||
662 | - OAuth2: | ||
663 | - user | ||
664 | tags: | ||
665 | - User | ||
666 | responses: | ||
667 | '200': | ||
668 | description: successful operation | ||
577 | /users/register: | 669 | /users/register: |
578 | post: | 670 | post: |
579 | summary: Register a user | 671 | summary: Register a user |
@@ -1511,6 +1603,15 @@ components: | |||
1511 | enum: | 1603 | enum: |
1512 | - local | 1604 | - local |
1513 | - all-local | 1605 | - all-local |
1606 | subscriptionsUris: | ||
1607 | name: uris | ||
1608 | in: query | ||
1609 | required: true | ||
1610 | description: list of uris to check if each is part of the user subscriptions | ||
1611 | schema: | ||
1612 | type: array | ||
1613 | items: | ||
1614 | type: string | ||
1514 | requestBodies: | 1615 | requestBodies: |
1515 | VideoChannelInput: | 1616 | VideoChannelInput: |
1516 | content: | 1617 | content: |