From 083cdf3f49805fd3c6d01fe538b7e01e12ca9b79 Mon Sep 17 00:00:00 2001
From: D0rs4n <41237606+D0rs4n@users.noreply.github.com>
Date: Thu, 10 Mar 2022 19:18:05 +0100
Subject: Add new filter field, and patch the docs in AoC viewsets

- Add the possibility to filter by `is_blocked` in the AoC completionist block viewset.
- Patch various tense, and formatting inconsistencies in AoC viewsets
---
 .../apps/api/viewsets/bot/aoc_completionist_block.py  |  6 +++---
 pydis_site/apps/api/viewsets/bot/aoc_link.py          | 19 +++++++++----------
 2 files changed, 12 insertions(+), 13 deletions(-)

(limited to 'pydis_site/apps/api/viewsets')

diff --git a/pydis_site/apps/api/viewsets/bot/aoc_completionist_block.py b/pydis_site/apps/api/viewsets/bot/aoc_completionist_block.py
index d3167d7b..3a4cec60 100644
--- a/pydis_site/apps/api/viewsets/bot/aoc_completionist_block.py
+++ b/pydis_site/apps/api/viewsets/bot/aoc_completionist_block.py
@@ -42,7 +42,7 @@ class AocCompletionistBlockViewSet(
 
     #### Status codes
     - 200: returned on success
-    - 404: returned if an AoC completionist block with the given user__id was not found.
+    - 404: returned if an AoC completionist block with the given `user__id` was not found.
 
     ### POST /bot/aoc-completionist-blocks
     Adds a single AoC completionist block
@@ -63,11 +63,11 @@ class AocCompletionistBlockViewSet(
 
     #### Status codes
     - 204: returned on success
-    - 404: if the AoC Completionist block with the given user__id does not exist
+    - 404: returned if the AoC Completionist block with the given `user__id` was not found
 
     """
 
     serializer_class = AocCompletionistBlockSerializer
     queryset = AocCompletionistBlock.objects.all()
     filter_backends = (DjangoFilterBackend,)
-    filter_fields = ("user__id",)
+    filter_fields = ("user__id", "is_blocked")
diff --git a/pydis_site/apps/api/viewsets/bot/aoc_link.py b/pydis_site/apps/api/viewsets/bot/aoc_link.py
index 5f6f3a84..9f22c1a1 100644
--- a/pydis_site/apps/api/viewsets/bot/aoc_link.py
+++ b/pydis_site/apps/api/viewsets/bot/aoc_link.py
@@ -29,20 +29,19 @@ class AocAccountLinkViewSet(
     ... ]
 
 
-    ### GET /bot/aoc-account-links<user__id:int>
+    ### GET /bot/aoc-account-links/<user__id:int>
     Retrieve a AoC account link by User ID
 
     #### Response format
-    >>> [
-    ...     {
-    ...         "user": 2,
-    ...         "aoc_username": "AoCUser1"
-    ...     },
-    ... ]
+    >>>
+    ... {
+    ...     "user": 2,
+    ...     "aoc_username": "AoCUser1"
+    ... }
 
     #### Status codes
     - 200: returned on success
-    - 404: returned if an AoC account link with the given user__id was not found.
+    - 404: returned if an AoC account link with the given `user__id` was not found.
 
     ### POST /bot/aoc-account-links
     Adds a single AoC account link block
@@ -55,14 +54,14 @@ class AocAccountLinkViewSet(
 
     #### Status codes
     - 204: returned on success
-    - 400: if one of the given fields is invalid
+    - 400: if one of the given fields was invalid
 
     ### DELETE /bot/aoc-account-links/<user__id:int>
     Deletes the AoC account link item with the given `user__id`.
 
     #### Status codes
     - 204: returned on success
-    - 404: if the AoC account link with the given user__id does not exist
+    - 404: returned if the AoC account link with the given `user__id` was not found
 
     """
 
-- 
cgit v1.2.3