description for API View

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]