diff options
| author | 2020-10-06 21:21:53 +0530 | |
|---|---|---|
| committer | 2020-10-06 21:21:53 +0530 | |
| commit | 3eee5e76894995cea87391d60c9749eb66b3187a (patch) | |
| tree | e5e7ac061aa70e2b4c07742eb8010fbb50c7f64b | |
| parent | Merge branch 'user_endpoint' of https://github.com/RohanJnr/site into user_en... (diff) | |
Update docstring of UserViewSet and correct function annotation on UserListPagination
| -rw-r--r-- | pydis_site/apps/api/viewsets/bot/user.py | 9 | 
1 files changed, 5 insertions, 4 deletions
diff --git a/pydis_site/apps/api/viewsets/bot/user.py b/pydis_site/apps/api/viewsets/bot/user.py index 0dd529be..ebea6a45 100644 --- a/pydis_site/apps/api/viewsets/bot/user.py +++ b/pydis_site/apps/api/viewsets/bot/user.py @@ -1,3 +1,4 @@ +import typing  from collections import OrderedDict  from rest_framework import status @@ -18,14 +19,14 @@ class UserListPagination(PageNumberPagination):      page_size = 10000      page_size_query_param = "page_size" -    def get_next_page_number(self) -> int: +    def get_next_page_number(self) -> typing.Optional[int]:          """Get the next page number."""          if not self.page.has_next():              return None          page_number = self.page.next_page_number()          return page_number -    def get_previous_page_number(self) -> int: +    def get_previous_page_number(self) -> typing.Optional[int]:          """Get the previous page number."""          if not self.page.has_previous():              return None @@ -54,8 +55,8 @@ class UserViewSet(ModelViewSet):      #### Response format      >>> {      ...     'count': 95000, -    ...     'next': "http://api.pythondiscord.com/bot/users?page=2", -    ...     'previous': None, +    ...     'next_page_no': "2", +    ...     'previous_page_no': None,      ...     'results': [      ...      {      ...         'id': 409107086526644234,  |