Struct PathItem 

#[non_exhaustive]
pub struct PathItem {
    pub ref_location: Option<String>,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub servers: Servers,
    pub parameters: Parameters,
    pub operations: Operations,
    pub additional_operations: PropMap<String, Operation>,
    pub extensions: PropMap<String, Value>,
}

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.

ref_location: Option<String>

External reference to a Path Item Object defined elsewhere.

In OpenAPI 3.1 a Path Item Object can carry its own $ref field that delegates to another Path Item definition. When set, sibling fields’ behavior is undefined per spec — most consumers resolve the reference and ignore them.

See https://spec.openapis.org/oas/v3.1.0#path-item-object.

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: Servers

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

parameters: Parameters

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: Operations

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

additional_operations: PropMap<String, Operation>

Operations on this path that use an HTTP method with no dedicated field, e.g. a custom or registered extension method. Added in OpenAPI 3.2.

The key is the HTTP method with the exact capitalization sent in the request (e.g. PURGE). Methods that already have a dedicated field must not appear here — use PathItem::operations for those.

See https://spec.openapis.org/oas/v3.2.0.html#path-item-object.

extensions: PropMap<String, Value>

Optional extensions “x-something”

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.

pub fn from_ref<S: Into<String>>(ref_location: S) -> Self

Construct a PathItem that is purely a reference to another Path Item, e.g. one defined under components.pathItems.

let item = PathItem::from_ref("#/components/pathItems/PingWebhook");

pub fn ref_location<S: Into<String>>(self, ref_location: S) -> Self

Set the $ref location for this PathItem and return self.

pub fn append(&mut self, other: &mut Self)

Moves all elements from other into self, leaving other empty.

If a key from other is already present in self, the respective value from self will be overwritten with the respective value from other.

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

Append a new Operation by PathItemType to this PathItem. Operations can hold only one operation per PathItemType.

pub fn add_additional_operation<M: Into<String>, O: Into<Operation>>( self, method: M, operation: O, ) -> Self

Append an Operation for an HTTP method that has no dedicated Path Item field, e.g. a custom method. Requires OpenAPI 3.2.

method must be the HTTP method with the exact capitalization sent in the request, and must not be one of the methods covered by PathItemType.

let item = PathItem::default().add_additional_operation("PURGE", Operation::new());

pub fn summary<S: Into<String>>(self, summary: S) -> Self

Add or change summary intended to apply all operations in this PathItem.

pub fn description<S: Into<String>>(self, description: S) -> Self

Add or change optional description intended to apply all operations in this PathItem. Description supports markdown syntax.

pub fn servers<I: IntoIterator<Item = Server>>(self, servers: I) -> Self

Add list of alternative Servers to serve all Operations in this PathItem overriding the global server array.

pub fn parameters<I: IntoIterator<Item = Parameter>>( self, parameters: I, ) -> Self

Append list of Parameters common to all Operations to this PathItem.

pub fn extensions(self, extensions: PropMap<String, Value>) -> Self

Add openapi extensions (x-something) for PathItem.

Trait Implementations

impl Clone for PathItem

fn clone(&self) -> PathItem

Returns a duplicate 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

Deserializing a PathItem cannot be derived: the operation map and the extension map are both flattened, so serde would hand every unmatched key to both of them and an operation such as get would end up duplicated in extensions, making the value re-serialize with repeated keys. Partition the keys explicitly instead.

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

Equality operator ==.

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

Inequality operator !=.

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