APIHeader class
APIHeader follows the structure of the APIParameter with the following changes:
name MUST NOT be specified, it is given in the corresponding headers map. in MUST NOT be specified, it is implicitly in header. All traits that are affected by the location MUST be applicable to a location of header (for example, style).
- Inheritance
-
- Object
- APIObject
- APIParameter
- APIHeader
Constructors
- APIHeader({APISchemaObject? schema})
- APIHeader.empty()
Properties
- allowEmptyValue ↔ bool?
-
getter/setter pairinherited
- allowReserved ↔ bool?
-
Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding.
getter/setter pairinherited
-
castMap
→ Map<
String, Cast> ? -
no setterinherited
-
content
↔ Map<
String, APIMediaType?> ? -
A map containing the representations for the parameter.
getter/setter pairinherited
- deprecated ↔ bool?
-
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
getter/setter pairinherited
- description ↔ String?
-
A brief description of the parameter.
getter/setter pairinherited
- explode ↔ bool?
-
When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map.
getter/setter pairinherited
-
extensions
↔ Map<
String, dynamic> -
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- isRequired ↔ bool?
-
Determines whether this parameter is mandatory.
getter/setter pairinherited
- location ↔ APIParameterLocation?
-
The location of the parameter.
getter/setter pairinherited
- name ↔ String?
-
The name of the parameter.
getter/setter pairinherited
- referenceURI ↔ Uri?
-
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- schema ↔ APISchemaObject?
-
The schema defining the type used for the parameter.
getter/setter pairinherited
- style ↔ String?
-
Describes how the parameter value will be serialized depending on the type of the parameter value.
getter/setter pairinherited
Methods
-
decode(
KeyedArchive object) → void -
inherited
-
encode(
KeyedArchive object) → void -
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited