Struct utoipa::openapi::schema::AllOfBuilder

pub struct AllOfBuilder { /* private fields */ }

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

Implementations

impl AllOfBuilder

pub fn new() -> AllOfBuilder

Constructs a new AllOfBuilder.

pub fn build(self) -> AllOf

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

impl AllOfBuilder

pub fn item<I: Into<RefOr<Schema>>>(self, component: I) -> Self

Adds a given Schema to AllOf Composite Object

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

Add or change the title of the AllOf.

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

Add or change optional description for AllOf component.

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 example(self, example: Option<Value>) -> Self

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

pub fn discriminator(self, discriminator: Option<Discriminator>) -> Self

Add or change discriminator field of the composite AllOf type.

pub fn nullable(self, nullable: bool) -> Self

Add or change nullable flag for Object.

pub fn to_array_builder(self) -> ArrayBuilder

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

Trait Implementations

impl Default for AllOfBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<AllOf> for AllOfBuilder

fn from(value: AllOf) -> Self

Converts to this type from the input type.

impl From<AllOfBuilder> for AllOf

fn from(value: AllOfBuilder) -> Self

Converts to this type from the input type.

impl From<AllOfBuilder> for RefOr<Schema>

fn from(one_of: AllOfBuilder) -> Self

Converts to this type from the input type.

impl From<AllOfBuilder> for Schema

fn from(builder: AllOfBuilder) -> Self

Converts to this type from the input type.