Repository navigation
Conversation
…et of options A DerivingVia target that takes its Aeson Options from a type-level tag and builds the generic ToJSON, FromJSON and ToSchema instances from them (the schema through fromAesonOptions), so the schema cannot drift from the JSON encoding.
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
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.
Adds
Data.OpenApi.DerivingwithWithAesonOptions, aDerivingViatarget. It takes AesonOptionsfrom a type-level tag and derives genericToJSON,FromJSONandToSchemafrom them, the schema throughfromAesonOptions:Without it, the options are written twice, once for aeson and once for the schema, and nothing checks that the two copies agree. When they differ, the schema silently describes a different JSON shape from the one on the wire.
The change adds one module and no dependencies. It uses the
GToJSON/GToEncodingsynonyms, which aeson exports from 1.4 through 2.2, so it needs no CPP.Tests:
Data.OpenApi.DerivingSpeccoversunwrapUnaryRecordsandconstructorTagModifier. It checks the encoding, the decoding, the schema, andvalidateToJSONagainst the derived schema.cabal test all(spec and doctests) passes with GHC 9.6, 9.10 and 9.12. There is a changelog entry under Unreleased.