From 6987daeea412a9fdfde1a0c517b11c4d9b8f3755 Mon Sep 17 00:00:00 2001
From: Anatoly <a.feteleu@spider.ru>
Date: Mon, 10 Feb 2020 15:14:01 +0300
Subject: [PATCH] done "GM-370"

---
 apps/establishment/views/back.py | 84 ++++++++++++++++++++++++++++++--
 1 file changed, 80 insertions(+), 4 deletions(-)

diff --git a/apps/establishment/views/back.py b/apps/establishment/views/back.py
index 46a2f7a2..a3d6387d 100644
--- a/apps/establishment/views/back.py
+++ b/apps/establishment/views/back.py
@@ -1269,7 +1269,41 @@ class EstablishmentCompanyRUDView(EstablishmentMixinViews,
 
 class EstablishmentNoteListCreateView(EstablishmentMixinViews,
                                       generics.ListCreateAPIView):
-    """Retrieve|Update|Destroy establishment note view."""
+    """
+    ## List/Create view
+    ### *GET*
+    #### Description
+    Return paginated list of establishment notes by `establishment slug`
+    ##### Response
+    E.g.:
+    ```
+    {
+      "count": 58,
+      "next": 2,
+      "previous": null,
+      "results": [
+        {
+            "id": 1,
+            ...
+        }
+      ]
+    }
+    ```
+    ### *POST*
+    #### Description
+    Create new note for establishment by `establishment slug`
+    ##### Request
+    Required
+    * text (`str`) - text of note
+    ##### Response
+    E.g.:
+    ```
+    {
+        "id": 1,
+        ...
+    }
+    ```
+    """
 
     lookup_field = 'slug'
     serializer_class = serializers.EstablishmentNoteListCreateSerializer
@@ -1291,13 +1325,55 @@ class EstablishmentNoteListCreateView(EstablishmentMixinViews,
         return establishment
 
     def get_queryset(self):
-        """Overridden get_queryset method."""
+        """An overridden get_queryset method."""
         return self.get_object().notes.all()
 
 
 class EstablishmentNoteRUDView(EstablishmentMixinViews,
                                generics.RetrieveUpdateDestroyAPIView):
-    """Create|Retrieve|Update|Destroy establishment note view."""
+    """
+    ## Retrieve/Update/Destroy view
+    ### *GET*
+    #### Description
+    Return paginated list of establishment notes by `establishment slug`
+    ##### Response
+    E.g.:
+    ```
+    {
+      "count": 58,
+      "next": 2,
+      "previous": null,
+      "results": [
+        {
+            "id": 1,
+            ...
+        }
+      ]
+    }
+    ```
+    ### *PUT*/*PATCH*
+    #### Description
+    Completely/Partially update a note object by an identifier.
+    ##### Request
+    Available
+    * text (`str`) - text of note
+    ##### Response
+    E.g.:
+    ```
+    {
+        "id": 1,
+        ...
+    }
+    ```
+    ### *DELETE*
+    #### Description
+    Delete establishment note by `establishment slug`
+    ##### Response
+    E.g.:
+    ```
+    No content
+    ```
+    """
 
     lookup_field = 'slug'
     serializer_class = serializers.EstablishmentNoteBaseSerializer
@@ -1314,7 +1390,7 @@ class EstablishmentNoteRUDView(EstablishmentMixinViews,
         establishment = get_object_or_404(filtered_establishment_qs, slug=self.kwargs.get('slug'))
         note = get_object_or_404(establishment.notes.all(), pk=self.kwargs['note_pk'])
 
-        # May raise a permission denied
+        # May a raise a permission denied
         self.check_object_permissions(self.request, note)
 
         return note