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

Replace is_referenceable() with always_inline_schema()

Browse source
This commit is contained in:
Graham Esau 2024-05-26 16:51:42 +01:00
parent 1aaa162e0b
commit f8b56cb455
22 changed files with 53 additions and 52 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/2-implementing.md
View file

@ -63,14 +63,14 @@ This function creates the JSON schema itself. The `gen` argument can be used to
`json_schema` should not return a `$ref` schema.
## is_referenceable (optional)
## always_inline_schema (optional)
```rust
fn is_referenceable() -> bool;
fn always_inline_schema() -> bool;
```
If this function returns `true`, then Schemars can re-use the generate schema where possible by adding it to the root schema's `definitions` and having other schemas reference it using the `$ref` keyword. This can greatly simplify schemas that include a particular type multiple times, especially if that type's schema is fairly complex.
If this function returns `false`, then Schemars can re-use the generate schema where possible by adding it to the root schema's `definitions` and having other schemas reference it using the `$ref` keyword. This can greatly simplify schemas that include a particular type multiple times, especially if that type's schema is fairly complex.
Generally, this should return `false` for types with simple schemas (such as primitives). For more complex types, it should return `true`. For recursive types, this **must** return `true` to prevent infinite cycles when generating schemas.
Generally, this should return `true` for types with simple schemas (such as primitives). For more complex types, it should return `false`. For recursive types, this **must** return `false` to prevent infinite cycles when generating schemas.
The default implementation of this function returns `true` to reduce the chance of someone inadvertently causing infinite cycles with recursive types.
The default implementation of this function returns `false` to reduce the chance of someone inadvertently causing infinite cycles with recursive types.