OperationObjectV2 class
Operation object representing a single API operation on a path.
- Inheritance
-
- Object
- OpenApiOperation<
Map< String, dynamic> > - OperationObjectV2
Constructors
-
OperationObjectV2({List<
String> ? tags, String? summary, String? description, ExternalDocumentationObjectV2? externalDocs, String? operationId, List<ParameterObjectV2> ? parameters, required Map<String, ResponseObjectV2> responses, List<String> ? consumes, List<String> ? produces, List<Map< ? security, Map<String, List< >String> >String, dynamic> ? extensions}) - Creates an OperationObjectV2 with the given parameters.
- OperationObjectV2.fromMap(Map map)
-
Creates an OperationObjectV2 from a map.
factory
Properties
-
consumes
→ List<
String> ? -
A list of MIME types the operation can consume.
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 → ExternalDocumentationObjectV2?
-
Additional details about the operation.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- operationId → String?
-
A unique identifier for the operation.
final
-
parameters
→ List<
ParameterObjectV2> ? -
A list of parameters for the operation.
final
-
produces
→ List<
String> ? -
A list of MIME types the operation can produce.
final
-
responses
→ Map<
String, ResponseObjectV2> -
The list of possible responses as they are returned from executing this operation.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
security
→ List<
Map< ?String, List< >String> > -
A declaration of which security schemes are applied for this operation.
final
- summary → String?
-
A short summary of what the operation does.
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