Parameter class abstract

Describes a single operation parameter.

A unique parameter is defined by a combination of a name and location.

Available extensions

• ParameterPatterns

Annotations

• @Freezed.new(copyWith: true, fromJson: true, toJson: true, equal: true)

Constructors

Parameter({@JsonKey.new(name: r'$ref') String? ref, String? name, @JsonKey.new(name: 'in') ParameterLocation? location, String? description, bool? required, bool? deprecated, Schema? schema, String? type, String? format, String? collectionFormat, Schema? items, num? maximum, num? minimum, bool? explode})

Creates a Parameter object.

const

factory

Parameter.fromJson(Map<String, dynamic> json)

Creates a Parameter from a JSON object.

factory

Properties

collectionFormat → String?

The collection format for array parameters (OpenAPI 2.0).

no setter, inherited

copyWith → $ParameterCopyWith<Parameter>

Create a copy of Parameter with the given fields replaced by the non-null parameter values.

no setter, inherited

deprecated → bool?

Specifies whether the parameter is deprecated.

no setter, inherited

description → String?

A brief description of the parameter.

no setter, inherited

explode → bool?

Specifies whether array or object parameters should be exploded.

no setter, inherited

format → String?

The format of the parameter's value (OpenAPI 2.0).

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

items → Schema?

For array types, describes the type of items in the array (OpenAPI 2.0).

no setter, inherited

location → ParameterLocation?

The location of the parameter, typically query, header, path, or cookie.

no setter, inherited

maximum → num?

The maximum allowed value for a numeric parameter.

no setter, inherited

minimum → num?

The minimum allowed value for a numeric parameter.

no setter, inherited

name → String?

The name of the parameter.

no setter, inherited

ref → String?

A reference to a Parameter Object, typically in the components section. If this field is non-null, all other fields must be null.

no setter, inherited

required → bool?

Specifies whether the parameter is required.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

schema → Schema?

Specifies the schema of the parameter's value (OpenAPI 3.0).

no setter, inherited

type → String?

The data type of the parameter (OpenAPI 2.0).

no setter, inherited

Methods

map<TResult extends Object?>(TResult $default(_Parameter value)) → TResult

Available on Parameter, provided by the ParameterPatterns extension

A switch-like method, using callbacks.

mapOrNull<TResult extends Object?>(TResult? $default(_Parameter value)?) → TResult?

Available on Parameter, provided by the ParameterPatterns extension

A variant of map that fallback to returning null.

maybeMap<TResult extends Object?>(TResult $default(_Parameter value)?, {required TResult orElse()}) → TResult

Available on Parameter, provided by the ParameterPatterns extension

A variant of map that fallback to returning orElse.

maybeWhen<TResult extends Object?>(TResult $default(String? ref, String? name, ParameterLocation? location, String? description, bool? required, bool? deprecated, Schema? schema, String? type, String? format, String? collectionFormat, Schema? items, num? maximum, num? minimum, bool? explode)?, {required TResult orElse()}) → TResult

Available on Parameter, provided by the ParameterPatterns extension

A variant of when that fallback to an orElse callback.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Serializes this Parameter to a JSON map.

inherited

toString() → String

A string representation of this object.

inherited

when<TResult extends Object?>(TResult $default(String? ref, String? name, ParameterLocation? location, String? description, bool? required, bool? deprecated, Schema? schema, String? type, String? format, String? collectionFormat, Schema? items, num? maximum, num? minimum, bool? explode)) → TResult

Available on Parameter, provided by the ParameterPatterns extension

A switch-like method, using callbacks.

whenOrNull<TResult extends Object?>(TResult? $default(String? ref, String? name, ParameterLocation? location, String? description, bool? required, bool? deprecated, Schema? schema, String? type, String? format, String? collectionFormat, Schema? items, num? maximum, num? minimum, bool? explode)?) → TResult?

Available on Parameter, provided by the ParameterPatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool

The equality operator.

inherited