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

Add docs on generating schemas

Browse source
This commit is contained in:
Graham Esau 2019-12-26 18:26:06 +00:00
parent ebb20130f7
commit 26346612b5
3 changed files with 21 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
schemars/src/gen.rs
View file

@ -2,6 +2,9 @@ use crate::schema::*;
use crate::{JsonSchema, Map};
/// Settings to customize how Schemas are generated.
///
/// The default settings currently conform to [JSON Schema Draft 7](https://json-schema.org/specification-links.html#draft-7), but this is liable to change in a future version of Schemars if support for other JSON Schema versions is added.
/// If you require your generated schemas to conform to draft 7, consider using the [`draft07`](#method.draft07) method.
#[derive(Debug, PartialEq, Clone)]
pub struct SchemaSettings {
/// If `true`, schemas for [`Option<T>`](Option) will include a `nullable` property.
@ -33,7 +36,7 @@ pub struct SchemaSettings {
pub enum BoolSchemas {
/// `Bool` schemas may be used.
Enabled,
/// `Bool` schemas may only be used in a schema's [`additionalProperties`](../sschema/struct.ObjectValidation.html#structfield.additional_properties) field.
/// `Bool` schemas may only be used in a schema's [`additionalProperties`](../schema/struct.ObjectValidation.html#structfield.additional_properties) field.
AdditionalPropertiesOnly,
/// `Bool` schemas will never be used.
Disabled,