From 6260a1f9c3ad438a440c8eae7da0223f6bdedbb3 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: Mon, 10 Feb 2020 10:39:38 +0300 Subject: [PATCH] add docstring for back-office users --- apps/news/views.py | 33 +++++++++++++++++++++++++++++++-- 1 file changed, 31 insertions(+), 2 deletions(-) diff --git a/apps/news/views.py b/apps/news/views.py index e72fb8b5..5b4e5b88 100644 --- a/apps/news/views.py +++ b/apps/news/views.py @@ -54,7 +54,14 @@ class NewsMixinView: class NewsStatesView(generics.ListAPIView): - """Possible project news states""" + """ + Possible project news states + + **GET** + ``` + Implement getting list for NewsStates. + ``` + """ pagination_class = None serializer_class = serializers.NewsStatesSerializer @@ -287,7 +294,29 @@ class NewsBackOfficeGalleryListView(NewsBackOfficeMixinView, class NewsBackOfficeRUDView(NewsBackOfficeMixinView, generics.RetrieveUpdateDestroyAPIView): - """Resource for detailed information about news for back-office users.""" + """ + Resource for detailed information about news for back-office users. + + **GET** + ``` + Implement getting back-office users object. + ``` + + **PUT** + ``` + Implement updating back-office users. + ``` + + **PATCH** + ``` + Implement partial updating back-office users. + ``` + + **DELETE** + ``` + Implement deleting back-office users. + ``` + """ serializer_class = serializers.NewsBackOfficeDetailSerializer def get(self, request, pk, *args, **kwargs):