feat(routes): let add_routes leave response bodies out of /cached-records - #95
Merged
Merged
Conversation
…ords add_routes(..., include_content_preview=False) sets content_preview to null, so a deployment can expose the key listing, sizes and expiry without exposing the first 100 bytes of every cached response. The default stays True, so existing callers see no change. Closes #79
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.
Closes #79.
Change
add_routes()gainsinclude_content_preview: bool = True. When it isFalse, every record in/cached-recordshascontent_preview: null. Keys, sizes, ETags and expiry are still reported, and/cached-hitsis unchanged (it never included bodies).True, so existing callers see no change. Whether it should flip toFalsein 0.4.0 remains the open question in the issue.CachedRecord.content_previewfield type widens fromstrtostr | None.docs/HTTP_CACHING.mdshows the option in the example and mentions it in the route description and the no-authentication warning.[Unreleased]has an Added entry.Tests
test_cached_records_can_omit_content_preview:null, and the body string appears nowhere in the response.ruff,mypy --strictandzensical build --strictare clean.Note
This PR and #94 both edit
[Unreleased]inCHANGELOG.md: #94 adds a### Fixedsection and this PR adds to### Added. The edits are in different places, so they should merge cleanly.