APIParameterLocation enum Null safety

There are four possible parameter locations specified by the in field.

  • path:
  • query:
  • header:
  • cookie:
Inheritance

Constructors

APIParameterLocation()
const

Values

query → const APIParameterLocation

Parameters that are appended to the URL.

For example, in /items?id=###, the query parameter is id.

Custom headers that are expected as part of the request.

Note that RFC7230 states header names are case insensitive.

path → const APIParameterLocation

Used together with Path Templating, where the parameter value is actually part of the operation's URL.

This does not include the host or base path of the API. For example, in /items/{itemId}, the path parameter is itemId.

Used to pass a specific cookie value to the API.

Properties

hashCode → int
The hash code for this object.
read-onlyinherited
index → int
A numeric identifier for the enumerated value.
read-onlyinherited
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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

Constants

values → const List<APIParameterLocation>
A constant List of the values in this enum, in order of their declaration.
[query, header, path, cookie]