diff options
author | Rigel Kent <sendmemail@rigelk.eu> | 2020-06-22 13:00:39 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-06-22 13:00:39 +0200 |
commit | 1ebddadd0704812a4600c39cabe2268321e88331 (patch) | |
tree | 1cc8560e5b63e9976aa5411ba800a62cfe7b8ea9 /support/doc/api/openapi.yaml | |
parent | 07aea1a2642fc9868cb01e30c322514029d5b95a (diff) | |
download | PeerTube-1ebddadd0704812a4600c39cabe2268321e88331.tar.gz PeerTube-1ebddadd0704812a4600c39cabe2268321e88331.tar.zst PeerTube-1ebddadd0704812a4600c39cabe2268321e88331.zip |
predefined report reasons & improved reporter UI (#2842)
- added `startAt` and `endAt` optional timestamps to help pin down reported sections of a video
- added predefined report reasons
- added video player with report modal
Diffstat (limited to 'support/doc/api/openapi.yaml')
-rw-r--r-- | support/doc/api/openapi.yaml | 40 |
1 files changed, 39 insertions, 1 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 501187d8f..9434af904 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -120,7 +120,7 @@ x-tagGroups: | |||
120 | - name: Moderation | 120 | - name: Moderation |
121 | tags: | 121 | tags: |
122 | - Video Abuses | 122 | - Video Abuses |
123 | - Video Blacklist | 123 | - Video Blocks |
124 | - name: Instance Configuration | 124 | - name: Instance Configuration |
125 | tags: | 125 | tags: |
126 | - Config | 126 | - Config |
@@ -1245,6 +1245,7 @@ paths: | |||
1245 | parameters: | 1245 | parameters: |
1246 | - $ref: '#/components/parameters/idOrUUID' | 1246 | - $ref: '#/components/parameters/idOrUUID' |
1247 | requestBody: | 1247 | requestBody: |
1248 | required: true | ||
1248 | content: | 1249 | content: |
1249 | application/json: | 1250 | application/json: |
1250 | schema: | 1251 | schema: |
@@ -1253,6 +1254,28 @@ paths: | |||
1253 | reason: | 1254 | reason: |
1254 | description: Reason why the user reports this video | 1255 | description: Reason why the user reports this video |
1255 | type: string | 1256 | type: string |
1257 | predefinedReasons: | ||
1258 | description: Reason categories that help triage reports | ||
1259 | type: array | ||
1260 | items: | ||
1261 | type: string | ||
1262 | enum: | ||
1263 | - violentOrAbusive | ||
1264 | - hatefulOrAbusive | ||
1265 | - spamOrMisleading | ||
1266 | - privacy | ||
1267 | - rights | ||
1268 | - serverRules | ||
1269 | - thumbnails | ||
1270 | - captions | ||
1271 | startAt: | ||
1272 | type: number | ||
1273 | description: Timestamp in the video that marks the beginning of the report | ||
1274 | endAt: | ||
1275 | type: number | ||
1276 | description: Timestamp in the video that marks the ending of the report | ||
1277 | required: | ||
1278 | - reason | ||
1256 | responses: | 1279 | responses: |
1257 | '204': | 1280 | '204': |
1258 | description: successful operation | 1281 | description: successful operation |
@@ -2488,6 +2511,19 @@ components: | |||
2488 | $ref: '#/components/schemas/VideoAbuseStateSet' | 2511 | $ref: '#/components/schemas/VideoAbuseStateSet' |
2489 | label: | 2512 | label: |
2490 | type: string | 2513 | type: string |
2514 | VideoAbusePredefinedReasons: | ||
2515 | type: array | ||
2516 | items: | ||
2517 | type: string | ||
2518 | enum: | ||
2519 | - violentOrAbusive | ||
2520 | - hatefulOrAbusive | ||
2521 | - spamOrMisleading | ||
2522 | - privacy | ||
2523 | - rights | ||
2524 | - serverRules | ||
2525 | - thumbnails | ||
2526 | - captions | ||
2491 | 2527 | ||
2492 | VideoResolutionConstant: | 2528 | VideoResolutionConstant: |
2493 | properties: | 2529 | properties: |
@@ -2739,6 +2775,8 @@ components: | |||
2739 | type: number | 2775 | type: number |
2740 | reason: | 2776 | reason: |
2741 | type: string | 2777 | type: string |
2778 | predefinedReasons: | ||
2779 | $ref: '#/components/schemas/VideoAbusePredefinedReasons' | ||
2742 | reporterAccount: | 2780 | reporterAccount: |
2743 | $ref: '#/components/schemas/Account' | 2781 | $ref: '#/components/schemas/Account' |
2744 | state: | 2782 | state: |