From 700de6b08b70f40dc97f3644d4e0ee32ab8f6ccf Mon Sep 17 00:00:00 2001
From: Numerlor <25886452+Numerlor@users.noreply.github.com>
Date: Thu, 20 Aug 2020 15:24:29 +0200
Subject: Update docstring for new fetching behaviour

---
 pydis_site/apps/api/viewsets/bot/reminder.py | 24 ++++++++++++++++++++++++
 1 file changed, 24 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 00413fb1..111660d9 100644
--- a/pydis_site/apps/api/viewsets/bot/reminder.py
+++ b/pydis_site/apps/api/viewsets/bot/reminder.py
@@ -50,6 +50,30 @@ class ReminderViewSet(
     #### Status codes
     - 200: returned on success
 
+    ### GET /bot/reminders/<id:int>
+    Fetches the reminder with the given id.
+
+    #### Response format
+    >>>
+    ... {
+    ...     'active': True,
+    ...     'author': 1020103901030,
+    ...     'mentions': [
+    ...         336843820513755157,
+    ...         165023948638126080,
+    ...         267628507062992896
+    ...     ],
+    ...     'content': "Make dinner",
+    ...     'expiration': '5018-11-20T15:52:00Z',
+    ...     'id': 11,
+    ...     'channel_id': 634547009956872193,
+    ...     'jump_url': "https://discord.com/channels/<guild_id>/<channel_id>/<message_id>"
+    ... }
+
+    #### Status codes
+    - 200: returned on success
+    - 404: returned when the reminder doesn't exist
+
     ### POST /bot/reminders
     Create a new reminder.
 
-- 
cgit v1.2.3