Add the ability for clients to limit recursion depth to reduce response sizes #200
Conversation
This file contains 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
Andrew-Dickinson
added
the
API
Andrew-Dickinson
changed the base branch from
andrew/link-and-sector-endpoints
to
main
Andrew-Dickinson
force-pushed
the
andrew/recursion-depth-limit
branch
from
dfc956b to
4a1094e
Compare
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.
The chonker of a response object introduced in #199 made me think that some clients are going to want the ability to limit the depth of the recursion in the object they receive, this PR adds a
?max_recursion_depthparameter available on any of the endpoints that are backed byRecursiveSerializerwhich can be optionally used to limit the depth if the caller is only interested in shallower data fields