aboutsummaryrefslogtreecommitdiffhomepage
path: root/support
diff options
context:
space:
mode:
authorRigel Kent <sendmemail@rigelk.eu>2019-12-27 17:52:53 +0100
committerRigel Kent <sendmemail@rigelk.eu>2019-12-27 17:52:53 +0100
commit71810d0bcbed0e46ddaa1d4eadd028154786fffb (patch)
treef913fb98853cbad61bd493bff2fcc1b758b46431 /support
parent1053480b2561a35613551ea543d4d77bf8937b8c (diff)
downloadPeerTube-71810d0bcbed0e46ddaa1d4eadd028154786fffb.tar.gz
PeerTube-71810d0bcbed0e46ddaa1d4eadd028154786fffb.tar.zst
PeerTube-71810d0bcbed0e46ddaa1d4eadd028154786fffb.zip
Update OpenAPI documentation to include basic playlists and new comment sorting
Diffstat (limited to 'support')
-rw-r--r--support/doc/api/openapi.yaml81
1 files changed, 80 insertions, 1 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 032d798fc..5c5845f2b 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -76,6 +76,10 @@ tags:
76 description: > 76 description: >
77 Operations dealing with comments to a video. Comments are organized in 77 Operations dealing with comments to a video. Comments are organized in
78 threads. 78 threads.
79 - name: Video Playlist
80 description: >
81 Operations dealing with playlists of videos. Playlists are bound to users
82 and/or channels.
79 - name: Video Channel 83 - name: Video Channel
80 description: > 84 description: >
81 Operations dealing with creation, modification and video listing of a 85 Operations dealing with creation, modification and video listing of a
@@ -1390,6 +1394,24 @@ paths:
1390 application/json: 1394 application/json:
1391 schema: 1395 schema:
1392 $ref: '#/components/schemas/VideoListResponse' 1396 $ref: '#/components/schemas/VideoListResponse'
1397 /video-playlists:
1398 get:
1399 summary: Get list of video playlists
1400 tags:
1401 - Video Playlist
1402 parameters:
1403 - $ref: '#/components/parameters/start'
1404 - $ref: '#/components/parameters/count'
1405 - $ref: '#/components/parameters/sort'
1406 responses:
1407 '200':
1408 description: successful operation
1409 content:
1410 application/json:
1411 schema:
1412 type: array
1413 items:
1414 $ref: '#/components/schemas/VideoPlaylist'
1393 '/accounts/{name}/video-channels': 1415 '/accounts/{name}/video-channels':
1394 get: 1416 get:
1395 summary: Get video channels of an account by its name 1417 summary: Get video channels of an account by its name
@@ -1445,7 +1467,7 @@ paths:
1445 - $ref: '#/components/parameters/idOrUUID' 1467 - $ref: '#/components/parameters/idOrUUID'
1446 - $ref: '#/components/parameters/start' 1468 - $ref: '#/components/parameters/start'
1447 - $ref: '#/components/parameters/count' 1469 - $ref: '#/components/parameters/count'
1448 - $ref: '#/components/parameters/sort' 1470 - $ref: '#/components/parameters/commentsSort'
1449 responses: 1471 responses:
1450 '200': 1472 '200':
1451 description: successful operation 1473 description: successful operation
@@ -1606,6 +1628,16 @@ components:
1606 - -views 1628 - -views
1607 - -likes 1629 - -likes
1608 - -match 1630 - -match
1631 commentsSort:
1632 name: sort
1633 in: query
1634 required: false
1635 description: Sort comments by criteria
1636 schema:
1637 type: string
1638 enum:
1639 - -createdAt
1640 - -totalReplies
1609 blacklistsSort: 1641 blacklistsSort:
1610 name: sort 1642 name: sort
1611 in: query 1643 in: query
@@ -2160,6 +2192,53 @@ components:
2160 type: number 2192 type: number
2161 uuid: 2193 uuid:
2162 type: string 2194 type: string
2195 VideoPlaylist:
2196 properties:
2197 id:
2198 type: number
2199 createdAt:
2200 type: string
2201 updatedAt:
2202 type: string
2203 description:
2204 type: string
2205 uuid:
2206 type: string
2207 displayName:
2208 type: string
2209 isLocal:
2210 type: boolean
2211 videoLength:
2212 type: number
2213 thumbnailPath:
2214 type: string
2215 privacy:
2216 type: object
2217 properties:
2218 id:
2219 type: number
2220 label:
2221 type: string
2222 type:
2223 type: object
2224 properties:
2225 id:
2226 type: number
2227 label:
2228 type: string
2229 ownerAccount:
2230 type: object
2231 properties:
2232 id:
2233 type: number
2234 name:
2235 type: string
2236 displayName:
2237 type: string
2238 url:
2239 type: string
2240 host:
2241 type: string
2163 VideoComment: 2242 VideoComment:
2164 properties: 2243 properties:
2165 id: 2244 id: