Document per_page max and silent clamping of oversized values#45189
Open
jornith wants to merge 1 commit into
Open
Document per_page max and silent clamping of oversized values#45189jornith wants to merge 1 commit into
jornith wants to merge 1 commit into
Conversation
Contributor
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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: