Docs: clarify required but nullable request body fields #14653
+24
−0
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
Clarifies how request body fields can be required while still allowing
nullvalues when using
Optional[T]without a default.Motivation
While reading the documentation, I found it unclear why a field annotated as
Optional[str]could still be required. This PR adds a short explanation andexample to clarify the distinction between:
This directly addresses the confusion described in #12965.
Changes
Notes
Documentation-only change. No runtime or API behavior is affected.