OperationObjectV3 class
Operation object representing an operation in a path.
- Inheritance
-
- Object
- OpenApiOperation<
Map< String, dynamic> > - OperationObjectV3
- Implementers
Constructors
-
OperationObjectV3({List<
String> ? tags, String? summary, String? description, ExternalDocumentationObjectV3? externalDocs, String? operationId, List<OpenApiObject< ? parameters, OpenApiObject<Map> >Map> ? requestBody, ResponsesV3? responses, bool? deprecated, List<SecurityRequirementsV3> ? security, List<ServerObjectV3> ? servers, Map<String, dynamic> ? extensions}) - Creates an OperationObjectV3 with the given parameters.
- OperationObjectV3.fromMap(Map map)
-
Creates an OperationObjectV3 from a map.
factory
Properties
- deprecated → bool?
-
Indicates whether the operation is deprecated.
final
- description → String?
-
A verbose explanation of the operation behavior.
final
-
extensions
→ Map<
String, dynamic> ? -
Vendor-specific extension fields (
x-*) merged into the operation.finalinherited - externalDocs → ExternalDocumentationObjectV3?
-
Additional external documentation for the operation.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- operationId → String?
-
A unique identifier for the operation.
final
-
parameters
→ List<
OpenApiObject< ?Map> > -
A list of parameters for the operation.
final
-
requestBody
→ OpenApiObject<
Map> ? -
The request body for the operation.
final
- responses → ResponsesV3?
-
The responses for the operation.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
security
→ List<
SecurityRequirementsV3> ? -
A list of security requirements for the operation.
final
-
servers
→ List<
ServerObjectV3> ? -
A list of servers for the operation.
final
- summary → String?
-
A short summary of the operation.
final
-
A list of tags for API documentation control.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
Converts the OpenApiOperation to a map.
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited