From 5cc5f5e2c7d4a6fa5b74aa33a6dbc7ffcf4bcc99 Mon Sep 17 00:00:00 2001
From: kosayoda <kieransiek@protonmail.com>
Date: Thu, 16 Jul 2020 10:52:21 +0800
Subject: Document PATCH for reminders

---
 pydis_site/apps/api/viewsets/bot/reminder.py | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

(limited to 'pydis_site')

diff --git a/pydis_site/apps/api/viewsets/bot/reminder.py b/pydis_site/apps/api/viewsets/bot/reminder.py
index b31330a0..940d19d4 100644
--- a/pydis_site/apps/api/viewsets/bot/reminder.py
+++ b/pydis_site/apps/api/viewsets/bot/reminder.py
@@ -58,6 +58,22 @@ class ReminderViewSet(
     - 400: if the body format is invalid
     - 404: if no user with the given ID could be found
 
+    ### PATCH /bot/reminders/<id:int>
+    Update the user with the given `id`.
+    All fields in the request body are optional.
+
+    #### Request body
+    >>> {
+    ...     'mentions': List[int],
+    ...     'content': str,
+    ...     'expiration': str  # ISO-formatted datetime
+    ... }
+
+    #### Status codes
+    - 200: returned on success
+    - 400: if the body format is invalid
+    - 404: if no user with the given ID could be found
+
     ### DELETE /bot/reminders/<id:int>
     Delete the reminder with the given `id`.
 
-- 
cgit v1.2.3