PathItem class abstract

Describes the operations available on a single Path.

https://swagger.io/specification/#Path-item-object

Available extensions

• PathItemPatterns

Annotations

• @freezed

Constructors

PathItem({String? summary, String? description, Operation? get, Operation? put, Operation? post, Operation? delete, Operation? options, Operation? head, Operation? patch, Operation? trace, List<Server>? servers, List<Parameter>? parameters, @JsonKey.new(name: '\$ref') @_PathRefConverter.new() String? ref})

const

factory

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

factory

Properties

copyWith → $PathItemCopyWith<PathItem>

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

no setter, inherited

delete → Operation?

A definition of a GET operation on this Path.

no setter, inherited

description → String?

An optional, string description, intended to apply to all operations in this Path.

no setter, inherited

get → Operation?

A definition of a GET operation on this Path.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

head → Operation?

A definition of a GET operation on this Path.

no setter, inherited

options → Operation?

A definition of a GET operation on this Path.

no setter, inherited

parameters → List<Parameter>?

A list of parameters that are applicable for all the operations described under this Path. These parameters can be overridden at the operation level, but cannot be removed there.

no setter, inherited

patch → Operation?

A definition of a GET operation on this Path.

no setter, inherited

post → Operation?

A definition of a GET operation on this Path.

no setter, inherited

put → Operation?

A definition of a GET operation on this Path.

no setter, inherited

ref → String?

Reference to a response defined in Components.pathItems

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

servers → List<Server>?

An alternative Server array to service all operations in this Path.

no setter, inherited

summary → String?

An optional, string summary, intended to apply to all operations in this Path.

no setter, inherited

trace → Operation?

A definition of a GET operation on this Path.

no setter, inherited

Methods

dereference({required Map<String, PathItem>? components}) → PathItem

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

Available on PathItem, provided by the PathItemPatterns extension

A switch-like method, using callbacks.

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

Available on PathItem, provided by the PathItemPatterns extension

A variant of map that fallback to returning null.

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

Available on PathItem, provided by the PathItemPatterns extension

A variant of map that fallback to returning orElse.

maybeWhen<TResult extends Object?>(TResult $default(String? summary, String? description, Operation? get, Operation? put, Operation? post, Operation? delete, Operation? options, Operation? head, Operation? patch, Operation? trace, List<Server>? servers, List<Parameter>? parameters, String? ref)?, {required TResult orElse()}) → TResult

Available on PathItem, provided by the PathItemPatterns 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 PathItem to a JSON map.

inherited

toString() → String

A string representation of this object.

inherited

when<TResult extends Object?>(TResult $default(String? summary, String? description, Operation? get, Operation? put, Operation? post, Operation? delete, Operation? options, Operation? head, Operation? patch, Operation? trace, List<Server>? servers, List<Parameter>? parameters, String? ref)) → TResult

Available on PathItem, provided by the PathItemPatterns extension

A switch-like method, using callbacks.

whenOrNull<TResult extends Object?>(TResult? $default(String? summary, String? description, Operation? get, Operation? put, Operation? post, Operation? delete, Operation? options, Operation? head, Operation? patch, Operation? trace, List<Server>? servers, List<Parameter>? parameters, String? ref)?) → TResult?

Available on PathItem, provided by the PathItemPatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool

The equality operator.

inherited