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

Fix: Pagination response schemas. (#9049)

Browse Source
This commit is contained in:
Sergey Klyuykov 2023-07-15 02:26:56 -07:00 committed by GitHub
parent 66d86d0177
commit 7658ffd71d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
rest_framework/pagination.py
View File

@ -239,6 +239,7 @@ class PageNumberPagination(BasePagination):
def get_paginated_response_schema(self, schema): def get_paginated_response_schema(self, schema):
return { return {
'type': 'object', 'type': 'object',
'required': ['count', 'results'],
'properties': { 'properties': {
'count': { 'count': {
'type': 'integer', 'type': 'integer',
@ -411,6 +412,7 @@ class LimitOffsetPagination(BasePagination):
def get_paginated_response_schema(self, schema): def get_paginated_response_schema(self, schema):
return { return {
'type': 'object', 'type': 'object',
'required': ['count', 'results'],
'properties': { 'properties': {
'count': { 'count': {
'type': 'integer', 'type': 'integer',
@ -906,6 +908,7 @@ class CursorPagination(BasePagination):
def get_paginated_response_schema(self, schema): def get_paginated_response_schema(self, schema):
return { return {
'type': 'object', 'type': 'object',
'required': ['results'],
'properties': { 'properties': {
'next': { 'next': {
'type': 'string', 'type': 'string',

3
tests/test_pagination.py
View File

@ -274,6 +274,7 @@ class TestPageNumberPagination:
assert self.pagination.get_paginated_response_schema(unpaginated_schema) == { assert self.pagination.get_paginated_response_schema(unpaginated_schema) == {
'type': 'object', 'type': 'object',
'required': ['count', 'results'],
'properties': { 'properties': {
'count': { 'count': {
'type': 'integer', 'type': 'integer',
@ -585,6 +586,7 @@ class TestLimitOffset:
assert self.pagination.get_paginated_response_schema(unpaginated_schema) == { assert self.pagination.get_paginated_response_schema(unpaginated_schema) == {
'type': 'object', 'type': 'object',
'required': ['count', 'results'],
'properties': { 'properties': {
'count': { 'count': {
'type': 'integer', 'type': 'integer',
@ -937,6 +939,7 @@ class CursorPaginationTestsMixin:
assert self.pagination.get_paginated_response_schema(unpaginated_schema) == { assert self.pagination.get_paginated_response_schema(unpaginated_schema) == {
'type': 'object', 'type': 'object',
'required': ['results'],
'properties': { 'properties': {
'next': { 'next': {
'type': 'string', 'type': 'string',