ApiParameter class

A single parameter for an endpoint (path / query / header / body).

name — camelCase Dart parameter name. rawName — original name from the spec (used as query/header key). type — resolved ApiType. location — where this parameter lives in the request. required — whether absence should be a compile-time error. description — optional doc comment. deprecated — emit @Deprecated annotation if true.

Constructors

ApiParameter({required String name, required ApiType type, required ParameterLocation location, String? rawName, bool required = false, String? description, bool deprecated = false, Object? defaultValue, List<Object>? allowedValues})

const

Properties

allowedValues → List<Object>?

final

defaultValue → Object?

final

deprecated → bool

final

description → String?

final

effectiveRawName → String

The key to use when building the query string or headers map.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

location → ParameterLocation

final

name → String

final

rawName → String?

final

required → bool

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

type → ApiType

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited