matthias/mayan-edms
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Consolidate the docstring of the API methods into a class docstring.

Browse Source 
Signed-off-by: Michael Price <loneviking72@gmail.com>
This commit is contained in:
Michael Price
2018-03-13 18:13:24 -04:00
committed by Roberto Rosario
parent ff9e291cd7
commit 1fc06a350b
18 changed files with 273 additions and 1132 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
mayan/apps/permissions/api_views.py
View File

@@ -17,31 +17,24 @@ from .serializers import (
class APIPermissionList(generics.ListAPIView):
"""
get: Returns a list of all the available permissions.
"""
serializer_class = PermissionSerializer
queryset = Permission.all()
def get(self, *args, **kwargs):
"""
Returns a list of all the available permissions.
"""
return super(APIPermissionList, self).get(*args, **kwargs)
class APIRoleListView(generics.ListCreateAPIView):
"""
get: Returns a list of all the roles.
post: Create a new role.
"""
filter_backends = (MayanObjectPermissionsFilter,)
mayan_object_permissions = {'GET': (permission_role_view,)}
mayan_view_permissions = {'POST': (permission_role_create,)}
permission_classes = (MayanPermission,)
queryset = Role.objects.all()
def get(self, *args, **kwargs):
"""
Returns a list of all the roles.
"""
return super(APIRoleListView, self).get(*args, **kwargs)
def get_serializer(self, *args, **kwargs):
if not self.request:
return None
@@ -54,15 +47,14 @@ class APIRoleListView(generics.ListCreateAPIView):
elif self.request.method == 'POST':
return WritableRoleSerializer
def post(self, *args, **kwargs):
"""
Create a new role.
"""
return super(APIRoleListView, self).post(*args, **kwargs)
class APIRoleView(generics.RetrieveUpdateDestroyAPIView):
"""
delete: Delete the selected role.
get: Return the details of the selected role.
patch: Edit the selected role.
put: Edit the selected role.
"""
mayan_object_permissions = {
'GET': (permission_role_view,),
'PUT': (permission_role_edit,),
@@ -72,20 +64,6 @@ class APIRoleView(generics.RetrieveUpdateDestroyAPIView):
permission_classes = (MayanPermission,)
queryset = Role.objects.all()
def delete(self, *args, **kwargs):
"""
Delete the selected role.
"""
return super(APIRoleView, self).delete(*args, **kwargs)
def get(self, *args, **kwargs):
"""
Return the details of the selected role.
"""
return super(APIRoleView, self).get(*args, **kwargs)
def get_serializer(self, *args, **kwargs):
if not self.request:
return None
@@ -97,17 +75,3 @@ class APIRoleView(generics.RetrieveUpdateDestroyAPIView):
return RoleSerializer
elif self.request.method in ('PATCH', 'PUT'):
return WritableRoleSerializer
def patch(self, *args, **kwargs):
"""
Edit the selected role.
"""
return super(APIRoleView, self).patch(*args, **kwargs)
def put(self, *args, **kwargs):
"""
Edit the selected role.
"""
return super(APIRoleView, self).put(*args, **kwargs)