Make referenced schemas required #1018
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
juhaku
force-pushed
the
feature-required-schemas
branch
2 times, most recently
from
4db455a to
21e7d55
Compare
juhaku
changed the title
juhaku
force-pushed
the
feature-required-schemas
branch
4 times, most recently
from
30a8a5e to
8e8c7ad
Compare
This will affect in all places where schema is being rendered. These are `value_type = ..` `request_body`, `response_body = ...` to name few. This aims to enforce `PartialSchema` implementation for every type that is being used in OpenAPI spec generated by utoipa. The `Schema` trait will be split to `PartialSchema` and `Schema` and `Schema` will extend the `PartialSchema` trait. `PartialSchema` will provide the actual schema and `Schema` will provide name and other data related to the schema itself. This is useful since we already provide `PartialSchema` implementation for many standard Rust types and not all types need the full schema but only the schema definition. This makes schema definition implementation easier by juts allowing users to manually implement `PartialSchema` type for their type if needed. Still as usual the implementation can be automatically derived with `ToSchema` derive trait. Fixes #500 Fixes #801
juhaku
force-pushed
the
feature-required-schemas
branch
from
8e8c7ad to
42d40e9
Compare
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 will affect in all places where schema is being rendered. These are
value_type = ..request_body,response_body = ...to name few. This is still very much work in progress but aims to enforcePartialSchemaimplementation for every type that is being used in OpenAPI spec generated by utoipa.The
Schematrait will be split toPartialSchemaandSchemaandSchemawill extend thePartialSchematrait.PartialSchemawill provide the actual schema andSchemawill provide name and other data related to the schema itself. This is useful since we already providePartialSchemaimplementation for many standard Rust types and not all types need the full schema but only the schema definition. This makes schema definition implementation easier by juts allowing users to manually implementPartialSchematype for their type if needed. Still as usual the implementation can be automatically derived withToSchemaderive trait.Fixes #500 Fixes #801