Unbounded api v1 notices pagination - #3137
Open
mikelolasagasti wants to merge 2 commits into
Open
mikelolasagasti wants to merge 2 commits into
mikelolasagasti wants to merge 2 commits into
Conversation
The notices endpoint currently materializes every matching notice with to_a. Without date filters, a single request can load the entire notices collection into memory and exhaust application workers on larger datasets. Add deterministic pagination with a default and maximum page size of 100. Invalid pagination values use safe defaults, while date filtering, authentication, response formats, and response fields remain unchanged. Add controller coverage for pagination boundaries and invalid parameters.
The API v1 notices endpoint has no dedicated documentation, making its authentication, filtering, response formats, and pagination behavior difficult to discover. Document the current API v1 contract with JSON and XML examples, pagination parameters, bounded responses, authentication behavior, and global visibility.
mikelolasagasti
force-pushed
the
unbounded-api-v1-notices-pagination
branch
from
September 4, 2026 14:39
0b3b522 to
5657855
Compare
This branch has not been deployed
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
1 participant
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.
The API v1 notices endpoint currently loads all matching notices into memory, which can exhaust workers on large datasets.
This adds deterministic pagination with a default and maximum page size of 100, while preserving existing filters, response formats, fields, and authentication.
The intentional compatibility change is documented in the v0.11.6 release notes.
Closes #3136