Fix BadMapError when page param is not using bracket notation#407
Merged
zachdaniel merged 1 commit intoash-project:mainfrom Jan 15, 2026
Merged
Fix BadMapError when page param is not using bracket notation#407zachdaniel merged 1 commit intoash-project:mainfrom
zachdaniel merged 1 commit intoash-project:mainfrom
Conversation
When clients send page parameter as a string (e.g., page={"limit":1})
instead of bracket notation (page[limit]=1), the pagination code would
crash with a BadMapError when calling Map.fetch on the string.
This adds a guard clause to fetch_pagination_parameters that detects
when page is a binary string and returns a structured 400 error
explaining the correct format, instead of crashing with a 500.
JSON:API spec requires bracket notation for nested query parameters.
zachdaniel
approved these changes
Jan 15, 2026
Contributor
|
🚀 Thank you for your contribution! 🚀 |
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
2 participants
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.
A client complained of 500 errors when they were sending query params as json in the query param by accident. It should return a structured error instead of 500'ing.
Issue and fix:
When clients send page parameter as a string (e.g., page={"limit":1})
instead of bracket notation (page[limit]=1), the pagination code would
crash with a BadMapError when calling Map.fetch on the string.
This adds a guard clause to fetch_pagination_parameters that detects
when page is a binary string and returns a structured 400 error
explaining the correct format, instead of crashing with a 500.
JSON:API spec requires bracket notation for nested query parameters.