aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api/openapi.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'support/doc/api/openapi.yaml')
-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 a47654f69..373b17ddf 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:
@@ -3989,7 +4109,7 @@ components:
3989 avatar: 4109 avatar:
3990 nullable: true 4110 nullable: true
3991 allOf: 4111 allOf:
3992 - $ref: '#/components/schemas/Avatar' 4112 - $ref: '#/components/schemas/ActorImage'
3993 VideoChannelSummary: 4113 VideoChannelSummary:
3994 properties: 4114 properties:
3995 id: 4115 id:
@@ -4007,7 +4127,7 @@ components:
4007 avatar: 4127 avatar:
4008 nullable: true 4128 nullable: true
4009 allOf: 4129 allOf:
4010 - $ref: '#/components/schemas/Avatar' 4130 - $ref: '#/components/schemas/ActorImage'
4011 PlaylistElement: 4131 PlaylistElement:
4012 properties: 4132 properties:
4013 position: 4133 position:
@@ -4460,7 +4580,7 @@ components:
4460 $ref: '#/components/schemas/VideoConstantString' 4580 $ref: '#/components/schemas/VideoConstantString'
4461 captionPath: 4581 captionPath:
4462 type: string 4582 type: string
4463 Avatar: 4583 ActorImage:
4464 properties: 4584 properties:
4465 path: 4585 path:
4466 type: string 4586 type: string
@@ -4512,7 +4632,7 @@ components:
4512 type: string 4632 type: string
4513 format: date-time 4633 format: date-time
4514 avatar: 4634 avatar:
4515 $ref: '#/components/schemas/Avatar' 4635 $ref: '#/components/schemas/ActorImage'
4516 Account: 4636 Account:
4517 allOf: 4637 allOf:
4518 - $ref: '#/components/schemas/Actor' 4638 - $ref: '#/components/schemas/Actor'
@@ -5694,6 +5814,8 @@ components:
5694 description: User can stream multiple times in a permanent live 5814 description: User can stream multiple times in a permanent live
5695 type: boolean 5815 type: boolean
5696 5816
5817
5818
5697 callbacks: 5819 callbacks:
5698 searchIndex: 5820 searchIndex:
5699 'https://search.example.org/api/v1/search/videos': 5821 'https://search.example.org/api/v1/search/videos':