aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2021-04-08 09:34:32 +0200
committerChocobozzz <chocobozzz@cpy.re>2021-04-08 10:07:53 +0200
commit75cba40de749fa8bf6cd767acbfaf478a6a8acbd (patch)
tree5829848e3bb788fe3eb571d9369098e22414eb54 /support/doc/api
parent02dd4f3c65536699cec47c7d4054889fd81b5cd4 (diff)
downloadPeerTube-75cba40de749fa8bf6cd767acbfaf478a6a8acbd.tar.gz
PeerTube-75cba40de749fa8bf6cd767acbfaf478a6a8acbd.tar.zst
PeerTube-75cba40de749fa8bf6cd767acbfaf478a6a8acbd.zip
Update avatar/banner API doc
Diffstat (limited to 'support/doc/api')
-rw-r--r--support/doc/api/openapi.yaml132
1 files changed, 127 insertions, 5 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index bf99cb45c..8be6575b4 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -974,7 +974,10 @@ paths:
974 content: 974 content:
975 application/json: 975 application/json:
976 schema: 976 schema:
977 $ref: '#/components/schemas/Avatar' 977 type: object
978 properties:
979 avatar:
980 $ref: '#/components/schemas/ActorImage'
978 '413': 981 '413':
979 description: image file too large 982 description: image file too large
980 headers: 983 headers:
@@ -996,6 +999,17 @@ paths:
996 encoding: 999 encoding:
997 avatarfile: 1000 avatarfile:
998 contentType: image/png, image/jpeg 1001 contentType: image/png, image/jpeg
1002 /users/me/avatar:
1003 delete:
1004 summary: Delete my avatar
1005 security:
1006 - OAuth2: []
1007 tags:
1008 - My User
1009 responses:
1010 '204':
1011 description: successful operation
1012
999 /videos/ownership: 1013 /videos/ownership:
1000 get: 1014 get:
1001 summary: List video ownership changes 1015 summary: List video ownership changes
@@ -2185,6 +2199,112 @@ paths:
2185 application/json: 2199 application/json:
2186 schema: 2200 schema:
2187 $ref: '#/components/schemas/VideoListResponse' 2201 $ref: '#/components/schemas/VideoListResponse'
2202 '/video-channels/{channelHandle}/avatar/pick':
2203 post:
2204 summary: Update channel avatar
2205 security:
2206 - OAuth2: []
2207 tags:
2208 - Video Channels
2209 parameters:
2210 - $ref: '#/components/parameters/channelHandle'
2211 responses:
2212 '200':
2213 description: successful operation
2214 content:
2215 application/json:
2216 schema:
2217 type: object
2218 properties:
2219 avatar:
2220 $ref: '#/components/schemas/ActorImage'
2221 '413':
2222 description: image file too large
2223 headers:
2224 X-File-Maximum-Size:
2225 schema:
2226 type: string
2227 format: Nginx size
2228 description: Maximum file size for the avatar
2229 requestBody:
2230 content:
2231 multipart/form-data:
2232 schema:
2233 type: object
2234 properties:
2235 avatarfile:
2236 description: The file to upload.
2237 type: string
2238 format: binary
2239 encoding:
2240 avatarfile:
2241 contentType: image/png, image/jpeg
2242 '/video-channels/{channelHandle}/avatar':
2243 delete:
2244 summary: Delete channel avatar
2245 security:
2246 - OAuth2: []
2247 tags:
2248 - Video Channels
2249 parameters:
2250 - $ref: '#/components/parameters/channelHandle'
2251 responses:
2252 '204':
2253 description: successful operation
2254
2255
2256 '/video-channels/{channelHandle}/banner/pick':
2257 post:
2258 summary: Update channel banner
2259 security:
2260 - OAuth2: []
2261 tags:
2262 - Video Channels
2263 parameters:
2264 - $ref: '#/components/parameters/channelHandle'
2265 responses:
2266 '200':
2267 description: successful operation
2268 content:
2269 application/json:
2270 schema:
2271 type: object
2272 properties:
2273 banner:
2274 $ref: '#/components/schemas/ActorImage'
2275 '413':
2276 description: image file too large
2277 headers:
2278 X-File-Maximum-Size:
2279 schema:
2280 type: string
2281 format: Nginx size
2282 description: Maximum file size for the banner
2283 requestBody:
2284 content:
2285 multipart/form-data:
2286 schema:
2287 type: object
2288 properties:
2289 bannerfile:
2290 description: The file to upload.
2291 type: string
2292 format: binary
2293 encoding:
2294 bannerfile:
2295 contentType: image/png, image/jpeg
2296 '/video-channels/{channelHandle}/banner':
2297 delete:
2298 summary: Delete channel banner
2299 security:
2300 - OAuth2: []
2301 tags:
2302 - Video Channels
2303 parameters:
2304 - $ref: '#/components/parameters/channelHandle'
2305 responses:
2306 '204':
2307 description: successful operation
2188 2308
2189 /video-playlists/privacies: 2309 /video-playlists/privacies:
2190 get: 2310 get:
@@ -3984,7 +4104,7 @@ components:
3984 avatar: 4104 avatar:
3985 nullable: true 4105 nullable: true
3986 allOf: 4106 allOf:
3987 - $ref: '#/components/schemas/Avatar' 4107 - $ref: '#/components/schemas/ActorImage'
3988 VideoChannelSummary: 4108 VideoChannelSummary:
3989 properties: 4109 properties:
3990 id: 4110 id:
@@ -4002,7 +4122,7 @@ components:
4002 avatar: 4122 avatar:
4003 nullable: true 4123 nullable: true
4004 allOf: 4124 allOf:
4005 - $ref: '#/components/schemas/Avatar' 4125 - $ref: '#/components/schemas/ActorImage'
4006 PlaylistElement: 4126 PlaylistElement:
4007 properties: 4127 properties:
4008 position: 4128 position:
@@ -4455,7 +4575,7 @@ components:
4455 $ref: '#/components/schemas/VideoConstantString' 4575 $ref: '#/components/schemas/VideoConstantString'
4456 captionPath: 4576 captionPath:
4457 type: string 4577 type: string
4458 Avatar: 4578 ActorImage:
4459 properties: 4579 properties:
4460 path: 4580 path:
4461 type: string 4581 type: string
@@ -4507,7 +4627,7 @@ components:
4507 type: string 4627 type: string
4508 format: date-time 4628 format: date-time
4509 avatar: 4629 avatar:
4510 $ref: '#/components/schemas/Avatar' 4630 $ref: '#/components/schemas/ActorImage'
4511 Account: 4631 Account:
4512 allOf: 4632 allOf:
4513 - $ref: '#/components/schemas/Actor' 4633 - $ref: '#/components/schemas/Actor'
@@ -5689,6 +5809,8 @@ components:
5689 description: User can stream multiple times in a permanent live 5809 description: User can stream multiple times in a permanent live
5690 type: boolean 5810 type: boolean
5691 5811
5812
5813
5692 callbacks: 5814 callbacks:
5693 searchIndex: 5815 searchIndex:
5694 'https://search.example.org/api/v1/search/videos': 5816 'https://search.example.org/api/v1/search/videos':