Struct BlockSchema 

pub struct BlockSchema {
    pub title: String,
    pub description: String,
    pub attributes: Map<String, Value>,
    pub allowed_parents: Option<Vec<String>>,
    pub allowed_children: Option<Vec<String>>,
    pub template: Option<Value>,
    pub template_lock: Option<Value>,
    pub example: Value,
}

One block type’s registration: its attributes, where it may be nested and an example.

Fields

title: String

description: String

attributes: Map<String, Value>

JSON Schema per attribute; rich text carries x-rich-text and x-rich-text-formats.

allowed_parents: Option<Vec<String>>

"root" means the page’s top level; None means anywhere the parent allows.

allowed_children: Option<Vec<String>>

None means any block the page allows; empty means no inner blocks.

template: Option<Value>

template_lock: Option<Value>

example: Value

Trait Implementations

impl Clone for BlockSchema

fn clone(&self) -> BlockSchema

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ComposeSchema for BlockSchema

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for BlockSchema

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BlockSchema

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BlockSchema

fn eq(&self, other: &BlockSchema) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BlockSchema

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for BlockSchema

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.

impl StructuralPartialEq for BlockSchema