Struct utoipa::openapi::schema::ObjectBuilder

pub struct ObjectBuilder { /* private fields */ }

Builder for Object with chainable configuration methods to create a new Object.

Implementations

impl ObjectBuilder

pub fn new() -> ObjectBuilder

Constructs a new ObjectBuilder.

pub fn schema_type(self, schema_type: SchemaType) -> Self

Add or change type of the object e.g SchemaType::String.

pub fn format(self, format: Option<SchemaFormat>) -> Self

Add or change additional format for detailing the schema type.

pub fn property<S: Into<String>, I: Into<RefOr<Schema>>>(
    self,
    property_name: S,
    component: I
) -> Self

Add new property to the Object.

Method accepts property name and property component as an arguments.

pub fn additional_properties<I: Into<RefOr<Schema>>>(
    self,
    additional_properties: Option<I>
) -> Self

pub fn required<I: Into<String>>(self, required_field: I) -> Self

Add field to the required fields of Object.

pub fn title<I: Into<String>>(self, title: Option<I>) -> Self

Add or change the title of the Object.

pub fn description<I: Into<String>>(self, description: Option<I>) -> Self

Add or change description of the property. Markdown syntax is supported.

pub fn default(self, default: Option<Value>) -> Self

Add or change default value for the object which is provided when user has not provided the input in Swagger UI.

pub fn deprecated(self, deprecated: Option<Deprecated>) -> Self

Add or change deprecated status for Object.

pub fn enum_values<I: IntoIterator<Item = E>, E: Into<String>>(
    self,
    enum_values: Option<I>
) -> Self

Add or change enum property variants.

pub fn example(self, example: Option<Value>) -> Self

Add or change example shown in UI of the value for richier documentation.

pub fn write_only(self, write_only: Option<bool>) -> Self

Add or change write only flag for Object.

pub fn read_only(self, read_only: Option<bool>) -> Self

Add or change read only flag for Object.

pub fn xml(self, xml: Option<Xml>) -> Self

Add or change additional Xml formatting of the Object.

pub fn to_array_builder(self) -> ArrayBuilder

Construct a new ArrayBuilder with this component set to ArrayBuilder::items.

pub fn build(self) -> Object

Constructs a new Object taking all fields values from this object.

Trait Implementations

impl Default for ObjectBuilder

fn default() -> ObjectBuilder

Returns the “default value” for a type.

impl From<Object> for ObjectBuilder

fn from(value: Object) -> Self

Converts to this type from the input type.

impl From<ObjectBuilder> for Object

fn from(value: ObjectBuilder) -> Self

Converts to this type from the input type.

impl From<ObjectBuilder> for RefOr<Schema>

fn from(builder: ObjectBuilder) -> Self

Converts to this type from the input type.

impl From<ObjectBuilder> for Schema

fn from(builder: ObjectBuilder) -> Self

Converts to this type from the input type.