Struct utoipa::openapi::path::PathItem

#[non_exhaustive]
pub struct PathItem {
    pub summary: Option<String>,
    pub description: Option<String>,
    pub servers: Option<Vec<Server>>,
    pub parameters: Option<Vec<Parameter>>,
    pub operations: BTreeMap<PathItemType, Operation>,
}

Implements OpenAPI Path Item Object what describes Operations available on a single path.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

summary: Option<String>

Optional summary intended to apply all operations in this PathItem.

description: Option<String>

Optional description intended to apply all operations in this PathItem. Description supports markdown syntax.

servers: Option<Vec<Server>>

Alternative Server array to serve all Operations in this PathItem overriding the global server array.

parameters: Option<Vec<Parameter>>

List of Parameters common to all Operations in this PathItem. Parameters cannot contain duplicate parameters. They can be overridden in Operation level but cannot be removed there.

operations: BTreeMap<PathItemType, Operation>

Map of operations in this PathItem. Operations can hold only one operation per PathItemType.

Implementations

impl PathItem

pub fn new<O: Into<Operation>>(
    path_item_type: PathItemType,
    operation: O
) -> Self

Construct a new PathItem with provided Operation mapped to given PathItemType.

Trait Implementations

impl Clone for PathItem

fn clone(&self) -> PathItem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for PathItem

fn default() -> PathItem

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PathItem

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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.

impl PartialEq<PathItem> for PathItem

fn eq(&self, other: &PathItem) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PathItem

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PathItem