Docs: clarify purpose and behavior of response_model #14654
+36
−0
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
Author
|
This PR focuses on clarifying the intent and behavior of response_model Thanks & Regards |
YuriiMotov
reviewed
Jan 6, 2026
Member
YuriiMotov
left a comment
There was a problem hiding this comment.
@ynehra0777, thanks for your interest!
I think this is explained well in current version and there is no need to clarify it.
Please, read read the whole page from the start. It's said that Response Model - Return Type is used to validate and filter data, and also to generate output schema. And response_model Parameter` is just an alternative to return type annotation
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
Adds a clarification explaining why
response_modelis useful and howit filters and validates response data.
Motivation
New users often confuse request models with response models or are
unclear why extra fields are removed from responses. This PR adds a
short explanation and example to clarify the intended behavior.
Changes
response_modelNotes
Documentation-only change. No runtime behavior is affected.