Comments and Documentation

This change adds a ton of comments and documentation across all the code.

Change-Id: Ifee0a2f534e8584f14b0f13af4dda8dc70eb7553
Signed-off-by: Parker Berberian <pberberian@iol.unh.edu>

1 files changed, 12 insertions, 0 deletions

diff --git a/src/api/views.py b/src/api/views.py
index a5153d7..bc01562 100644
--- a/src/api/views.py
+++ b/src/api/views.py
@@ -27,6 +27,18 @@ from booking.models import Booking
 from api.models import LabManagerTracker, get_task
 from notifier.manager import NotificationHandler
 
+"""
+API views.
+
+All functions return a Json blob
+Most functions that deal with info from a specific lab (tasks, host info)
+requires the Lab auth token.
+    for example, curl -H auth-token:mylabsauthtoken url
+
+Most functions let you GET or POST to the same endpoint, and
+the correct thing will happen
+"""
+
 
 class BookingViewSet(viewsets.ModelViewSet):
     queryset = Booking.objects.all()