Add Contract for generating separate serialize/deserialize schemas (#335)

This commit is contained in:
Graham Esau 2024-09-04 19:41:34 +01:00 committed by GitHub
parent 497333e91b
commit 05325d2b7c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
36 changed files with 1224 additions and 225 deletions

View file

@ -1,5 +1,15 @@
# Changelog
## [1.0.0-alpha.15] - **in-dev**
### Added
- `SchemaSettings` now has a `contract` field which determines whether the generated schemas describe how types are serialized or *de*serialized. By default, this is set to `Deserialize`, as this more closely matches the behaviour of previous versions - you can change this to `Serialize` to instead generate schemas describing the type's serialization behaviour (https://github.com/GREsau/schemars/issues/48 / https://github.com/GREsau/schemars/pull/335)
### Changed
- Schemas generated for enums with no variants will now generate `false` (or equivalently `{"not":{}}`), instead of `{"enum":[]}`. This is so generated schemas no longer violate the JSON Schema spec's recommendation that a schema's `enum` array "SHOULD have at least one element".
## [1.0.0-alpha.14] - 2024-08-29
### Added