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 requireddeprecated: Whether the parameter is deprecateddescription: 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: StringOriginal 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: StringResolved 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: boolWhether the parameter is required
If true, the parameter must be provided when calling the API.
deprecated: boolWhether 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: ParameterLocationParameter 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
impl Clone for ParameterInfo
Source§fn clone(&self) -> ParameterInfo
fn clone(&self) -> ParameterInfo
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more