Document per_page max and silent clamping of oversized values - #45189
Conversation
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
|
Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert 👀 |
|
@jornith Also checking in about this one. |
|
@jornith This one also looks good, thanks! |
|
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
Why:
Closes: #45188
What's being changed (if available, include any code snippets, screenshots, or gifs):
Adds a paragraph to the "Changing the number of items per page" section of the pagination guide documenting that
per_pageis capped at 100 for most endpoints, and that values above the maximum are silently reduced rather than rejected. The request still returns200 OK, so a caller relying on an oversizedper_pagecan under-fetch results without any indication.Verified against the live API:
per_page=100000returns200with the page clamped to 100 items (repro:test_oversized_per_page_is_clamped_not_rejectedin https://github.com/jornith/octoprobe).Check off the following: