#[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>,
}
Expand description
Implements OpenAPI Path Item Object what describes Operation
s available on
a single path.
Fields (Non-exhaustive)§
This struct is marked as 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 Operation
s in this PathItem
overriding
the global server array.
parameters: Option<Vec<Parameter>>
List of Parameter
s common to all Operation
s 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§
Trait Implementations§
source§impl<'de> Deserialize<'de> for PathItem
impl<'de> Deserialize<'de> for PathItem
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl From<PathItem> for PathItemBuilder
impl From<PathItem> for PathItemBuilder
source§impl From<PathItemBuilder> for PathItem
impl From<PathItemBuilder> for PathItem
source§fn from(value: PathItemBuilder) -> Self
fn from(value: PathItemBuilder) -> Self
Converts to this type from the input type.
source§impl PartialEq for PathItem
impl PartialEq for PathItem
impl StructuralPartialEq for PathItem
Auto Trait Implementations§
impl Freeze for PathItem
impl RefUnwindSafe for PathItem
impl Send for PathItem
impl Sync for PathItem
impl Unpin for PathItem
impl UnwindSafe for PathItem
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)