APIOperation class Null safety
Describes a single API operation on a path.
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. [...]
read / write
-
castMap
→ Map<
String, Cast> -
read-only, override
- description ↔ String?
-
A verbose explanation of the operation behavior. [...]
read / write
-
extensions
↔ Map<
String, dynamic> -
read / write, inherited
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- id ↔ String?
-
Unique string used to identify the operation. [...]
read / write
- isDeprecated ↔ bool
-
Declares this operation to be deprecated. [...]
read / write
-
parameters
↔ List<
APIParameter> ? -
A list of parameters that are applicable for this operation. [...]
read / write
- referenceURI ↔ Uri
-
read / write, inherited
- requestBody ↔ APIRequestBody?
-
The request body applicable for this operation. [...]
read / write
-
responses
↔ Map<
String, APIResponse> ? -
The list of possible responses as they are returned from executing this operation. [...]
read / write
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
-
security
↔ List<
APISecurityRequirement> ? -
A declaration of which security mechanisms can be used for this operation. [...]
read / write
-
servers
↔ List<
APIServerDescription> ? -
An alternative server array to service this operation. [...]
read / write
- summary ↔ String?
-
A short summary of what the operation does.
read / write
-
A list of tags for API documentation control. [...]
read / write
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 non-existent 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