fix(event_handler): always add 422 response to the schema #3995
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
pull-request-size
bot
added
the
size/M
rubenfonseca
commented
Mar 21, 2024
leandrodamascena
requested changes
Mar 21, 2024
There was a problem hiding this comment.
Hey @rubenfonseca! The PR appears to be in a very good shape, with all functionality working as expected. I'm wondering if it's beneficial to include additional tests to safeguard against unintentional overriding of the client-defined 422 response when setting it specifically in the route definition.
What do you think?
great idea |
|
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.
Issue number: #3600
Summary
Changes
This PR makes sure that the 422 error is always added to the OpenAPI schema, even when the user is customizing the response.
It also fixes the default schema of the 422 error to not have a "msg" field, for security reasons.
Also took the opportunity to simplify the code to make it easier to read.
User experience
After this PR, the user can still customize the openapi responses, while maintaining the 422 error that is generated when there is a validation error.
Checklist
If your change doesn't seem to apply, please leave them unchecked.
Is this a breaking change?
RFC issue number:
Checklist:
Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.