aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api
diff options
context:
space:
mode:
authorWicklow <wicklow@framasoft.org>2023-02-23 15:39:09 +0100
committerChocobozzz <chocobozzz@cpy.re>2023-02-23 16:07:44 +0100
commit16ccb43767c45e74877ab7beaa4adb61a404c128 (patch)
treed61704e49131c6233cbc550b71f27212c1516db4 /support/doc/api
parent918ba713e4e8014d7b995e61df0ecada934c6361 (diff)
downloadPeerTube-16ccb43767c45e74877ab7beaa4adb61a404c128.tar.gz
PeerTube-16ccb43767c45e74877ab7beaa4adb61a404c128.tar.zst
PeerTube-16ccb43767c45e74877ab7beaa4adb61a404c128.zip
Fix filters on playlists
Diffstat (limited to 'support/doc/api')
-rw-r--r--support/doc/api/openapi.yaml67
1 files changed, 65 insertions, 2 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index fa50e8f17..d9e91c131 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -3801,6 +3801,34 @@ paths:
3801 schema: 3801 schema:
3802 $ref: '#/components/schemas/VideoListResponse' 3802 $ref: '#/components/schemas/VideoListResponse'
3803 3803
3804 '/api/v1/video-channels/{channelHandle}/video-playlists':
3805 get:
3806 summary: List playlists of a channel
3807 tags:
3808 - Video Playlists
3809 - Video Channels
3810 parameters:
3811 - $ref: '#/components/parameters/channelHandle'
3812 - $ref: '#/components/parameters/start'
3813 - $ref: '#/components/parameters/count'
3814 - $ref: '#/components/parameters/sort'
3815 - $ref: '#/components/parameters/videoPlaylistType'
3816 responses:
3817 '200':
3818 description: successful operation
3819 content:
3820 application/json:
3821 schema:
3822 type: object
3823 properties:
3824 total:
3825 type: integer
3826 example: 1
3827 data:
3828 type: array
3829 items:
3830 $ref: '#/components/schemas/VideoPlaylist'
3831
3804 '/api/v1/video-channels/{channelHandle}/followers': 3832 '/api/v1/video-channels/{channelHandle}/followers':
3805 get: 3833 get:
3806 tags: 3834 tags:
@@ -4045,6 +4073,7 @@ paths:
4045 - $ref: '#/components/parameters/start' 4073 - $ref: '#/components/parameters/start'
4046 - $ref: '#/components/parameters/count' 4074 - $ref: '#/components/parameters/count'
4047 - $ref: '#/components/parameters/sort' 4075 - $ref: '#/components/parameters/sort'
4076 - $ref: '#/components/parameters/videoPlaylistType'
4048 responses: 4077 responses:
4049 '200': 4078 '200':
4050 description: successful operation 4079 description: successful operation
@@ -4361,7 +4390,35 @@ paths:
4361 format: seconds 4390 format: seconds
4362 stopTimestamp: 4391 stopTimestamp:
4363 type: integer 4392 type: integer
4364 format: seconds 4393
4394 '/api/v1/accounts/{name}/video-playlists':
4395 get:
4396 summary: List playlists of an account
4397 tags:
4398 - Video Playlists
4399 - Accounts
4400 parameters:
4401 - $ref: '#/components/parameters/name'
4402 - $ref: '#/components/parameters/start'
4403 - $ref: '#/components/parameters/count'
4404 - $ref: '#/components/parameters/sort'
4405 - $ref: '#/components/parameters/search'
4406 - $ref: '#/components/parameters/videoPlaylistType'
4407 responses:
4408 '200':
4409 description: successful operation
4410 content:
4411 application/json:
4412 schema:
4413 type: object
4414 properties:
4415 total:
4416 type: integer
4417 example: 1
4418 data:
4419 type: array
4420 items:
4421 $ref: '#/components/schemas/VideoPlaylist'
4365 4422
4366 '/api/v1/accounts/{name}/video-channels': 4423 '/api/v1/accounts/{name}/video-channels':
4367 get: 4424 get:
@@ -5920,7 +5977,13 @@ components:
5920 description: Ask the server to reinject videoFileToken in URLs in m3u8 playlist 5977 description: Ask the server to reinject videoFileToken in URLs in m3u8 playlist
5921 schema: 5978 schema:
5922 type: boolean 5979 type: boolean
5923 5980 videoPlaylistType:
5981 name: playlistType
5982 in: query
5983 required: false
5984 schema:
5985 $ref: '#/components/schemas/VideoPlaylistTypeSet'
5986
5924 securitySchemes: 5987 securitySchemes:
5925 OAuth2: 5988 OAuth2:
5926 description: | 5989 description: |