Adds attribute to ensure management API requests are never cached in the browser or via a CDN #19496
Conversation
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
…the browser or via a CDN.
AndyButland
changed the title
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR ensures that all Management API requests include headers to prevent caching in browsers or CDNs by applying the existing DisableBrowserCache filter on the base controller.
- Adds the
DisableBrowserCacheattribute toManagementApiControllerBase - Imports the necessary filter namespace
Comments suppressed due to low confidence (1)
src/Umbraco.Cms.Api.Management/Controllers/ManagementApiControllerBase.cs:26
- Consider adding an automated or integration test to verify that responses from Management API endpoints include the appropriate no-cache headers (
Cache-Control,Pragma, etc.) when this attribute is applied.
[DisableBrowserCache]
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.
Prerequisites
Came up via an internal support request.
Description
It's been identified that in Umbraco 13 we specifically disabled caching on any backoffice API requests, but we don't do the same on the management API. Although there's no evidence this has caused issues with usage via the backoffice, this can lead to cached responses being returned when a CDN is in the mix.
As such I've added the existing attribute for disabling the browser cache to the base management API controller.
Testing
Verify the headers you see on the response.
Before:
After:
