fix: recursive schema generation #2869
Merged
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
This PR adopts OpenAPISchemaPlugin for generation of schemas for all supported model types.
This PR modifies the way we generate schemas for objects that should be able to be referenced by other schemas. It adds a new method to `SchemaCreator` called `create_component_schema` that should be used to create a schema that should be able to be referenced by other schemas, and itself. This method takes care to first create the schema in the registry so that it can be immediately referenced. In `SchemaCreator.for_field_definition()`, before we generate a schema for any plugin-supported type, we first check whether a reference can be made to an already existing schema and return that if possible. Closes #2429
peterschutt
force-pushed
the
support-schemas-for-recursive-types
branch
from
8b4de0d to
33b829a
Compare
provinzkraut
approved these changes
Dec 10, 2023
JacobCoffee
approved these changes
Dec 10, 2023
Fixes an error where types such as `UnionType` do not have a `__qualname__` by ensuring we handle the union type annotation before we attempt to apply plugin handling to the type.
peterschutt
added
Bug 🐛
Base automatically changed from
use-openapi-schema-plugin-for-supported-types
to
main
December 11, 2023 01:30
# Conflicts: # litestar/_openapi/schema_generation/plugins/dataclass.py # litestar/_openapi/schema_generation/plugins/struct.py # litestar/_openapi/schema_generation/plugins/typed_dict.py # litestar/_openapi/schema_generation/schema.py # litestar/plugins/base.py
5 tasks
JacobCoffee
approved these changes
Dec 11, 2023
If we don't do this, then users won't have the chance to add a plugin that might override our handling of a collection type etc.
The condition where the schema type is a sequence is possible accoring to the schema spec, however in the TYPE_MAP, we don't have any types where the schema type is a sequence.
|
For some reason, sonar is pinging me for coverage lines and conditions that have nothing to do with this PR :/ |
We have this thing called a `SchemaDataContainer` that is untested, and undocumented. Sonar is reporting the missing coverage on this because I've modified the method, but I have no clue what this thing is, or does.
At this point I'm just guessing WTH sonar is asking for.
could you get coverage up a bit? |
|
|
|
Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/2869 |
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.
This PR modifies the way we generate schemas for objects that should be able to be referenced by other schemas.
It adds a new method to
SchemaCreatorcalledcreate_component_schemathat should be used to create a schema that should be able to be referenced by other schemas, and itself.This method takes care to first create the schema in the registry so that it can be immediately referenced.
In
SchemaCreator.for_field_definition(), before we generate a schema for any plugin-supported type, we first check whether a reference can be made to an already existing schema and return that if possible.Closes #2429