Complement #503 (#505)

Author: VinyarionHyarmendacil

openapi/components/parameters.yaml

@@ -383,8 +383,22 @@ avatarId:
   in: path
   required: true
   schema:
-    type: string
+    $ref: ./schemas/AvatarID.yaml
+  description: Must be a valid avatar ID.
+targetAvatarId:
+  name: targetAvatarId
+  in: query
+  required: true
+  schema:
+    $ref: ./schemas/AvatarID.yaml
   description: Must be a valid avatar ID.
+avatarModerationType:
+  name: avatarModerationType
+  in: query
+  required: true
+  schema:
+    $ref: ./schemas/AvatarModerationType.yaml
+  description: The avatar moderation type associated with the avatar.
 messageType:
   name: messageType
   in: path

openapi/components/paths/authentication.yaml

@@ -171,7 +171,7 @@ paths:
     get:
       summary: Get Global Avatar Moderations
       operationId: getGlobalAvatarModerations
-      description: Returns list of globally blocked avatars.
+      description: Returns list of globally moderated avatars.
       tags:
         - authentication
       security:
@@ -181,6 +181,41 @@ paths:
           $ref: ../responses/authentication/GetAvatarModerationsResponse.yaml
         '401':
           $ref: ../responses/MissingCredentialsError.yaml
+    post:
+      summary: Create Global Avatar Moderation
+      operationId: createGlobalAvatarModeration
+      description: Globally moderates an avatar.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: ../requests/CreateAvatarModerationRequest.yaml
+      tags:
+        - authentication
+      security:
+        - authCookie: []
+      responses:
+        '200':
+          $ref: ../responses/authentication/CreateAvatarModerationResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+    delete:
+      summary: Delete Global Avatar Moderation
+      operationId: deleteGlobalAvatarModeration
+      description: Globally unmoderates an avatar.
+      parameters:
+        - $ref: ../parameters.yaml#/targetAvatarId
+        - $ref: ../parameters.yaml#/avatarModerationType
+      tags:
+        - authentication
+      security:
+        - authCookie: []
+      responses:
+        '200':
+          $ref: ../responses/authentication/DeleteAvatarModerationResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
   /auth/twofactorauth/otp/verify:
     post:
       summary: Verify 2FA code with Recovery code

openapi/components/requests/CreateAvatarModerationRequest.yaml

@@ -0,0 +1,10 @@
+title: CreateAvatarModerationRequest
+type: object
+properties:
+  targetAvatarId:
+    $ref: ../schemas/AvatarID.yaml
+  avatarModerationType:
+    $ref: ../schemas/AvatarModerationType.yaml
+required:
+  - targetAvatarId
+  - avatarModerationType

openapi/components/responses/authentication/CreateAvatarModerationResponse.yaml

@@ -0,0 +1,5 @@
+description: Returns a single AvatarModerationCreated object
+content:
+  application/json:
+    schema:
+      $ref: ../../schemas/AvatarModerationCreated.yaml

openapi/components/responses/authentication/DeleteAvatarModerationResponse.yaml

@@ -0,0 +1,5 @@
+description: Returns a single OkStatus2 object
+content:
+  application/json:
+    schema:
+      $ref: ../../schemas/OkStatus2.yaml

openapi/components/schemas/AvatarModerationCreated.yaml

@@ -0,0 +1,15 @@
+title: AvatarModerationCreated
+type: object
+properties:
+  avatarModerationType:
+    $ref: ./AvatarModerationType.yaml
+  created:
+    type: integer
+    format: int64
+    description: Timestamp in milliseconds since Unix epoch
+  targetAvatarId:
+    $ref: ./AvatarID.yaml
+required:
+  - avatarModerationType
+  - created
+  - targetAvatarId

openapi/components/schemas/OkStatus2.yaml

@@ -0,0 +1,9 @@
+title: OkStatus2
+type: object
+description: Another status response consisting of solely a string description of whether the result of an operation was ok.
+properties:
+  OK:
+    type: string
+    description: The actual status itself
+required:
+  - OK