Documentation Repository

bothub/api/v2/repository/views.py

@@ -59,6 +59,20 @@ class RepositoryViewSet(
         GenericViewSet):
     """
     Manager repository (bot).
+
+    create:
+        Create a new Repository, add examples and train a bot.
+    retrieve:
+        Get repository data.
+
+    update:
+        Update your repository.
+
+    partial_update:
+        Update, partially, your repository.
+
+    delete:
+        Delete your repository.
     """
     queryset = Repository.objects
     lookup_field = 'uuid'
@@ -208,6 +222,16 @@ class RepositoryVotesViewSet(
         GenericViewSet):
     """
     Manager repository votes (bot).
+
+    create:
+        Add vote in repository
+
+    destroy:
+        Remove vote in repository
+
+    list:
+        List all votes in repository
+
     """
     queryset = RepositoryVote.objects.all()
     lookup_field = 'repository'
@@ -252,7 +276,8 @@ class RepositoriesViewSet(
         mixins.ListModelMixin,
         GenericViewSet):
     """
-    List all public repositories.
+    list:
+        List all public repositories.
     """
     serializer_class = ShortRepositorySerializer
     queryset = Repository.objects.all().publics().order_by_relevance()
@@ -286,7 +311,8 @@ class RepositoriesContributionsViewSet(
         mixins.ListModelMixin,
         GenericViewSet):
     """
-    List Repositories Contributions by user.
+    list:
+        List Repositories Contributions by user.
     """
     serializer_class = RepositoryContributionsSerializer
     queryset = RepositoryAuthorization.objects.all()
@@ -311,7 +337,8 @@ class RepositoryCategoriesView(
         mixins.ListModelMixin,
         GenericViewSet):
     """
-    List all categories.
+    list:
+        List all categories.
     """
     serializer_class = RepositoryCategorySerializer
     queryset = RepositoryCategory.objects.all()
@@ -335,7 +362,8 @@ class SearchRepositoriesViewSet(
         mixins.ListModelMixin,
         GenericViewSet):
     """
-    List all user's repositories
+    list:
+        Search and List all user's repositories
     """
     queryset = Repository.objects
     serializer_class = RepositorySerializer
@@ -361,6 +389,15 @@ class RepositoryAuthorizationViewSet(
         mixins.UpdateModelMixin,
         mixins.ListModelMixin,
         GenericViewSet):
+    """
+    list:
+        List all Authorizations
+    update:
+        Update Authorization
+    partial_update:
+        Update Authorization
+
+    """
     queryset = RepositoryAuthorization.objects.exclude(
         role=RepositoryAuthorization.ROLE_NOT_SETTED)
     serializer_class = RepositoryAuthorizationSerializer
@@ -409,7 +446,20 @@ class RepositoryAuthorizationRequestsViewSet(
         mixins.DestroyModelMixin,
         GenericViewSet):
     """
-    List of all authorization requests for a repository
+    list:
+        List of all authorization requests for a repository
+
+    create:
+        Request authorization in the repository
+
+    update:
+        Update the user who requested authorization from a repository
+
+    partial_update:
+        Update the user who requested authorization from a repository
+
+    destroy:
+        Removes the user who requested authorization from a repository
     """
     queryset = RequestRepositoryAuthorization.objects.exclude(
         approved_by__isnull=False)
@@ -455,14 +505,17 @@ class RepositoryExampleViewSet(
     """
     Manager repository example.
 
+    create:
+        Create repository example data.
+
     retrieve:
-    Get repository example data.
+        Get repository example data.
 
     delete:
-    Delete repository example.
+        Delete repository example.
 
     update:
-    Update repository example.
+        Update repository example.
 
     """
     queryset = RepositoryExample.objects
@@ -484,6 +537,12 @@ def perform_destroy(self, obj):
 class RepositoryUpdatesViewSet(
       mixins.ListModelMixin,
       GenericViewSet):
+
+    """
+    list:
+        List all trainings repository
+    """
+
     queryset = RepositoryUpdate.objects.filter(
         training_started_at__isnull=False).order_by('-trained_at')
     serializer_class = RepositoryUpdateSerializer