Improve pagination openapi schema

* add all properties on pagination class schemas to `required` attribute

This helps the client code generators can add necessary validations/enable null-safe implementations.
This commit is contained in:
Rohit Reddy Abbadi 2022-03-22 23:39:37 +05:30 committed by GitHub
parent 070c32f4a6
commit 513fdb2e75
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -253,6 +253,12 @@ class PageNumberPagination(BasePagination):
}, },
'results': schema, 'results': schema,
}, },
'required': [
'count',
'next',
'previous',
'results',
],
} }
def get_page_size(self, request): def get_page_size(self, request):
@ -426,6 +432,12 @@ class LimitOffsetPagination(BasePagination):
}, },
'results': schema, 'results': schema,
}, },
'required': [
'count',
'next',
'previous',
'results',
],
} }
def get_limit(self, request): def get_limit(self, request):
@ -912,6 +924,11 @@ class CursorPagination(BasePagination):
}, },
'results': schema, 'results': schema,
}, },
'required': [
'next',
'previous',
'results',
],
} }
def get_html_context(self): def get_html_context(self):