aboutsummaryrefslogtreecommitdiffstats
path: root/pydis_site
diff options
context:
space:
mode:
authorGravatar Leon Sandøy <[email protected]>2020-07-19 22:19:04 +0200
committerGravatar Leon Sandøy <[email protected]>2020-07-19 22:19:04 +0200
commit53e4dfef781d0cd8239122b2bb55e08ae1d031f5 (patch)
tree54a16581131f317148af856205eb63d5d35f8c5f /pydis_site
parentRelock with a newer version of pipenv (diff)
Document the get_types endpoint.
Diffstat (limited to 'pydis_site')
-rw-r--r--pydis_site/apps/api/viewsets/bot/allow_deny_list.py14
1 files changed, 14 insertions, 0 deletions
diff --git a/pydis_site/apps/api/viewsets/bot/allow_deny_list.py b/pydis_site/apps/api/viewsets/bot/allow_deny_list.py
index 72cbc84c..6ea8da56 100644
--- a/pydis_site/apps/api/viewsets/bot/allow_deny_list.py
+++ b/pydis_site/apps/api/viewsets/bot/allow_deny_list.py
@@ -51,6 +51,20 @@ class AllowDenyListViewSet(ModelViewSet):
- 200: returned on success
- 404: returned if the id was not found.
+ ### GET /bot/allow_deny_lists/get_types
+ Returns a list of valid list types that can be used in POST requests.
+
+ #### Response format
+ >>> [
+ ... ["GUILD_INVITE","Guild Invite"],
+ ... ["FILE_FORMAT","File Format"],
+ ... ["DOMAIN_NAME","Domain Name"],
+ ... ["FILTER_TOKEN","Filter Token"]
+ ... ]
+
+ #### Status codes
+ - 200: returned on success
+
### POST /bot/allow_deny_lists
Adds a single AllowDenyList item to the database.