PathItem class

Describes the operations available on a single Path.

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

Annotations
  • @freezed

Constructors

PathItem.new({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(name: '\$ref') @_PathRefConverter() 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 setterinherited
delete → Operation?
A definition of a GET operation on this Path.
no setterinherited
description → String?
An optional, string description, intended to apply to all operations in this Path.
no setterinherited
get → Operation?
A definition of a GET operation on this Path.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
A definition of a GET operation on this Path.
no setterinherited
options → Operation?
A definition of a GET operation on this Path.
no setterinherited
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 setterinherited
patch → Operation?
A definition of a GET operation on this Path.
no setterinherited
post → Operation?
A definition of a GET operation on this Path.
no setterinherited
put → Operation?
A definition of a GET operation on this Path.
no setterinherited
ref → String?
Reference to a response defined in Components.pathItems
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
servers → List<Server>?
An alternative Server array to service all operations in this Path.
no setterinherited
summary → String?
An optional, string summary, intended to apply to all operations in this Path.
no setterinherited
trace → Operation?
A definition of a GET operation on this Path.
no setterinherited

Methods

dereference({required Map<String, PathItem>? components}) → PathItem
map<TResult extends Object?>(TResult $default(_PathItem value)) → TResult
inherited
mapOrNull<TResult extends Object?>(TResult? $default(_PathItem value)?) → TResult?
inherited
maybeMap<TResult extends Object?>(TResult $default(_PathItem value)?, {required TResult orElse()}) → TResult
inherited
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

Operators

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