diff --git a/makedoc/views.py b/makedoc/views.py index 366af27..e70d900 100644 --- a/makedoc/views.py +++ b/makedoc/views.py @@ -14,7 +14,10 @@ from .serializers import DataDocSerializer, DocumentsSimpleSerializer, FileNameSerializer -class CreateDocsView(APIView): +class CreateDocsAPIView(APIView): + """ + Responsible for creating documents based on data from the cache. + """ serializer_class = DocumentsSimpleSerializer permission_classes = [IsAuthenticated] @@ -49,7 +52,15 @@ def get(self, request, *args, **kwargs): return Response({"message": "Documents saved"}, status=status.HTTP_200_OK) +# Загрузка документа class DownloadDocAPIView(APIView): + """ + To download a file: + + - No parameters: get the last created file. + + - With the parameter {"file_name": "name your file"} - load a specific file from the list. + """ permission_classes = [IsAuthenticated] def post(self, request, *args, **kwargs): @@ -81,7 +92,10 @@ def post(self, request, *args, **kwargs): return response -class DataDocView(generics.GenericAPIView[Any]): +class DataDocAPIView(generics.GenericAPIView[Any]): + """ + Responsible for receiving data, validating it and storing it in cache. + """ serializer_class = DataDocSerializer permission_classes = (IsAuthenticated,) diff --git a/users/views.py b/users/views.py index e873b81..43b65ee 100644 --- a/users/views.py +++ b/users/views.py @@ -72,8 +72,10 @@ class UserUpdatePasswordView(UserRelatedView): serializer_class = UserUpdatePasswordSerializer -# Отображение списка документов пользователя class ListUserFilesAPIView(APIView): + """ + Responsible for displaying a list of documents of an authorized user. + """ permission_classes = (IsAuthenticated,) def get(self, request, *args, **kwargs):