Components class

Holds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object. https://swagger.io/specification/#components-object

Annotations
  • @freezed

Constructors

Components.new({@_SchemaMapConverter() Map<String, Schema>? schemas, Map<String, Response>? responses, Map<String, Parameter>? parameters, Map<String, Example>? examples, Map<String, RequestBody>? requestBodies, Map<String, Header>? headers, Map<String, SecurityScheme>? securitySchemes, Map<String, Link>? links, @_ApiCallbackMapConverter() Map<String, ApiCallback>? callbacks, Map<String, PathItem>? pathItems})
const
factory
Components.fromJson(Map<String, dynamic> json)
factory

Properties

callbacks → Map<String, ApiCallback>?
A set of reusable ApiCallback objects.
no setterinherited
copyWith → $ComponentsCopyWith<Components>
Create a copy of Components with the given fields replaced by the non-null parameter values.
no setterinherited
examples → Map<String, Example>?
A set of reusable Example objects.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
headers → Map<String, Header>?
A set of reusable Header objects.
no setterinherited
A set of reusable Link objects.
no setterinherited
parameters → Map<String, Parameter>?
A set of reusable Parameter objects.
no setterinherited
pathItems → Map<String, PathItem>?
A set of reusable PathItem objects.
no setterinherited
requestBodies → Map<String, RequestBody>?
A set of reusable RequestBody.component objects.
no setterinherited
responses → Map<String, Response>?
A set of reusable Response objects.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schemas → Map<String, Schema>?
A set of reusable Schema objects.
no setterinherited
securitySchemes → Map<String, SecurityScheme>?
A set of reusable SecurityScheme objects.
no setterinherited

Methods

map<TResult extends Object?>(TResult $default(_Components value)) → TResult
inherited
mapOrNull<TResult extends Object?>(TResult? $default(_Components value)?) → TResult?
inherited
maybeMap<TResult extends Object?>(TResult $default(_Components 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 Components to a JSON map.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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