Document how to configure CORSMiddleware globally #2885
Merged
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
adriangb
approved these changes
Mar 3, 2025
Contributor
adriangb
left a comment
There was a problem hiding this comment.
small nit, otherwise looks good to me!
Co-authored-by: Adrian Garcia Badaracco <1755071+adriangb@users.noreply.github.com>
Contributor
|
Thanks! |
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.
Summary
This PR updates the CORSMiddleware documentation to explain how to configure it globally.
By wrapping the entire Starlette application with CORSMiddleware, all responses—including error responses generated by unhandled exceptions—will consistently include the proper CORS headers. This change reflects recent discussions (see discussion #2876) and clarifies the recommended usage pattern for ensuring global CORS enforcement.
Checklist