diff options
Diffstat (limited to 'support/doc/api')
-rw-r--r-- | support/doc/api/openapi.yaml | 102 |
1 files changed, 83 insertions, 19 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 5074f05db..454b8cde6 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -1760,6 +1760,44 @@ paths: | |||
1760 | '204': | 1760 | '204': |
1761 | description: successful operation | 1761 | description: successful operation |
1762 | 1762 | ||
1763 | '/users/me/video-playlists/videos-exist': | ||
1764 | get: | ||
1765 | summary: 'Check video exists in my playlists' | ||
1766 | security: | ||
1767 | - OAuth2: [] | ||
1768 | tags: | ||
1769 | - Video Playlists | ||
1770 | parameters: | ||
1771 | - name: videoIds | ||
1772 | in: query | ||
1773 | required: true | ||
1774 | description: The video ids to check | ||
1775 | schema: | ||
1776 | type: array | ||
1777 | items: | ||
1778 | type: number | ||
1779 | responses: | ||
1780 | '200': | ||
1781 | description: successful operation | ||
1782 | content: | ||
1783 | application/json: | ||
1784 | schema: | ||
1785 | type: object | ||
1786 | properties: | ||
1787 | videoId: | ||
1788 | type: array | ||
1789 | items: | ||
1790 | type: object | ||
1791 | properties: | ||
1792 | playlistElementId: | ||
1793 | type: number | ||
1794 | playlistId: | ||
1795 | type: number | ||
1796 | startTimestamp: | ||
1797 | type: number | ||
1798 | stopTimestamp: | ||
1799 | type: number | ||
1800 | |||
1763 | '/accounts/{name}/video-channels': | 1801 | '/accounts/{name}/video-channels': |
1764 | get: | 1802 | get: |
1765 | summary: List video channels of an account | 1803 | summary: List video channels of an account |
@@ -2316,6 +2354,21 @@ components: | |||
2316 | label: | 2354 | label: |
2317 | type: string | 2355 | type: string |
2318 | 2356 | ||
2357 | NSFWPolicy: | ||
2358 | type: string | ||
2359 | enum: | ||
2360 | - display | ||
2361 | - blur | ||
2362 | - do_not_list | ||
2363 | |||
2364 | UserRole: | ||
2365 | type: number | ||
2366 | enum: | ||
2367 | - 0 | ||
2368 | - 1 | ||
2369 | - 2 | ||
2370 | description: 'The user role (Admin = 0, Moderator = 1, User = 2)' | ||
2371 | |||
2319 | VideoStateConstant: | 2372 | VideoStateConstant: |
2320 | properties: | 2373 | properties: |
2321 | id: | 2374 | id: |
@@ -2756,17 +2809,20 @@ components: | |||
2756 | type: string | 2809 | type: string |
2757 | email: | 2810 | email: |
2758 | type: string | 2811 | type: string |
2759 | displayNSFW: | 2812 | theme: |
2813 | type: string | ||
2814 | description: 'Theme enabled by this user' | ||
2815 | emailVerified: | ||
2816 | type: boolean | ||
2817 | description: 'Is email verified?' | ||
2818 | nsfwPolicy: | ||
2819 | $ref: '#/components/schemas/NSFWPolicy' | ||
2820 | webtorrentEnabled: | ||
2760 | type: boolean | 2821 | type: boolean |
2761 | autoPlayVideo: | 2822 | autoPlayVideo: |
2762 | type: boolean | 2823 | type: boolean |
2763 | role: | 2824 | role: |
2764 | type: integer | 2825 | $ref: '#/components/schemas/UserRole' |
2765 | enum: | ||
2766 | - 0 | ||
2767 | - 1 | ||
2768 | - 2 | ||
2769 | description: 'The user role (Admin = 0, Moderator = 1, User = 2)' | ||
2770 | roleLabel: | 2826 | roleLabel: |
2771 | type: string | 2827 | type: string |
2772 | enum: | 2828 | enum: |
@@ -2777,6 +2833,24 @@ components: | |||
2777 | type: number | 2833 | type: number |
2778 | videoQuotaDaily: | 2834 | videoQuotaDaily: |
2779 | type: number | 2835 | type: number |
2836 | videosCount: | ||
2837 | type: number | ||
2838 | videoAbusesCount: | ||
2839 | type: number | ||
2840 | videoAbusesAcceptedCount: | ||
2841 | type: number | ||
2842 | videoAbusesCreatedCount: | ||
2843 | type: number | ||
2844 | videoCommentsCount: | ||
2845 | type: number | ||
2846 | noInstanceConfigWarningModal: | ||
2847 | type: boolean | ||
2848 | noWelcomeModal: | ||
2849 | type: boolean | ||
2850 | blocked: | ||
2851 | type: boolean | ||
2852 | blockedReason: | ||
2853 | type: string | ||
2780 | createdAt: | 2854 | createdAt: |
2781 | type: string | 2855 | type: string |
2782 | account: | 2856 | account: |
@@ -3242,12 +3316,7 @@ components: | |||
3242 | type: string | 3316 | type: string |
3243 | description: 'The user daily video quota ' | 3317 | description: 'The user daily video quota ' |
3244 | role: | 3318 | role: |
3245 | type: integer | 3319 | $ref: '#/components/schemas/UserRole' |
3246 | enum: | ||
3247 | - 0 | ||
3248 | - 1 | ||
3249 | - 2 | ||
3250 | description: 'The user role (Admin = 0, Moderator = 1, User = 2)' | ||
3251 | required: | 3320 | required: |
3252 | - username | 3321 | - username |
3253 | - password | 3322 | - password |
@@ -3270,12 +3339,7 @@ components: | |||
3270 | type: string | 3339 | type: string |
3271 | description: 'The updated daily video quota of the user ' | 3340 | description: 'The updated daily video quota of the user ' |
3272 | role: | 3341 | role: |
3273 | type: integer | 3342 | $ref: '#/components/schemas/UserRole' |
3274 | enum: | ||
3275 | - 0 | ||
3276 | - 1 | ||
3277 | - 2 | ||
3278 | description: 'The user role (Admin = 0, Moderator = 1, User = 2)' | ||
3279 | required: | 3343 | required: |
3280 | - id | 3344 | - id |
3281 | 3345 | ||