Struct jsona_openapi::PathItem
source · [−]pub struct PathItem {Show 13 fields
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: Option<Vec<ObjectOrReference<Parameter>>>,
}
Expand description
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.
summary: Option<String>
An optional, string summary, intended to apply to all operations in this path.
description: Option<String>
An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.
get: Option<Operation>
A definition of a GET operation on this path.
put: Option<Operation>
A definition of a PUT operation on this path.
post: Option<Operation>
A definition of a POST operation on this path.
delete: Option<Operation>
A definition of a DELETE operation on this path.
options: Option<Operation>
A definition of a OPTIONS operation on this path.
head: Option<Operation>
A definition of a HEAD operation on this path.
patch: Option<Operation>
A definition of a PATCH operation on this path.
trace: Option<Operation>
A definition of a TRACE operation on this path.
servers: Option<Vec<Server>>
An alternative server
array to service all operations in this path.
parameters: Option<Vec<ObjectOrReference<Parameter>>>
A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object’s components/parameters.
Trait Implementations
sourceimpl<'de> Deserialize<'de> for PathItem
impl<'de> Deserialize<'de> for PathItem
sourcefn 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
sourceimpl PartialEq<PathItem> for PathItem
impl PartialEq<PathItem> for PathItem
impl StructuralPartialEq for PathItem
Auto Trait Implementations
impl RefUnwindSafe for PathItem
impl Send for PathItem
impl Sync for PathItem
impl Unpin for PathItem
impl UnwindSafe for PathItem
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more