VienDesu/schemars
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update docs

Browse source
This commit is contained in:
Graham Esau 2021-03-25 22:51:51 +00:00
parent cb26e783dc
commit 93435d519a
5 changed files with 23 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/3-generating.md
View file

@ -21,7 +21,7 @@ If you want more control over how the schema is generated, you can use the [`gen
See the API documentation for more info on how to use those types for custom schema generation.
<!-- UNCOMMMENT FOR 0.8.2:
## Schema from Example Values
## Schema from Example Value
If you want a schema for a type that can't/doesn't implement `JsonSchema`, but does implement `serde::Serialize`, then you can generate a JSON schema from a value of that type using the [`schema_for_value!` macro](https://docs.rs/schemars/latest/schemars/macro.schema_for_value.html). However, this schema will generally be less precise than if the type implemented `JsonSchema` - particularly when it involves enums, since schemars will not make any assumptions about the structure of an enum based on a single variant.