Struct PathInfo 

pub struct PathInfo {
    pub method: String,
    pub summary: String,
    pub description: Option<String>,
    pub tags: Vec<String>,
    pub parameters: Vec<Value>,
    pub request_body: Option<RequestBody>,
    pub responses: HashMap<String, Value>,
    pub security: Vec<SecurityRequirement>,
    pub operation_id: Option<String>,
    pub deprecated: Option<bool>,
}

Describes a single (path, method) operation in an OpenAPI spec.

Fields

method: String

summary: String

description: Option<String>

tags: Vec<String>

parameters: Vec<Value>

request_body: Option<RequestBody>

responses: HashMap<String, Value>

security: Vec<SecurityRequirement>

operation_id: Option<String>

deprecated: Option<bool>

Implementations

impl PathInfo

pub fn new(method: &str, summary: &str) -> Self

pub fn with_response(self, code: &str, desc: &str) -> Self

pub fn with_response_schema( self, code: &str, desc: &str, schema_ref: &str, ) -> Self

Adds a response with a Schema

pub fn with_parameter(self, param: Value) -> Self

pub fn with_path_param(self, name: &str, desc: &str, required: bool) -> Self

Adds a path parameter

pub fn with_query_param(self, name: &str, desc: &str, required: bool) -> Self

Adds a query parameter

pub fn with_tag(self, tag: &str) -> Self

Adds a tag

pub fn with_request_body(self, body: RequestBody) -> Self

Sets the request body

pub fn with_request_body_ref( self, desc: &str, schema_ref: &str, required: bool, ) -> Self

Sets the request body (simplified: references a Schema)

pub fn with_operation_id(self, id: &str) -> Self

Sets the operation ID

pub fn with_security(self, req: SecurityRequirement) -> Self

Sets the security requirement

pub fn deprecated(self) -> Self

Marks as deprecated

pub fn with_description(self, desc: &str) -> Self

Sets the description

Trait Implementations

impl Clone for PathInfo

fn clone(&self) -> PathInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PathInfo

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PathInfo

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

where __S: Serializer,

Serialize this value into the given Serde serializer.