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

96
mayan/apps/document_indexing/api_views.py
View File

@@ -22,28 +22,24 @@ from .serializers import (
class APIIndexListView(generics.ListCreateAPIView):
"""
get: Returns a list of all the defined indexes.
post: Create a new index.
"""
filter_backends = (MayanObjectPermissionsFilter,)
mayan_object_permissions = {'GET': (permission_document_indexing_view,)}
mayan_view_permissions = {'POST': (permission_document_indexing_create,)}
queryset = Index.objects.all()
serializer_class = IndexSerializer
def get(self, *args, **kwargs):
"""
Returns a list of all the defined indexes.
"""
return super(APIIndexListView, self).get(*args, **kwargs)
def post(self, *args, **kwargs):
"""
Create a new index.
"""
return super(APIIndexListView, self).post(*args, **kwargs)
class APIIndexView(generics.RetrieveUpdateDestroyAPIView):
"""
delete: Delete the selected index.
get: Returns the details of the selected index.
patch: Partially edit an index.
put: Edit an index.
"""
mayan_object_permissions = {
'GET': (permission_document_indexing_view,),
'PUT': (permission_document_indexing_edit,),
@@ -54,34 +50,6 @@ class APIIndexView(generics.RetrieveUpdateDestroyAPIView):
queryset = Index.objects.all()
serializer_class = IndexSerializer
def delete(self, *args, **kwargs):
"""
Delete the selected index.
"""
return super(APIIndexView, self).delete(*args, **kwargs)
def get(self, *args, **kwargs):
"""
Returns the details of the selected index.
"""
return super(APIIndexView, self).get(*args, **kwargs)
def patch(self, *args, **kwargs):
"""
Partially edit an index.
"""
return super(APIIndexView, self).patch(*args, **kwargs)
def put(self, *args, **kwargs):
"""
Edit an index.
"""
return super(APIIndexView, self).put(*args, **kwargs)
class APIIndexNodeInstanceDocumentListView(generics.ListAPIView):
"""
@@ -106,19 +74,21 @@ class APIIndexNodeInstanceDocumentListView(generics.ListAPIView):
class APIIndexTemplateListView(generics.ListAPIView):
"""
get: Returns a list of all the template nodes for the selected index.
"""
filter_backends = (MayanObjectPermissionsFilter,)
mayan_object_permissions = {'GET': (permission_document_indexing_view,)}
serializer_class = IndexTemplateNodeSerializer
def get(self, *args, **kwargs):
"""
Returns a list of all the template nodes for the selected index.
"""
return super(APIIndexTemplateListView, self).get(*args, **kwargs)
class APIIndexTemplateView(generics.RetrieveUpdateDestroyAPIView):
"""
delete: Delete the selected index template node.
get: Returns the details of the selected index template node.
patch: Partially edit an index template node.
put: Edit an index template node.
"""
serializer_class = IndexTemplateNodeSerializer
queryset = IndexTemplateNode.objects.all()
@@ -130,34 +100,6 @@ class APIIndexTemplateView(generics.RetrieveUpdateDestroyAPIView):
'DELETE': (permission_document_indexing_edit,)
}
def delete(self, *args, **kwargs):
"""
Delete the selected index template node.
"""
return super(APIIndexTemplateView, self).delete(*args, **kwargs)
def get(self, *args, **kwargs):
"""
Returns the details of the selected index template node.
"""
return super(APIIndexTemplateView, self).get(*args, **kwargs)
def patch(self, *args, **kwargs):
"""
Partially edit an index template node.
"""
return super(APIIndexTemplateView, self).patch(*args, **kwargs)
def put(self, *args, **kwargs):
"""
Edit an index template node.
"""
return super(APIIndexTemplateView, self).put(*args, **kwargs)
class APIDocumentIndexListView(generics.ListAPIView):
"""