From 1ebddadd0704812a4600c39cabe2268321e88331 Mon Sep 17 00:00:00 2001
From: Rigel Kent <sendmemail@rigelk.eu>
Date: Mon, 22 Jun 2020 13:00:39 +0200
Subject: 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
---
 support/doc/api/openapi.yaml | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

(limited to 'support/doc/api/openapi.yaml')

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:
   - name: Moderation
     tags:
       - Video Abuses
-      - Video Blacklist
+      - Video Blocks
   - name: Instance Configuration
     tags:
       - Config
@@ -1245,6 +1245,7 @@ paths:
       parameters:
         - $ref: '#/components/parameters/idOrUUID'
       requestBody:
+        required: true
         content:
           application/json:
             schema:
@@ -1253,6 +1254,28 @@ paths:
                 reason:
                   description: Reason why the user reports this video
                   type: string
+                predefinedReasons:
+                  description: Reason categories that help triage reports
+                  type: array
+                  items:
+                    type: string
+                    enum:
+                    - violentOrAbusive
+                    - hatefulOrAbusive
+                    - spamOrMisleading
+                    - privacy
+                    - rights
+                    - serverRules
+                    - thumbnails
+                    - captions
+                startAt:
+                  type: number
+                  description: Timestamp in the video that marks the beginning of the report
+                endAt:
+                  type: number
+                  description: Timestamp in the video that marks the ending of the report
+              required:
+                - reason
       responses:
         '204':
           description: successful operation
@@ -2488,6 +2511,19 @@ components:
           $ref: '#/components/schemas/VideoAbuseStateSet'
         label:
           type: string
+    VideoAbusePredefinedReasons:
+      type: array
+      items:
+        type: string
+        enum:
+        - violentOrAbusive
+        - hatefulOrAbusive
+        - spamOrMisleading
+        - privacy
+        - rights
+        - serverRules
+        - thumbnails
+        - captions
 
     VideoResolutionConstant:
       properties:
@@ -2739,6 +2775,8 @@ components:
           type: number
         reason:
           type: string
+        predefinedReasons:
+          $ref: '#/components/schemas/VideoAbusePredefinedReasons'
         reporterAccount:
           $ref: '#/components/schemas/Account'
         state:
-- 
cgit v1.2.3