ParameterObjectV2 class
Parameter object representing a single operation parameter.
- Inheritance
-
- Object
- OpenApiObject<
Map< String, dynamic> > - OpenApiParameter<
Map< String, dynamic> > - ParameterObjectV2
Constructors
-
ParameterObjectV2({required String name, required String in_, String? description, String? type, String? format, Object? schema, bool? required, Map<
String, dynamic> ? extensions}) -
Creates a ParameterObjectV2 with the given parameters.
const
- ParameterObjectV2.fromMap(Map map)
-
Creates a ParameterObjectV2 from a map.
factory
Properties
- description → String?
-
A brief description of the parameter.
final
-
extensions
→ Map<
String, dynamic> ? -
Vendor-specific extension fields (
x-*) merged into the object.finalinherited - format → String?
-
The extending format for the parameter type (e.g., "int32", "int64", "float", "double", "byte", "binary", "date", "date-time", "password").
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- in_ → String
-
The location of the parameter (e.g., "query", "header", "path", "formData", "body").
final
- name → String
-
The name of the parameter.
final
- required → bool?
-
Determines whether this parameter is mandatory.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- schema → Object?
-
The schema defining the type used for the body parameter.
final
- type → String?
-
The type of the parameter (e.g., "string", "number", "integer", "boolean", "array", "file").
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
Converts the OpenApiObject to a map.
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited