Struct aide::openapi::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: Vec<Server>,
    pub parameters: Vec<ReferenceOr<Parameter>>,
    pub extensions: IndexMap<String, Value>,
}

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 a referenced definition of this path item. The referenced structure MUST be in the form of a Path Item Object. In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. See the rules for resolving Relative References.

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

impl PathItem

pub fn iter(&self) -> impl Iterator<Item = (&str, &Operation)>

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

pub fn merge(self, other: Self) -> Self

Merges two path items as well as it can. Global settings will likely conflict. Conflicts always favor self.

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

Merges self with other path item as well as it can. Global settings will likely conflict. Conflicts always favor self.

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

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

Deserialize this value from the given Serde deserializer.

impl IntoIterator for PathItem

fn into_iter(self) -> Self::IntoIter

Returns an iterator of the Operations in the PathItem.

type Item = (&'static str, Operation)

The type of the elements being iterated over.

type IntoIter = IntoIter<<PathItem as IntoIterator>::Item, Global>

Which kind of iterator are we turning this into?

impl JsonSchema for PathItem

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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