PoC: Include support for schemars #623
Closed
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
swlynch99
added a commit
to swlynch99/serde_with
that referenced
this pull request
Dec 6, 2023
This commit adds support for emitting
#[schemars(with = "::serde_with::Schema<T, ...>")]
field annotations when any of the following are true:
- there is a #[derive(JsonSchema)] attribute, or,
- the user explicitly requests it via #[serde_as(schemars)]
This requires a bunch of extra work to properly scan for a few different
possible paths to JsonSchema (see the added docs for details) and also
to properly handle the case where the derive is within a #[cfg_attr]. eg
#[cfg_attr(feature = "blah", derive(schemars::JsonSchema))]
While rustc will evaluate the cfgs for attributes declared by derive
macros unfortunately it does not do the same for attribute macros so we
need to do it ourselves.
The code here started from jonasbb#623 as a base and all changes have been made
on top of that.
Co-Authored-By: Jonas Bushart <[email protected]>
jonasbb
added a commit
to swlynch99/serde_with
that referenced
this pull request
Jan 2, 2024
This commit adds support for emitting
#[schemars(with = "::serde_with::Schema<T, ...>")]
field annotations when any of the following are true:
- there is a #[derive(JsonSchema)] attribute, or,
- the user explicitly requests it via #[serde_as(schemars)]
This requires a bunch of extra work to properly scan for a few different
possible paths to JsonSchema (see the added docs for details) and also
to properly handle the case where the derive is within a #[cfg_attr]. eg
#[cfg_attr(feature = "blah", derive(schemars::JsonSchema))]
While rustc will evaluate the cfgs for attributes declared by derive
macros unfortunately it does not do the same for attribute macros so we
need to do it ourselves.
The code here started from jonasbb#623 as a base and all changes have been made
on top of that.
Co-Authored-By: Jonas Bushart <[email protected]>
jonasbb
added a commit
to swlynch99/serde_with
that referenced
this pull request
Jan 2, 2024
This commit adds support for emitting
#[schemars(with = "::serde_with::Schema<T, ...>")]
field annotations when any of the following are true:
- there is a #[derive(JsonSchema)] attribute, or,
- the user explicitly requests it via #[serde_as(schemars)]
This requires a bunch of extra work to properly scan for a few different
possible paths to JsonSchema (see the added docs for details) and also
to properly handle the case where the derive is within a #[cfg_attr]. eg
#[cfg_attr(feature = "blah", derive(schemars::JsonSchema))]
While rustc will evaluate the cfgs for attributes declared by derive
macros unfortunately it does not do the same for attribute macros so we
need to do it ourselves.
The code here started from jonasbb#623 as a base and all changes have been made
on top of that.
Co-Authored-By: Jonas Bushart <[email protected]>
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.
schemarsandserde_withsupport was requested over at the schemars repository: GREsau/schemars#198There are some limitations in how well this can be done within schemars since its support for serde's with attribute is quite limited.
This is just a minimal example, showing how to implement the traits for wrapper, container, and conversion types. It includes a simple test that also verifies that the schema can be used for validation.
Instead of building a comprehensive set of tests only for schemars, it might be simpler to modify the test functions in
utils.rsto also run schema instance validation tests.If someone wants to invest the time to bring this to completion, I am happy to review the submissions.