From f4a67489b81f95978912582189cb23afb2169e8e Mon Sep 17 00:00:00 2001
From: Boris Muratov <8bee278@gmail.com>
Date: Fri, 12 Mar 2021 15:35:47 +0200
Subject: Document endpoint in viewset docstring

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

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

diff --git a/pydis_site/apps/api/viewsets/bot/user.py b/pydis_site/apps/api/viewsets/bot/user.py
index 5e1f8775..25722f5a 100644
--- a/pydis_site/apps/api/viewsets/bot/user.py
+++ b/pydis_site/apps/api/viewsets/bot/user.py
@@ -119,6 +119,22 @@ class UserViewSet(ModelViewSet):
     - 200: returned on success
     - 404: if a user with the given `snowflake` could not be found
 
+    ### GET /bot/users/<snowflake:int>/metricity_review_data
+    Gets metricity data for a single user's review by ID.
+
+    #### Response format
+    >>> {
+    ...     'joined_at': '2020-08-26T08:09:43.507000',
+    ...     'top_channel_activity': [['off-topic', 15],
+    ...                              ['talent-pool', 4],
+    ...                              ['defcon', 2]],
+    ...     'total_messages': 22
+    ... }
+
+    #### Status codes
+    - 200: returned on success
+    - 404: if a user with the given `snowflake` could not be found
+
     ### POST /bot/users
     Adds a single or multiple new users.
     The roles attached to the user(s) must be roles known by the site.
-- 
cgit v1.2.3