fix: schema for generic wrapped return types with DTO #3371
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
kedod
reviewed
Apr 10, 2024
kedod
approved these changes
Apr 10, 2024
peterschutt
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3371 +/- ##
=======================================
Coverage 98.28% 98.28%
=======================================
Files 323 323
Lines 14773 14777 +4
Branches 2345 2347 +2
=======================================
+ Hits 14519 14523 +4
Misses 116 116
Partials 138 138 ☔ View full report in Codecov by Sentry. |
peterschutt
force-pushed
the
2929-openapi-for-dto-wrapped-generic
branch
from
6b3a18d
to
aa57371
Compare
peterschutt
commented
Apr 10, 2024
Adds failing test. Closes #2929
Prior behavior of using the `backend.annotation` as the basis for generating the openapi schema for the represented type is not applicable for the case where the DTO supported type is wrapped in a generic outer object. This PR detects the case where we unwrap an outer generic type, and rebuilds the generic annotation in a manner appropriate for schema generation, before generating the schema for the annotation. It does this by substituting the DTOs transfer model for the original model in the original annotations type arguments. This is really treating a symptom of the generic outer type being removed from the annotation before the DTO backend receives it, which is a design flaw that adds quite a bit of complexity. The DTOs should treat annotations at a whole, rebuild the complete annotation substituting out any supported types found within with transfer models. Also, we don't really have a need for a separate backend anymore, now that we are only supporting one serialization library (backend were introduced when we were trying to support either pydantic or msgspec (and attrs?) throughout the whole application.
peterschutt
force-pushed
the
2929-openapi-for-dto-wrapped-generic
branch
from
aa57371
to
8a209c6
Compare
|
|
Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/3371 |
peterschutt
added a commit
that referenced
this pull request
Apr 11, 2024
* fix: Fix schema for generic wrapped return types with DTO Adds failing test. Closes #2929 * fix: remove redundant type var * fix: fix openapi schema for generic return types with dto Prior behavior of using the `backend.annotation` as the basis for generating the openapi schema for the represented type is not applicable for the case where the DTO supported type is wrapped in a generic outer object. This PR detects the case where we unwrap an outer generic type, and rebuilds the generic annotation in a manner appropriate for schema generation, before generating the schema for the annotation. It does this by substituting the DTOs transfer model for the original model in the original annotations type arguments. This is really treating a symptom of the generic outer type being removed from the annotation before the DTO backend receives it, which is a design flaw that adds quite a bit of complexity. The DTOs should treat annotations at a whole, rebuild the complete annotation substituting out any supported types found within with transfer models. Also, we don't really have a need for a separate backend anymore, now that we are only supporting one serialization library (backend were introduced when we were trying to support either pydantic or msgspec (and attrs?) throughout the whole application. * test: add another test. (cherry picked from commit 40a5685)
peterschutt
added a commit
that referenced
this pull request
Apr 11, 2024
* fix: Fix schema for generic wrapped return types with DTO Adds failing test. Closes #2929 * fix: remove redundant type var * fix: fix openapi schema for generic return types with dto Prior behavior of using the `backend.annotation` as the basis for generating the openapi schema for the represented type is not applicable for the case where the DTO supported type is wrapped in a generic outer object. This PR detects the case where we unwrap an outer generic type, and rebuilds the generic annotation in a manner appropriate for schema generation, before generating the schema for the annotation. It does this by substituting the DTOs transfer model for the original model in the original annotations type arguments. This is really treating a symptom of the generic outer type being removed from the annotation before the DTO backend receives it, which is a design flaw that adds quite a bit of complexity. The DTOs should treat annotations at a whole, rebuild the complete annotation substituting out any supported types found within with transfer models. Also, we don't really have a need for a separate backend anymore, now that we are only supporting one serialization library (backend were introduced when we were trying to support either pydantic or msgspec (and attrs?) throughout the whole application. * test: add another test. (cherry picked from commit 40a5685)
peterschutt
added a commit
that referenced
this pull request
May 1, 2024
* fix: Fix schema for generic wrapped return types with DTO Adds failing test. Closes #2929 * fix: remove redundant type var * fix: fix openapi schema for generic return types with dto Prior behavior of using the `backend.annotation` as the basis for generating the openapi schema for the represented type is not applicable for the case where the DTO supported type is wrapped in a generic outer object. This PR detects the case where we unwrap an outer generic type, and rebuilds the generic annotation in a manner appropriate for schema generation, before generating the schema for the annotation. It does this by substituting the DTOs transfer model for the original model in the original annotations type arguments. This is really treating a symptom of the generic outer type being removed from the annotation before the DTO backend receives it, which is a design flaw that adds quite a bit of complexity. The DTOs should treat annotations at a whole, rebuild the complete annotation substituting out any supported types found within with transfer models. Also, we don't really have a need for a separate backend anymore, now that we are only supporting one serialization library (backend were introduced when we were trying to support either pydantic or msgspec (and attrs?) throughout the whole application. * test: add another test. (cherry picked from commit 40a5685)
peterschutt
added a commit
that referenced
this pull request
May 2, 2024
* fix: Fix schema for generic wrapped return types with DTO Adds failing test. Closes #2929 * fix: remove redundant type var * fix: fix openapi schema for generic return types with dto Prior behavior of using the `backend.annotation` as the basis for generating the openapi schema for the represented type is not applicable for the case where the DTO supported type is wrapped in a generic outer object. This PR detects the case where we unwrap an outer generic type, and rebuilds the generic annotation in a manner appropriate for schema generation, before generating the schema for the annotation. It does this by substituting the DTOs transfer model for the original model in the original annotations type arguments. This is really treating a symptom of the generic outer type being removed from the annotation before the DTO backend receives it, which is a design flaw that adds quite a bit of complexity. The DTOs should treat annotations at a whole, rebuild the complete annotation substituting out any supported types found within with transfer models. Also, we don't really have a need for a separate backend anymore, now that we are only supporting one serialization library (backend were introduced when we were trying to support either pydantic or msgspec (and attrs?) throughout the whole application. * test: add another test. (cherry picked from commit 40a5685)
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.
Changelog
Fix schema generated for DTOs where the supported type is wrapped in a generic outer type.
Description
Prior behavior of using the
backend.annotationas the basis for generating the openapi schema for the represented type is not applicable for the case where the DTO supported type is wrapped in a generic outer object. In that casebackend.annotationonly represents the type of the attribute on the generic type that holds the DTO supported type annotation.This PR detects the case where we unwrap an outer generic type, and rebuilds the generic annotation in a manner appropriate for schema generation, before generating the schema for the annotation. It does this by substituting the DTOs transfer model for the original model in the original annotations type arguments.
<tangent>This is really treating a symptom of the generic outer type being removed from the annotation before the DTO backend receives it, which is a design flaw that adds quite a bit of complexity. The DTOs should treat annotations at a whole, rebuild the complete annotation substituting out any supported types found within with transfer models.
Also, we don't really have a need for a separate backend anymore, now that we are only supporting one serialization library (backends were introduced when we were trying to support either pydantic or msgspec (and attrs?)) throughout the whole application.
</tangent>Closes
Closes #2929