Components class abstract

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

Available extensions

• ComponentsPatterns

Annotations

• @freezed

Constructors

Components({@_SchemaMapConverter.new() 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.new() 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 setter, inherited

copyWith → $ComponentsCopyWith<Components>

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

no setter, inherited

examples → Map<String, Example>?

A set of reusable Example objects.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

headers → Map<String, Header>?

A set of reusable Header objects.

no setter, inherited

links → Map<String, Link>?

A set of reusable Link objects.

no setter, inherited

parameters → Map<String, Parameter>?

A set of reusable Parameter objects.

no setter, inherited

pathItems → Map<String, PathItem>?

A set of reusable PathItem objects.

no setter, inherited

requestBodies → Map<String, RequestBody>?

A set of reusable RequestBody.component objects.

no setter, inherited

responses → Map<String, Response>?

A set of reusable Response objects.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

schemas → Map<String, Schema>?

A set of reusable Schema objects.

no setter, inherited

securitySchemes → Map<String, SecurityScheme>?

A set of reusable SecurityScheme objects.

no setter, inherited

Methods

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

Available on Components, provided by the ComponentsPatterns extension

A switch-like method, using callbacks.

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

Available on Components, provided by the ComponentsPatterns extension

A variant of map that fallback to returning null.

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

Available on Components, provided by the ComponentsPatterns extension

A variant of map that fallback to returning orElse.

maybeWhen<TResult extends Object?>(TResult $default(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, Map<String, ApiCallback>? callbacks, Map<String, PathItem>? pathItems)?, {required TResult orElse()}) → TResult

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

inherited

toString() → String

A string representation of this object.

inherited

when<TResult extends Object?>(TResult $default(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, Map<String, ApiCallback>? callbacks, Map<String, PathItem>? pathItems)) → TResult

Available on Components, provided by the ComponentsPatterns extension

A switch-like method, using callbacks.

whenOrNull<TResult extends Object?>(TResult? $default(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, Map<String, ApiCallback>? callbacks, Map<String, PathItem>? pathItems)?) → TResult?

Available on Components, provided by the ComponentsPatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool

The equality operator.

inherited