NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-07-23 04:22:01 -06:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Handle unspecified limit explicitly so as to return min(PAGINATE_COUNT, MAX_PAGE_SIZE)

Browse Source
This commit is contained in:
Brian Tiemann 2024-12-05 15:49:36 -05:00
parent af2768aa3d
commit 647c7c9579
2 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
netbox/netbox/api/pagination.py
View File

@ -38,12 +38,14 @@ class OptionalLimitOffsetPagination(LimitOffsetPagination):
def get_limit(self, request): def get_limit(self, request):
if self.limit_query_param: if self.limit_query_param:
MAX_PAGE_SIZE = get_config().MAX_PAGE_SIZE
if self.limit_query_param not in request.query_params:
return min(self.default_limit, MAX_PAGE_SIZE)
try: try:
limit = int(request.query_params.get(self.limit_query_param, 0)) limit = int(request.query_params.get(self.limit_query_param, 0))
if limit < 0: if limit < 0:
raise ValueError() raise ValueError()
# Enforce maximum page size, if defined # Enforce maximum page size, if defined
MAX_PAGE_SIZE = get_config().MAX_PAGE_SIZE
if MAX_PAGE_SIZE: if MAX_PAGE_SIZE:
return min(self.default_limit, MAX_PAGE_SIZE) if limit == 0 else min(limit, MAX_PAGE_SIZE) return min(self.default_limit, MAX_PAGE_SIZE) if limit == 0 else min(limit, MAX_PAGE_SIZE)
return limit return limit

12
netbox/utilities/tests/test_api.py
View File

@ -144,6 +144,18 @@ class APIPaginationTestCase(APITestCase):
self.assertIsNone(response.data['previous']) self.assertIsNone(response.data['previous'])
self.assertEqual(len(response.data['results']), page_size) self.assertEqual(len(response.data['results']), page_size)
@override_settings(MAX_PAGE_SIZE=30)
def test_default_page_size_with_small_max_page_size(self):
response = self.client.get(self.url, format='json', **self.header)
page_size = get_config().MAX_PAGE_SIZE
self.assertLess(page_size, 100, "Default page size not sufficient for data set")
self.assertHttpStatus(response, status.HTTP_200_OK)
self.assertEqual(response.data['count'], 100)
self.assertTrue(response.data['next'].endswith(f'?limit={page_size}&offset={page_size}'))
self.assertIsNone(response.data['previous'])
self.assertEqual(len(response.data['results']), page_size)
def test_custom_page_size(self): def test_custom_page_size(self):
response = self.client.get(f'{self.url}?limit=10', format='json', **self.header) response = self.client.get(f'{self.url}?limit=10', format='json', **self.header)