Struct PathItem

pub struct PathItem {
    pub reference: Option<String>,
    pub get: Option<Operation>,
    pub put: Option<Operation>,
    pub post: Option<Operation>,
    pub delete: Option<Operation>,
    pub options: Option<Operation>,
    pub head: Option<Operation>,
    pub patch: Option<Operation>,
    pub parameters: Option<Vec<ParameterOrRef>>,
}

Path Item

Describes the operations available on a single path. A Path Item may be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.

Fields

reference: Option<String>

Allows for an external definition of this path item. The referenced structure MUST be in the format of a Path Item Object. If there are conflicts between the referenced definition and this Path Item’s definition, the behavior is undefined.

get: Option<Operation>

A definition of a GET operation on this path.

put: Option<Operation>

A definition of a GET operation on this path.

post: Option<Operation>

A definition of a GET operation on this path.

delete: Option<Operation>

A definition of a GET operation on this path.

options: Option<Operation>

A definition of a GET operation on this path.

head: Option<Operation>

A definition of a GET operation on this path.

patch: Option<Operation>

A definition of a GET operation on this path.

parameters: Option<Vec<ParameterOrRef>>

A list of parameters that are applicable for all the operations described under this path.

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 Debug for PathItem

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

Formats the value using the given formatter.

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 PartialEq for PathItem

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

Tests for self and other values to be equal, and is used by ==.

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

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