OpenApiV32Parameter class final

A named input to an operation.

Constructors

OpenApiV32Parameter({required String name, required OpenApiV32ParameterLocation location, String? description, bool? isRequired, bool? deprecated, bool? allowEmptyValue, OpenApiV32Style? style, bool? explode, bool? allowReserved, OpenApiV32Schema? schema, JsonValue? example, Map<String, OpenApiV32RefOr<OpenApiV32Example>>? examples, Map<String, OpenApiV32RefOr<OpenApiV32MediaType>>? content, Map<String, JsonValue> extensions = const {}, Map<String, JsonValue> extraFields = const {}})
Describes an input by name and request location.

Properties

allowEmptyValue → bool?
Whether a query parameter can have an empty value.
final
allowReserved → bool?
Whether reserved URI characters can appear unescaped.
final
content → Map<String, OpenApiV32RefOr<OpenApiV32MediaType>>?
Representations indexed by media type.
final
deprecated → bool?
Whether the author discourages new uses.
final
description → String?
Description supplied by the document author.
final
example → JsonValue?
An inline example value.
final
examples → Map<String, OpenApiV32RefOr<OpenApiV32Example>>?
Named examples for this representation.
final
explode → bool?
Whether to serialize array items or object properties separately.
final
extensions → Map<String, JsonValue>
Specification extensions keyed by their x- names. Defaults to empty.
finalinherited
extraFields → Map<String, JsonValue>
Unrecognized fields retained for JSON export. Defaults to empty.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
isRequired → bool?
Whether the caller must supply this input.
final
location → OpenApiV32ParameterLocation
Where the request carries this value.
final
name → String
Parameter name in its declared request location.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schema → OpenApiV32Schema?
Schema that describes the value.
final
style → OpenApiV32Style?
Serialization style for the parameter or property.
final

Methods

extraToJson() → Map<String, Object?>
Exports extensions and unrecognized fields as JSON.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, Object?>
Returns a detached JSON representation.
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited