Update avatar/banner API doc

This commit is contained in:
Chocobozzz 2021-04-08 09:34:32 +02:00 committed by Chocobozzz
parent 02dd4f3c65
commit 75cba40de7
1 changed files with 127 additions and 5 deletions

View File

@ -974,7 +974,10 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/Avatar' type: object
properties:
avatar:
$ref: '#/components/schemas/ActorImage'
'413': '413':
description: image file too large description: image file too large
headers: headers:
@ -996,6 +999,17 @@ paths:
encoding: encoding:
avatarfile: avatarfile:
contentType: image/png, image/jpeg contentType: image/png, image/jpeg
/users/me/avatar:
delete:
summary: Delete my avatar
security:
- OAuth2: []
tags:
- My User
responses:
'204':
description: successful operation
/videos/ownership: /videos/ownership:
get: get:
summary: List video ownership changes summary: List video ownership changes
@ -2185,6 +2199,112 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/VideoListResponse' $ref: '#/components/schemas/VideoListResponse'
'/video-channels/{channelHandle}/avatar/pick':
post:
summary: Update channel avatar
security:
- OAuth2: []
tags:
- Video Channels
parameters:
- $ref: '#/components/parameters/channelHandle'
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
properties:
avatar:
$ref: '#/components/schemas/ActorImage'
'413':
description: image file too large
headers:
X-File-Maximum-Size:
schema:
type: string
format: Nginx size
description: Maximum file size for the avatar
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
avatarfile:
description: The file to upload.
type: string
format: binary
encoding:
avatarfile:
contentType: image/png, image/jpeg
'/video-channels/{channelHandle}/avatar':
delete:
summary: Delete channel avatar
security:
- OAuth2: []
tags:
- Video Channels
parameters:
- $ref: '#/components/parameters/channelHandle'
responses:
'204':
description: successful operation
'/video-channels/{channelHandle}/banner/pick':
post:
summary: Update channel banner
security:
- OAuth2: []
tags:
- Video Channels
parameters:
- $ref: '#/components/parameters/channelHandle'
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
properties:
banner:
$ref: '#/components/schemas/ActorImage'
'413':
description: image file too large
headers:
X-File-Maximum-Size:
schema:
type: string
format: Nginx size
description: Maximum file size for the banner
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
bannerfile:
description: The file to upload.
type: string
format: binary
encoding:
bannerfile:
contentType: image/png, image/jpeg
'/video-channels/{channelHandle}/banner':
delete:
summary: Delete channel banner
security:
- OAuth2: []
tags:
- Video Channels
parameters:
- $ref: '#/components/parameters/channelHandle'
responses:
'204':
description: successful operation
/video-playlists/privacies: /video-playlists/privacies:
get: get:
@ -3984,7 +4104,7 @@ components:
avatar: avatar:
nullable: true nullable: true
allOf: allOf:
- $ref: '#/components/schemas/Avatar' - $ref: '#/components/schemas/ActorImage'
VideoChannelSummary: VideoChannelSummary:
properties: properties:
id: id:
@ -4002,7 +4122,7 @@ components:
avatar: avatar:
nullable: true nullable: true
allOf: allOf:
- $ref: '#/components/schemas/Avatar' - $ref: '#/components/schemas/ActorImage'
PlaylistElement: PlaylistElement:
properties: properties:
position: position:
@ -4455,7 +4575,7 @@ components:
$ref: '#/components/schemas/VideoConstantString' $ref: '#/components/schemas/VideoConstantString'
captionPath: captionPath:
type: string type: string
Avatar: ActorImage:
properties: properties:
path: path:
type: string type: string
@ -4507,7 +4627,7 @@ components:
type: string type: string
format: date-time format: date-time
avatar: avatar:
$ref: '#/components/schemas/Avatar' $ref: '#/components/schemas/ActorImage'
Account: Account:
allOf: allOf:
- $ref: '#/components/schemas/Actor' - $ref: '#/components/schemas/Actor'
@ -5689,6 +5809,8 @@ components:
description: User can stream multiple times in a permanent live description: User can stream multiple times in a permanent live
type: boolean type: boolean
callbacks: callbacks:
searchIndex: searchIndex:
'https://search.example.org/api/v1/search/videos': 'https://search.example.org/api/v1/search/videos':