docs: document guards behavior when placed at controller and app level #3230
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.
Description
This PR documents the behavior of guards placed at the controller and app level being executed for
OPTIONS
requests.I don't know if linking to the GitHub issue is the best way to go about this. I'm open to any ideas on how to document this behavior better.
Closes
This is related to #2314, but doesn't fix the underlying issue. Instead it documents the issue as well as provides a link to the issue where the users can find a workaround for it.
EDIT: Reword to make sure GitHub doesn't consider the linked issue as being fixed by this PR.