upgrade documentation -> Account app

develop
TBS093A 2020-06-21 12:16:36 +02:00
parent 6a54b4d959
commit 709df5fb90
2 changed files with 17 additions and 3 deletions

View File

@ -26,8 +26,12 @@ class AnonAndUserPermissions(permissions.BasePermission):
class AccountViewSet(viewsets.ModelViewSet): class AccountViewSet(viewsets.ModelViewSet):
""" """
A User CRUD `retrieve()`, `list()` and abstract `create()` (`create()` is register) A User CRUD (abstract from `viewsets.ModelViewSet`):
and `update()` from class `ModelViewSet` in viewsets `GET`: `list()`
`GET`: `retrieve()` /parameter {id}
`POST`: `create()`
`PUT`&`PATCH`: `update()` /parameter {id}
`DELETE`: `destroy()` /parameter {id}
""" """
queryset = Account.objects.all() queryset = Account.objects.all()
serializer_class = AccountSerializer serializer_class = AccountSerializer
@ -48,7 +52,9 @@ class AccountViewSet(viewsets.ModelViewSet):
class AccountAuth(ObtainAuthToken): class AccountAuth(ObtainAuthToken):
""" """
A User Authorization `login()`, `logout()` A User Authorization (abstract from ObtainAuthToken):
`POST`: `login()` /create auth token
`DELETE`: `logout()` /get auth token from header
""" """
queryset = Account.objects.all() queryset = Account.objects.all()
serializer_class = AccountAuthSerializer serializer_class = AccountAuthSerializer
@ -70,6 +76,14 @@ class AccountAuth(ObtainAuthToken):
class GuestViewSet(viewsets.ModelViewSet): class GuestViewSet(viewsets.ModelViewSet):
"""
A Guest CRUD (abstract from `viewsets.ModelViewSet`):
`GET`: `list()`
`GET`: `retrieve()` /parameter {id}
`POST`: `create()`
`PUT`&`PATCH`: `update()` /parameter {id}
`DELETE`: `destroy()` /parameter {id}
"""
queryset = Guest.objects.all() queryset = Guest.objects.all()
serializer_class = GuestSerializer serializer_class = GuestSerializer
permission_classes = (AnonAndUserPermissions, ) permission_classes = (AnonAndUserPermissions, )