Struct OperationBuilder 

pub struct OperationBuilder { /* private fields */ }

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

Implementations

impl OperationBuilder

pub fn new() -> OperationBuilder

Constructs a new OperationBuilder.

pub fn build(self) -> Operation

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

impl OperationBuilder

pub fn tags<I, V>(self, tags: Option<I>) -> OperationBuilder

where I: IntoIterator<Item = V>, V: Into<String>,

Add or change tags of the Operation.

pub fn tag<S>(self, tag: S) -> OperationBuilder

where S: Into<String>,

Append tag to Operation tags.

pub fn summary<S>(self, summary: Option<S>) -> OperationBuilder

where S: Into<String>,

Add or change short summary of the Operation.

pub fn description<S>(self, description: Option<S>) -> OperationBuilder

where S: Into<String>,

Add or change description of the Operation.

pub fn operation_id<S>(self, operation_id: Option<S>) -> OperationBuilder

where S: Into<String>,

Add or change operation id of the Operation.

pub fn parameters<I, P>(self, parameters: Option<I>) -> OperationBuilder

where I: IntoIterator<Item = P>, P: Into<Parameter>,

Add or change parameters of the Operation.

pub fn parameter<P>(self, parameter: P) -> OperationBuilder

where P: Into<Parameter>,

Append parameter to Operation parameters.

pub fn request_body(self, request_body: Option<RequestBody>) -> OperationBuilder

Add or change request body of the Operation.

pub fn responses<R>(self, responses: R) -> OperationBuilder

where R: Into<Responses>,

Add or change responses of the Operation.

pub fn response<S, R>(self, code: S, response: R) -> OperationBuilder

where S: Into<String>, R: Into<RefOr<Response>>,

Append status code and a Response to the Operation responses map.

• code must be valid HTTP status code.
• response is instances of Response.

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

Add or change deprecated status of the Operation.

pub fn securities<I>(self, securities: Option<I>) -> OperationBuilder

where I: IntoIterator<Item = SecurityRequirement>,

Add or change list of SecurityRequirements that are available for Operation.

pub fn security(self, security: SecurityRequirement) -> OperationBuilder

Append SecurityRequirement to Operation security requirements.

pub fn servers<I>(self, servers: Option<I>) -> OperationBuilder

where I: IntoIterator<Item = Server>,

Add or change list of Servers of the Operation.

pub fn server(self, server: Server) -> OperationBuilder

Append a new Server to the Operation servers.

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

Add openapi extensions (x-something) of the Operation.

Trait Implementations

impl Default for OperationBuilder

fn default() -> OperationBuilder

Returns the “default value” for a type.

impl From<Operation> for OperationBuilder

fn from(value: Operation) -> OperationBuilder

Converts to this type from the input type.

impl From<OperationBuilder> for Operation

fn from(value: OperationBuilder) -> Operation

Converts to this type from the input type.