fix: remove return type annotation from settings serializer to fix OpenAPI schema #19616
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
-> Anyreturn type annotation from theser_model()method inPrefectBaseSettingsProblem
The
@model_serializer(mode='wrap')decorator with a return type annotation (e.g.,-> Any) causes Pydantic to generate an empty serialization schema ({}). FastAPI 0.120+ uses serialization mode for response models, which causes types likeAPISettingsto becomeunknownin the generated TypeScript schema.Solution
Removing the return type annotation allows Pydantic to fall back to the model schema, producing correct OpenAPI definitions for all settings types. This also removes the need for separate
-Input/-Outputschema variants.References
Test plan
🤖 Generated with Claude Code