From fb3fc25a3d782e2ba0d91e7add3dca65061f866c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=90=D0=BB=D0=B5=D0=BA=D1=81=D0=B0=D0=BD=D0=B4=D1=80=20?= =?UTF-8?q?=D0=9F=D0=B0=D1=80=D1=85=D0=BE=D0=BC=D0=B8=D0=BD?= Date: Fri, 7 Feb 2020 12:01:49 +0300 Subject: [PATCH] add docstring for Comment --- apps/comment/views/back.py | 40 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 38 insertions(+), 2 deletions(-) diff --git a/apps/comment/views/back.py b/apps/comment/views/back.py index bcc889be..aeb6bc61 100644 --- a/apps/comment/views/back.py +++ b/apps/comment/views/back.py @@ -7,7 +7,20 @@ from utils.permissions import IsModerator class CommentLstView(generics.ListCreateAPIView): - """Comment list create view.""" + """ + Comment list create view. + By id, type, object. + + **GET** + ``` + Implement getting Comment list. + ``` + + **POST** + ``` + Implement creating Comment. + ``` + """ def get_queryset(self): from product.models import Product from establishment.models import Establishment @@ -37,7 +50,30 @@ class CommentLstView(generics.ListCreateAPIView): class CommentRUDView(generics.RetrieveUpdateDestroyAPIView): - """Comment RUD view.""" + """ + Comment RUD view. + By id, type, object. + + **GET** + ``` + Implement getting Comment object. + ``` + + **PUT** + ``` + Implement updating Comment. + ``` + + **PATCH** + ``` + Implement partial updating Comment. + ``` + + **DELETE** + ``` + Implement deleting Comment. + ``` + """ serializer_class = CommentBaseSerializer queryset = models.Comment.objects.all() permission_classes = get_permission_classes(IsModerator)