diff options
| author |  kosayoda <[email protected]> | 2020-07-16 10:52:21 +0800 |
|---|---|---|
| committer | kosayoda <[email protected]> | 2020-07-16 10:52:21 +0800 |
| commit | 5cc5f5e2c7d4a6fa5b74aa33a6dbc7ffcf4bcc99 (patch) | |
| tree | f8d8e833a18028354ee93cbbd5be3f69c2784f83 /pydis_site/apps | |
| parent | Document POSTing mentions in ReminderViewSet (diff) | |
Document PATCH for reminders
Diffstat (limited to 'pydis_site/apps')
| -rw-r--r-- | pydis_site/apps/api/viewsets/bot/reminder.py | 16 |
1 files changed, 16 insertions, 0 deletions
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`. |