Merge pull request #5371 from hypothesis/flag-annotation-api-docs

Add documentation for `PUT /api/annotations/{id}/flag`
hypothesis · Oct 15, 2018 · fba70ab · fba70ab
2 parents 2f6e44a + 5d72710
commit fba70ab
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/docs/_extra/api-reference/hypothesis.yaml b/docs/_extra/api-reference/hypothesis.yaml
@@ -209,6 +209,29 @@ paths:
           description: Annotation not found or no permission to delete
           schema:
             $ref: '#/definitions/Error'
+  /annotations/{id}/flag:
+    put:
+      tags:
+        - annotations
+      summary: Flag an annotation
+      operationId: flagAnnotation
+      description: >
+        Flag an annotation for moderation. The administrator (moderator) of the
+        group containing the annotation will be notified by email.
+      parameters:
+        - name: id
+          in: path
+          description: ID of annotation to flag for moderation
+          required: true
+          type: string
+      responses:
+        '204':
+          description: Success
+        '404':
+          description: Annotation not found or no permission to flag
+          schema:
+            $ref: '#/definitions/Error'
+
   /profile:
     get:
       tags: