Skip to content

Correct default number of items per page #4312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Correct default number of items per page #4312

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
da8ee62
doc updated
waldirio Sep 26, 2025
d8fbd1f
doc updated
waldirio Sep 29, 2025
c8f90c3
doc updated
waldirio Sep 29, 2025
956b8b5
doc updated
waldirio Sep 29, 2025
c56797d
doc updated
waldirio Sep 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion guides/common/modules/proc_using-searches-with-pagination-control.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
You can use the `per_page` and `page` pagination parameters to limit the search results that an API search query returns.
The `per_page` parameter specifies the number of results per page and the `page` parameter specifies which page, as calculated by the `per_page` parameter, to return.

The default number of items to return is set to 1000 when you do not specify any pagination parameters, but the `per_page` value has a default of 20 which applies when you specify the `page` parameter.
The default number of items to be presented is set to `20`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/theforeman/foreman/blob/d048dc1e435cf3dd5d391607cdc7928f6713ee87/config/initializers/core_extensions.rb#L13-L18 is the logic for that. So it's the entries_per_page setting with a fallback to 20. The entries_per_page setting also defaults to 20 (https://github.com/theforeman/foreman/blob/d048dc1e435cf3dd5d391607cdc7928f6713ee87/config/initializers/f_foreman_settings_general.rb#L18-L22) but can obviously be changed by users.

This behavior dates back to theforeman/foreman@454fd3a (2011).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @ekohl, would it be okay to create a new issue for your comment? What I'm taking from this is that @waldirio's PR is correct as is and if that's the case, I'd rather accept it and track your suggestion in an issue.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically @waldirio is only correct for installations where the entries_per_page setting is set to 20. By default that's true, but it doesn't have to be.

I'd suggest something like:

The number of items to be presented is set using the setting entries_per_page, which defaults to 20.
However, you can change it per request by using the parameter per_page.

However, you can change it by using the parameter `per_page` parameter.

This example returns a list of architectures for an organization with ID `1` in pages.
The list contains 5 entries per page and returns the second page.
Expand Down