encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-07-28 08:59:54 +03:00
Code Issues Packages Projects Releases Wiki Activity

improve schema for pagination

Browse Source
This commit is contained in:
Dhaval Mehta 2020-04-17 04:45:55 +05:30
parent b2497fc245
commit ff48159d96
2 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
rest_framework/pagination.py
View File

@ -236,10 +236,16 @@ class PageNumberPagination(BasePagination):
'next': { 'next': {
'type': 'string', 'type': 'string',
'nullable': True, 'nullable': True,
'format': 'uri',
'example': 'http://api.example.org/accounts/?{page_query_param}=4'.format(
page_query_param=self.page_query_param)
}, },
'previous': { 'previous': {
'type': 'string', 'type': 'string',
'nullable': True, 'nullable': True,
'format': 'uri',
'example': 'http://api.example.org/accounts/?{page_query_param}=2'.format(
page_query_param=self.page_query_param)
}, },
'results': schema, 'results': schema,
}, },
@ -403,10 +409,16 @@ class LimitOffsetPagination(BasePagination):
'next': { 'next': {
'type': 'string', 'type': 'string',
'nullable': True, 'nullable': True,
'format': 'uri',
'example': 'http://api.example.org/accounts/?{offset_param}=400&{limit_param}=100'.format(
offset_param=self.offset_query_param, limit_param=self.limit_query_param),
}, },
'previous': { 'previous': {
'type': 'string', 'type': 'string',
'nullable': True, 'nullable': True,
'format': 'uri',
'example': 'http://api.example.org/accounts/?{offset_param}=200&{limit_param}=100'.format(
offset_param=self.offset_query_param, limit_param=self.limit_query_param),
}, },
'results': schema, 'results': schema,
}, },

8
tests/test_pagination.py
View File

@ -281,10 +281,14 @@ class TestPageNumberPagination:
'next': { 'next': {
'type': 'string', 'type': 'string',
'nullable': True, 'nullable': True,
'format': 'uri',
'example': 'http://api.example.org/accounts/?page=4',
}, },
'previous': { 'previous': {
'type': 'string', 'type': 'string',
'nullable': True, 'nullable': True,
'format': 'uri',
'example': 'http://api.example.org/accounts/?page=2',
}, },
'results': unpaginated_schema, 'results': unpaginated_schema,
}, },
@ -588,10 +592,14 @@ class TestLimitOffset:
'next': { 'next': {
'type': 'string', 'type': 'string',
'nullable': True, 'nullable': True,
'format': 'uri',
'example': 'http://api.example.org/accounts/?offset=400&limit=100',
}, },
'previous': { 'previous': {
'type': 'string', 'type': 'string',
'nullable': True, 'nullable': True,
'format': 'uri',
'example': 'http://api.example.org/accounts/?offset=200&limit=100',
}, },
'results': unpaginated_schema, 'results': unpaginated_schema,
}, },