[−][src]Struct schemars::gen::SchemaSettings
Settings to customize how Schemas are generated.
The default settings currently conform to JSON Schema 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.
Fields
option_nullable: bool
If true
, schemas for Option<T>
will include a nullable
property.
This is not part of the JSON Schema spec, but is used in Swagger/OpenAPI schemas.
Defaults to false
.
option_add_null_type: bool
bool_schemas: BoolSchemas
Controls whether trivial Bool
schemas may be generated.
Defaults to BoolSchemas::Enabled
.
definitions_path: String
A JSON pointer to the expected location of referenceable subschemas within the resulting root schema.
Defaults to "#/definitions/"
.
meta_schema: Option<String>
The URI of the meta-schema describing the structure of the generated schemas.
Defaults to "http://json-schema.org/draft-07/schema#"
.
allow_ref_siblings: bool
Whether schemas with a $ref
property may have other properties set.
Defaults to false
.
Methods
impl SchemaSettings
[src]
pub fn draft07() -> SchemaSettings
[src]
Creates SchemaSettings
that conform to JSON Schema Draft 7.
pub fn draft2019_09() -> SchemaSettings
[src]
Creates SchemaSettings
that conform to JSON Schema 2019-09.
pub fn openapi3() -> SchemaSettings
[src]
Creates SchemaSettings
that conform to OpenAPI 3.0.
pub fn with(self, configure_fn: impl FnOnce(&mut Self)) -> Self
[src]
Modifies the SchemaSettings
by calling the given function.
Example
use schemars::gen::{SchemaGenerator, SchemaSettings}; let settings = SchemaSettings::default().with(|s| { s.option_nullable = true; s.option_add_null_type = false; }); let gen = settings.into_generator();
pub fn into_generator(self) -> SchemaGenerator
[src]
Creates a new SchemaGenerator
using these settings.
Trait Implementations
impl Clone for SchemaSettings
[src]
fn clone(&self) -> SchemaSettings
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for SchemaSettings
[src]
impl Default for SchemaSettings
[src]
fn default() -> SchemaSettings
[src]
impl From<SchemaSettings> for SchemaGenerator
[src]
fn from(settings: SchemaSettings) -> Self
[src]
impl PartialEq<SchemaSettings> for SchemaSettings
[src]
fn eq(&self, other: &SchemaSettings) -> bool
[src]
fn ne(&self, other: &SchemaSettings) -> bool
[src]
impl StructuralPartialEq for SchemaSettings
[src]
Auto Trait Implementations
impl RefUnwindSafe for SchemaSettings
impl Send for SchemaSettings
impl Sync for SchemaSettings
impl Unpin for SchemaSettings
impl UnwindSafe for SchemaSettings
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,