Improve abuse api doc

This commit is contained in:
Chocobozzz 2020-04-21 15:24:19 +02:00
parent c18431505f
commit 50e16ccf61
No known key found for this signature in database
GPG Key ID: 583A612D890159BE

View File

@ -63,7 +63,7 @@ tags:
server then deals with inter-server ActivityPub operations and propagates server then deals with inter-server ActivityPub operations and propagates
information across its social graph by posting activities to actors' inbox information across its social graph by posting activities to actors' inbox
endpoints. endpoints.
- name: Video Abuse - name: Video Abuses
description: | description: |
Video abuses deal with reports of local or remote videos alike. Video abuses deal with reports of local or remote videos alike.
- name: Video - name: Video
@ -116,7 +116,7 @@ x-tagGroups:
- Search - Search
- name: Moderation - name: Moderation
tags: tags:
- Video Abuse - Video Abuses
- Video Blacklist - Video Blacklist
- name: Instance Configuration - name: Instance Configuration
tags: tags:
@ -538,7 +538,7 @@ paths:
type: number type: number
'/users/me/videos/{videoId}/rating': '/users/me/videos/{videoId}/rating':
get: get:
summary: Get rate of my user of a video summary: Get rate of my user for a video
security: security:
- OAuth2: [] - OAuth2: []
tags: tags:
@ -1197,7 +1197,7 @@ paths:
- admin - admin
- moderator - moderator
tags: tags:
- Video Abuse - Video Abuses
parameters: parameters:
- $ref: '#/components/parameters/start' - $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count' - $ref: '#/components/parameters/count'
@ -1217,12 +1217,63 @@ paths:
security: security:
- OAuth2: [] - OAuth2: []
tags: tags:
- Video Abuse - Video Abuses
- Videos
parameters: parameters:
- $ref: '#/components/parameters/idOrUUID' - $ref: '#/components/parameters/idOrUUID'
requestBody:
content:
application/json:
schema:
type: object
properties:
reason:
description: Reason why the user reports this video
type: string
responses: responses:
'204': '204':
description: successful operation description: successful operation
'/videos/{id}/abuse/{abuseId}':
put:
summary: Update an abuse
security:
- OAuth2:
- admin
- moderator
tags:
- Video Abuses
responses:
'204':
description: successful operation
parameters:
- $ref: '#/components/parameters/idOrUUID'
- $ref: '#/components/parameters/abuseId'
requestBody:
content:
application/json:
schema:
type: object
properties:
state:
$ref: '#/components/schemas/VideoAbuseStateSet'
moderationComment:
type: string
description: 'Update the comment of the video abuse for other admin/moderators'
delete:
summary: Delete an abuse
security:
- OAuth2:
- admin
- moderator
tags:
- Video Abuses
responses:
'204':
description: successful operation
parameters:
- $ref: '#/components/parameters/idOrUUID'
- $ref: '#/components/parameters/abuseId'
'/videos/{id}/blacklist': '/videos/{id}/blacklist':
post: post:
summary: Blacklist a video summary: Blacklist a video
@ -1973,6 +2024,13 @@ components:
description: Playlist element id description: Playlist element id
schema: schema:
type: number type: number
abuseId:
name: abuseId
in: path
required: true
description: Video abuse id
schema:
type: number
captionLanguage: captionLanguage:
name: captionLanguage name: captionLanguage
in: path in: path
@ -2183,6 +2241,7 @@ components:
$ref: '#/components/schemas/VideoPrivacySet' $ref: '#/components/schemas/VideoPrivacySet'
label: label:
type: string type: string
VideoStateConstant: VideoStateConstant:
properties: properties:
id: id:
@ -2194,6 +2253,21 @@ components:
description: 'The video state (Published = 1, to transcode = 2, to import = 3)' description: 'The video state (Published = 1, to transcode = 2, to import = 3)'
label: label:
type: string type: string
VideoAbuseStateSet:
type: integer
enum:
- 1
- 2
- 3
description: 'The video playlist privacy (Pending = 1, Rejected = 2, Accepted = 3)'
VideoAbuseStateConstant:
properties:
id:
$ref: '#/components/schemas/VideoAbuseStateSet'
label:
type: string
VideoResolutionConstant: VideoResolutionConstant:
properties: properties:
id: id:
@ -2440,6 +2514,10 @@ components:
type: string type: string
reporterAccount: reporterAccount:
$ref: '#/components/schemas/Account' $ref: '#/components/schemas/Account'
state:
$ref: '#/components/schemas/VideoAbuseStateConstant'
moderationComment:
type: string
video: video:
type: object type: object
properties: properties:
@ -2449,8 +2527,6 @@ components:
type: string type: string
uuid: uuid:
type: string type: string
url:
type: string
createdAt: createdAt:
type: string type: string
VideoBlacklist: VideoBlacklist: