Struct PathItemBuilder 

pub struct PathItemBuilder { /* private fields */ }

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

Implementations

impl PathItemBuilder

pub fn new() -> PathItemBuilder

Constructs a new PathItemBuilder.

pub fn build(self) -> PathItem

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

impl PathItemBuilder

pub fn ref_path<S: Into<String>>(self, ref_path: Option<S>) -> Self

Add or change reference to another Path Item Object.

pub fn operation<O: Into<Operation>>( self, http_method: HttpMethod, operation: O, ) -> Self

Append a new Operation by HttpMethod to this PathItem. Operations can hold only one operation per HttpMethod.

pub fn query<O: Into<Operation>>(self, operation: Option<O>) -> Self

Add or change query Operation for this PathItem.

pub fn additional_operations<I: IntoIterator<Item = (S, O)>, S: Into<String>, O: Into<Operation>>( self, additional_operations: I, ) -> Self

Add or change operation used for HTTP methods or other operations not explicitly listed on this path.

pub fn additional_operation<S: Into<String>, O: Into<Operation>>( self, method: S, operation: O, ) -> Self

Add operation used for an HTTP method not explicitly listed on this path.

pub fn summary<S: Into<String>>(self, summary: Option<S>) -> Self

Add or change summary intended to apply all operations in this PathItem.

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

Add or change optional description intended to apply all operations in this PathItem. Description supports markdown syntax.

pub fn servers<I: IntoIterator<Item = Server>>(self, servers: Option<I>) -> Self

Add list of alternative Servers to serve all Operations in this PathItem overriding the global server array.

pub fn parameters<I: IntoIterator<Item = Parameter>>( self, parameters: Option<I>, ) -> Self

Append list of Parameters common to all Operations to this PathItem.

pub fn parameter_refs<I: IntoIterator<Item = Ref>>( self, refs: Option<I>, ) -> Self

Append list of parameter references common to all Operations to this PathItem.

pub fn extensions(self, extensions: Option<Extensions>) -> Self

Add openapi extensions (x-something) to this PathItem.

Trait Implementations

impl Default for PathItemBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<PathItem> for PathItemBuilder

fn from(value: PathItem) -> Self

Converts to this type from the input type.

impl From<PathItemBuilder> for PathItem

fn from(value: PathItemBuilder) -> Self

Converts to this type from the input type.