Update openapi

This commit is contained in:
Chocobozzz 2020-07-10 09:51:56 +02:00 committed by Chocobozzz
parent 17b07dc5a2
commit e3489df98e
1 changed files with 48 additions and 43 deletions

View File

@ -1471,9 +1471,8 @@ paths:
description: HTTP or Torrent/magnetURI import not enabled description: HTTP or Torrent/magnetURI import not enabled
'400': '400':
description: '`magnetUri` or `targetUrl` or a torrent file missing' description: '`magnetUri` or `targetUrl` or a torrent file missing'
/videos/abuse: /abuses:
get: get:
deprecated: true
summary: List abuses summary: List abuses
security: security:
- OAuth2: - OAuth2:
@ -1491,16 +1490,7 @@ paths:
in: query in: query
description: predefined reason the listed reports should contain description: predefined reason the listed reports should contain
schema: schema:
type: string $ref: '#/components/schemas/PredefinedAbuseReasons'
enum:
- violentOrAbusive
- hatefulOrAbusive
- spamOrMisleading
- privacy
- rights
- serverRules
- thumbnails
- captions
- name: search - name: search
in: query in: query
description: plain search that will match with video titles, reporter names and more description: plain search that will match with video titles, reporter names and more
@ -1564,17 +1554,13 @@ paths:
type: array type: array
items: items:
$ref: '#/components/schemas/VideoAbuse' $ref: '#/components/schemas/VideoAbuse'
'/videos/{id}/abuse':
post: post:
deprecated: true
summary: Report an abuse summary: Report an abuse
security: security:
- OAuth2: [] - OAuth2: []
tags: tags:
- Abuses - Abuses
- Videos
parameters:
- $ref: '#/components/parameters/idOrUUID'
requestBody: requestBody:
required: true required: true
content: content:
@ -1587,27 +1573,34 @@ paths:
type: string type: string
minLength: 4 minLength: 4
predefinedReasons: predefinedReasons:
description: Reason categories that help triage reports $ref: '#/components/schemas/PredefinedAbuseReasons'
type: array
items: video:
type: string type: object
enum: properties:
- violentOrAbusive id:
- hatefulOrAbusive description: Video id to report
- spamOrMisleading type: number
- privacy startAt:
- rights type: integer
- serverRules description: Timestamp in the video that marks the beginning of the report
- thumbnails minimum: 0
- captions endAt:
startAt: type: integer
type: integer description: Timestamp in the video that marks the ending of the report
description: Timestamp in the video that marks the beginning of the report minimum: 0
minimum: 0 comment:
endAt: type: object
type: integer properties:
description: Timestamp in the video that marks the ending of the report id:
minimum: 0 description: Comment id to report
type: number
account:
type: object
properties:
id:
description: Account id to report
type: number
required: required:
- reason - reason
responses: responses:
@ -1615,9 +1608,8 @@ paths:
description: successful operation description: successful operation
'400': '400':
description: incorrect request parameters description: incorrect request parameters
'/videos/{id}/abuse/{abuseId}': '/abuses/{abuseId}':
put: put:
deprecated: true
summary: Update an abuse summary: Update an abuse
security: security:
- OAuth2: - OAuth2:
@ -1626,7 +1618,6 @@ paths:
tags: tags:
- Abuses - Abuses
parameters: parameters:
- $ref: '#/components/parameters/idOrUUID'
- $ref: '#/components/parameters/abuseId' - $ref: '#/components/parameters/abuseId'
requestBody: requestBody:
content: content:
@ -1645,7 +1636,6 @@ paths:
'404': '404':
description: abuse not found description: abuse not found
delete: delete:
deprecated: true
tags: tags:
- Abuses - Abuses
summary: Delete an abuse summary: Delete an abuse
@ -1654,7 +1644,6 @@ paths:
- admin - admin
- moderator - moderator
parameters: parameters:
- $ref: '#/components/parameters/idOrUUID'
- $ref: '#/components/parameters/abuseId' - $ref: '#/components/parameters/abuseId'
responses: responses:
'204': '204':
@ -4570,6 +4559,22 @@ components:
updatedAt: updatedAt:
type: string type: string
format: date-time format: date-time
PredefinedAbuseReasons:
description: Reason categories that help triage reports
type: array
items:
type: string
enum:
- violentOrAbusive
- hatefulOrAbusive
- spamOrMisleading
- privacy
- rights
- serverRules
- thumbnails
- captions
Job: Job:
properties: properties:
id: id: