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

add required fields on paginator schemas

Browse Source 
`required: [count, responses]` or `required: [responses]` added to schema returned by pagination classes
 to specify which fields are required on a paginated response so that client code generators can add necessary
 validations/enable null-safe implementations.
This commit is contained in:
Rohit Reddy Abbadi 2021-09-26 02:14:00 +05:30 committed by GitHub
parent c62e3ca764
commit 3e13be321f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
rest_framework/pagination.py
View File

@ -253,6 +253,10 @@ class PageNumberPagination(BasePagination):
},
'results': schema,
},
'required': [
'count',
'results',
],
}
def get_page_size(self, request):
@ -426,6 +430,10 @@ class LimitOffsetPagination(BasePagination):
},
'results': schema,
},
'required': [
'count',
'results',
],
}
def get_limit(self, request):
@ -911,7 +919,10 @@ class CursorPagination(BasePagination):
'nullable': True,
},
'results': schema,
},
},,
'required': [
'results',
],
}
def get_html_context(self):