APIPath class

Describes the operations available on a single path.

An APIPath MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.

Inheritance

Constructors

APIPath({String summary, String description, List<APIParameter> parameters, Map<String, APIOperation> operations })
APIPath.empty()

Properties

description ↔ String
An optional, string description, intended to apply to all operations in this path. [...]
read / write
operations ↔ Map<String, APIOperation>
Definitions of operations on this path. [...]
read / write
parameters ↔ List<APIParameter>
A list of parameters that are applicable for all the operations described under this path. [...]
read / write
summary ↔ String
An optional, string summary, intended to apply to all operations in this path.
read / write
castMap → Map<String, Cast>
read-only, inherited
extensions ↔ Map<String, dynamic>
read / write, inherited
hashCode → int
The hash code for this object.
read-only, inherited
referenceURI ↔ Uri
read / write, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

containsPathParameters(List<String> parameterNames) → bool
Returns true if this path has path parameters parameterNames. [...]
decode(KeyedArchive object) → void
override
encode(KeyedArchive object) → void
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

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