Add MAX_PAGE_SIZE setting #9107
Conversation
|
OK I saw the comment now #6185 (comment) it might be possible in class level but not globally at the moment. |
|
@auvipy I added tests for system checks, but didn't managed to find and add tests for settings with API requests like in |
|
we got a PR related to this area #8993. would be helpful if you review and share your views on the PR. |
|
@auvipy @christophehenry @TheSuperiorStanislav If you don't mind, I can take this up and implement the changes requested |
TheSuperiorStanislav
force-pushed
the
add-max-page-setting-for-pagination
branch
from
456a1fe to
b51141c
Compare
|
@auvipy @christophehenry Could you please take a look? Sorry for taking that long, btw 🥲 |
| def page_size(self) -> int: | ||
| """Get default page size. | ||
|
|
||
| Defaults to `None`, meaning pagination is disabled. | ||
|
|
||
| """ |
There was a problem hiding this comment.
There shoud probably be a comment explaining why this i a property to avoid removing it in a future refactor?
|
Looks good to me. Thank you. |
|
@auvipy Could you take a look, please? This pr has been here for a while) |
| limit_query_param = 'limit' | ||
| limit_query_description = _('Number of results to return per page.') | ||
| offset_query_param = 'offset' | ||
| offset_query_description = _('The initial index from which to return the results.') | ||
| max_limit = None |
There was a problem hiding this comment.
Can we avoid changing the style here?
max_limit = api_settings.MAX_PAGE_SIZEPerfer minimal impact footprints for PRs.
There was a problem hiding this comment.
It's related to #8993 and #9107 (comment). Without it we can't properly test it, since this setting will be set during init.
There was a problem hiding this comment.
Hrm... not sure? If you'd like to take that approach then I'd probably suggest handling #8993 separately, as a precursor to this.
Unclear to me why that'd be different to attributes we use in other cases.
Description
Add a setting for max page size for global pagination. Our team discovered that by default, page size is unlimited which could lead to API abuse and the only way to fix it -> it's to subclass pagination class(which is a working solution, but not convenient). After investigating issues I found related issue and comment.