encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-11-04 09:57:55 +03:00
Code Issues Packages Projects Releases Wiki Activity

Added examples to schema of CursorPagination (#8687)

Browse Source 
* Added examples to schema of CursorPagination

Fix https://github.com/encode/django-rest-framework/issues/8686

Added missing examples for CursorPagination class to disable warnings in https://github.com/tfranzel/drf-spectacular and make it consistent with other pagination classes.

* Adapted test case for paginated response schema
This commit is contained in:
Norbert Schuler 2022-10-11 12:50:33 +02:00 committed by GitHub
parent d507cd851c
commit 911b207fa1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
rest_framework/pagination.py
View File

@ -898,10 +898,16 @@ class CursorPagination(BasePagination):
'next': { 'next': {
'type': 'string', 'type': 'string',
'nullable': True, 'nullable': True,
'format': 'uri',
'example': 'http://api.example.org/accounts/?{cursor_query_param}=cD00ODY%3D"'.format(
cursor_query_param=self.cursor_query_param)
}, },
'previous': { 'previous': {
'type': 'string', 'type': 'string',
'nullable': True, 'nullable': True,
'format': 'uri',
'example': 'http://api.example.org/accounts/?{cursor_query_param}=cj0xJnA9NDg3'.format(
cursor_query_param=self.cursor_query_param)
}, },
'results': schema, 'results': schema,
}, },

4
tests/test_pagination.py
View File

@ -922,10 +922,14 @@ class CursorPaginationTestsMixin:
'next': { 'next': {
'type': 'string', 'type': 'string',
'nullable': True, 'nullable': True,
'format': 'uri',
'example': 'http://api.example.org/accounts/?cursor=cD00ODY%3D"'
}, },
'previous': { 'previous': {
'type': 'string', 'type': 'string',
'nullable': True, 'nullable': True,
'format': 'uri',
'example': 'http://api.example.org/accounts/?cursor=cj0xJnA9NDg3'
}, },
'results': unpaginated_schema, 'results': unpaginated_schema,
}, },