Struct ParamFieldNode 

pub struct ParamFieldNode {
    pub name: String,
    pub location: ParamLocation,
    pub param_type: String,
    pub required: bool,
    pub default: Option<String>,
    pub content: Vec<DocNode>,
}

API parameter documentation field.

Fields

name: String

Parameter name (from header/path/query/body attribute).

location: ParamLocation

Where the parameter appears.

param_type: String

Data type (string, number, boolean, etc.).

required: bool

Whether the parameter is required.

default: Option<String>

Default value if any.

content: Vec<DocNode>

Description content as parsed doc nodes (may contain nested components).

Trait Implementations

impl Clone for ParamFieldNode

fn clone(&self) -> ParamFieldNode

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ParamFieldNode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ParamFieldNode

fn eq(&self, other: &ParamFieldNode) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ParamFieldNode