fix: extend openapi meta collected from domain models #3237
Conversation
This file contains 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
peterschutt
force-pushed
the
3232-pyd-field-descriptions
branch
3 times, most recently
from
10577a2
to
9756003
Compare
peterschutt
force-pushed
the
3232-pyd-field-descriptions
branch
from
9756003
to
d859a75
Compare
peterschutt
changed the title
peterschutt
commented
Mar 22, 2024
guacs
reviewed
Mar 26, 2024
guacs
approved these changes
Mar 26, 2024
|
|
Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/3237 |
4 tasks
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.
Description
FieldDefinitions pack any OpenAPI metadata onto aKwargDefinitioninstance when types are parsed from domain models.When we produce a DTO type, we transfer this meta from the
KwargDefinitionto amsgspec.Metainstance, however so far this has only included constraints, not attributes such as descriptions, examples and title.This PR ensures that we transfer the openapi meta for the complete intersection of fields that exist on both
KwargDefinitionandMeta.Closes
Closes #3232