Conversation
The `JsonSchema` impl for enumset does not accurately represent how it is de/serialized by default
aa10948 to
602b2b0
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
While updating integration tests, I discovered that the
JsonSchemaimpl for enumset does not accurately represent how it is de/serialized by default. By default, it's serialized as an integer, but theJsonSchemaimpl assumes that it's a set (or in JSON, an array) of variant names.It's possible to fix the impl, but I'm concerned that some consumers may be subtly broken by changing the behaviour (even if it's actually "fixing" it). I'm honestly more comfortable removing it entirely to make it more obviously "blow up" at compile-time, and then consumers can decide whether they want the old behaviour (e.g.
#[schemars(with = "BTreeSet<Enum>")]) or a schema corresponding to the actual default serialization format for enumset (e.g.#[schemars(with = "u64")]).