Operation class

Describes a single API operation on a Path.

https://swagger.io/specification/#operation-object

Annotations

• @freezed

Constructors

Operation.new({List<String>? tags, String? summary, String? description, ExternalDocs? externalDocs, @JsonKey(name: 'operationId') String? id, List<Parameter>? parameters, RequestBody? requestBody, Map<String, Response>? responses, @_ApiCallbackMapConverter() Map<String, ApiCallback>? callbacks, bool? deprecated, List<Security>? security, List<Server>? servers})

const

factory

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

factory

Properties

callbacks → Map<String, ApiCallback>?

A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the ApiCallback Object.

no setter, inherited

copyWith → $OperationCopyWith<Operation>

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

no setter, inherited

deprecated → bool?

Declares this operation to be deprecated.

no setter, inherited

description → String?

An optional string describing the host designated by the URL.

no setter, inherited

externalDocs → ExternalDocs?

Additional external documentation for this schema.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

id → String?

Unique string used to identify the operation. The id MUST be unique among all operations described in the API.

no setter, inherited

parameters → List<Parameter>?

A list of parameters that are applicable for this operation. If a parameter is already defined at the PathItem level, the new definition will override it but can never remove it.

no setter, inherited

requestBody → RequestBody?

The request body applicable for this operation.

no setter, inherited

responses → Map<String, Response>?

The list of possible responses as they are returned from executing this operation.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

security → List<Security>?

A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used.

no setter, inherited

servers → List<Server>?

An alternative Server array to service this operation. If an alternative Server object is specified at the PathItem level, it will be overridden by this value.

no setter, inherited

summary → String?

A short summary of what the operation does.

no setter, inherited

tags → List<String>?

A list of tags for API documentation control.

no setter, inherited

Methods

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

inherited

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

inherited

maybeMap<TResult extends Object?>(TResult $default(_Operation 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 Operation to a JSON map.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited