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

Add note to docs about setting examples via the extend attribute

Browse source
This commit is contained in:
Graham Esau 2024-08-25 13:09:18 +01:00
parent 7c0ba8da88
commit fb6bd6d439
1 changed files with 2 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/_includes/attributes.md
View file

@ -272,6 +272,8 @@ Set on a container, variant or field to set the generated schema's `title` and/o
Set on a container, variant or field to include the result of the given function in the generated schema's `examples`. The function should take no parameters and can return any type that implements serde's `Serialize` trait - it does not need to return the same type as the attached struct/field. This attribute can be repeated to specify multiple examples.
To use the result of arbitrary expressions as examples, you can instead use the [`extend`](#extend) attribute, e.g. `[schemars(extend("examples" = ["example string"]))]`.
<h3 id="deprecated">
`#[deprecated]`