Skip to main content

ParameterInfo

Struct ParameterInfo 

Source
pub struct ParameterInfo {
    pub original_name: String,
    pub param_name: String,
    pub schema: Option<ObjectOrReference<ObjectSchema>>,
    pub required: bool,
    pub deprecated: bool,
    pub description: Option<String>,
    pub default_value: Option<Value>,
    pub location: ParameterLocation,
}
Expand description

Parameter information for code generation

This struct represents a parameter extracted from an OpenAPI operation after name conflict resolution. It contains both the original parameter name (used for HTTP requests) and the resolved parameter name (used in generated code).

§Fields

  • original_name: The original parameter name from the OpenAPI spec, used when constructing HTTP requests (e.g., query strings, headers, path segments)
  • param_name: The resolved parameter name after conflict resolution, used in generated code (may have location prefixes if conflicts exist)
  • schema: The OpenAPI schema definition for the parameter (if available)
  • required: Whether the parameter is required
  • deprecated: Whether the parameter is deprecated
  • description: Parameter description from the OpenAPI spec (if available)
  • default_value: Default value for the parameter (if specified in the schema)
  • location: The parameter location (path, query, header, or body)

Fields§

§original_name: String

Original parameter name (for HTTP usage)

This is the parameter name as specified in the OpenAPI spec. It is used when constructing HTTP requests (e.g., in query strings, headers, or path segments).

§param_name: String

Resolved parameter name (for code generation)

This is the parameter name after conflict resolution. If multiple parameters from different locations have the same camelCase name, they will be prefixed with their location (e.g., “pathId”, “queryId”). This name is used in generated code.

§schema: Option<ObjectOrReference<ObjectSchema>>

OpenAPI schema definition for the parameter

Contains the type information and validation rules from the OpenAPI spec. May be None if not needed for template rendering.

§required: bool

Whether the parameter is required

If true, the parameter must be provided when calling the API.

§deprecated: bool

Whether the parameter is deprecated

If true, the parameter is marked as deprecated in the OpenAPI spec and should be avoided in new code.

§description: Option<String>

Parameter description

Human-readable description of the parameter from the OpenAPI spec. May be None if no description is provided.

§default_value: Option<Value>

Default value for the parameter

The default value extracted from the parameter’s schema as a JSON value. Preserves the original type from the OpenAPI spec (string, number, boolean, null, array, object). May be None if no default value is specified.

§location: ParameterLocation

Parameter location

Indicates where the parameter is used in the HTTP request:

  • Path: URL path segment (e.g., /users/{id})
  • Query: Query string parameter (e.g., ?page=1)
  • Header: HTTP header (e.g., Authorization: Bearer ...)
  • Body: Request body (for POST/PUT/PATCH requests)

Trait Implementations§

Source§

impl Clone for ParameterInfo

Source§

fn clone(&self) -> ParameterInfo

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ParameterInfo

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ParameterInfo

Source§

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 Serialize for ParameterInfo

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,