Struct aide::openapi::v3::definition::PathItem

pub struct PathItem {
    pub reference: Option<String>,
    pub summary: Option<String>,
    pub description: 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 trace: Option<Operation>,
    pub servers: Option<Vec<Server>>,
    pub parameters: Vec<RefOr<Parameter>>,
    pub extensions: Map<String, Value>,
}

Fields

reference: Option<String>

summary: Option<String>

description: Option<String>

get: Option<Operation>

put: Option<Operation>

post: Option<Operation>

delete: Option<Operation>

options: Option<Operation>

head: Option<Operation>

patch: Option<Operation>

trace: Option<Operation>

servers: Option<Vec<Server>>

parameters: Vec<RefOr<Parameter>>

extensions: Map<String, Value>

Implementations

impl PathItem

pub fn operation(&self, method: OperationMethod) -> Option<&Operation>

Returns an operation by its method

pub fn operation_mut(
    &mut self,
    method: OperationMethod
) -> &mut Option<Operation>

Returns a mutable operation by its method

pub fn operations(&self) -> impl Iterator<Item = (OperationMethod, &Operation)>

Returns an iterator over the operations.

pub fn operations_mut(
    &mut self
) -> impl Iterator<Item = (OperationMethod, &mut Option<Operation>)>

Returns a mutable iterator over the operations.

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

fn default() -> PathItem

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for PathItem where
    PathItem: Default, 

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

Deserialize this value from the given Serde deserializer.

impl JsonSchema for PathItem

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

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: &PathItem) -> bool

This method tests for !=.

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