APIOperation class

Describes a single API operation on a path.

Inheritance

Constructors

APIOperation(String? id, Map<String, APIResponse?>? responses, {List<String>? tags, String? summary, String? description, List<APIParameter>? parameters, List<APISecurityRequirement>? security, APIRequestBody? requestBody, Map<String, APICallback?>? callbacks, bool? deprecated})
APIOperation.empty()

Properties

callbacks ↔ Map<String, APICallback?>?
A map of possible out-of band callbacks related to the parent operation.
getter/setter pair
castMap → Map<String, Cast>
no setter
deprecated ↔ bool?
Declares this operation to be deprecated.
getter/setter pair
description ↔ String?
A verbose explanation of the operation behavior.
getter/setter pair
extensions ↔ Map<String, dynamic>
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ String?
Unique string used to identify the operation.
getter/setter pair
parameters ↔ List<APIParameter>?
A list of parameters that are applicable for this operation.
getter/setter pair
referenceURI ↔ Uri?
getter/setter pairinherited
requestBody ↔ APIRequestBody?
The request body applicable for this operation.
getter/setter pair
responses ↔ Map<String, APIResponse?>?
The list of possible responses as they are returned from executing this operation.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
security ↔ List<APISecurityRequirement>?
A declaration of which security mechanisms can be used for this operation.
getter/setter pair
servers ↔ List<APIServerDescription?>?
An alternative server array to service this operation.
getter/setter pair
summary ↔ String?
A short summary of what the operation does.
getter/setter pair
tags ↔ List<String>?
A list of tags for API documentation control.
getter/setter pair

Methods

addParameter(APIParameter parameter) → void
Adds parameter to parameters.
addResponse(int statusCode, APIResponse? response) → void
Adds response to responses, merging schemas if necessary.
addSecurityRequirement(APISecurityRequirement requirement) → void
Adds requirement to security.
decode(KeyedArchive object) → void
override
encode(KeyedArchive object) → void
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
parameterNamed(String name) → APIParameter?
Returns the parameter named name or null if it doesn't exist.
toString() → String
A string representation of this object.
inherited

Operators

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