pub struct PathItem {
Show 13 fields 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: Vec<Server>, pub parameters: Vec<ReferenceOr<Parameter>>, pub extensions: IndexMap<String, Value>,
}
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

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>put: Option<Operation>post: Option<Operation>delete: Option<Operation>options: Option<Operation>head: Option<Operation>patch: Option<Operation>trace: Option<Operation>servers: Vec<Server>

An alternative server array to service all operations in this path.

parameters: Vec<ReferenceOr<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.

extensions: IndexMap<String, Value>

Inline extensions to this object.

Implementations

Returns an iterator of references to the Operations in the PathItem.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Deserialize this value from the given Serde deserializer. Read more

Returns an iterator of the Operations in the PathItem.

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.