From 9cff951b4b4d121cf37270787c3263430edd427a Mon Sep 17 00:00:00 2001
From: Corban-Lee Jones <corbz.jones@gmail.com>
Date: Thu, 18 Jan 2024 20:01:51 +0000
Subject: [PATCH] description for API View

---
 apps/api/views.py | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/apps/api/views.py b/apps/api/views.py
index f1a1b92..137ac50 100644
--- a/apps/api/views.py
+++ b/apps/api/views.py
@@ -30,6 +30,18 @@ class TicketPaginiation(PageNumberPagination):
 
 
 class TicketListApiView(generics.ListAPIView):
+    """Returns a list of all **Tickets** on the system.
+
+    Use a querystring to filter down, order, and search the results.
+
+    Querystring options are:
+    - uuid
+    - priority
+    - tags
+    - author
+    - author__department
+    """
+
     authentication_classes = [SessionAuthentication, TokenAuthentication]
     permission_classes = [permissions.IsAuthenticated]