OpenApiV30Components class final

Named definitions for use elsewhere in the document.

Constructors

OpenApiV30Components({Map<String, OpenApiV30RefOr<OpenApiV30Schema>>? schemas, Map<String, OpenApiV30RefOr<OpenApiV30Response>>? responses, Map<String, OpenApiV30RefOr<OpenApiV30Parameter>>? parameters, Map<String, OpenApiV30RefOr<OpenApiV30Example>>? examples, Map<String, OpenApiV30RefOr<OpenApiV30RequestBody>>? requestBodies, Map<String, OpenApiV30RefOr<OpenApiV30Header>>? headers, Map<String, OpenApiV30RefOr<OpenApiV30SecurityScheme>>? securitySchemes, Map<String, OpenApiV30RefOr<OpenApiV30Link>>? links, Map<String, OpenApiV30RefOr<OpenApiV30Callback>>? callbacks, Map<String, JsonValue> extensions = const {}, Map<String, JsonValue> extraFields = const {}})
Groups reusable definitions by component type and name.

Properties

callbacks → Map<String, OpenApiV30RefOr<OpenApiV30Callback>>?
Callback definitions indexed by name.
final
examples → Map<String, OpenApiV30RefOr<OpenApiV30Example>>?
Reusable examples indexed by component name.
final
extensions → Map<String, JsonValue>
Specification extensions keyed by their x- names. Defaults to empty.
finalinherited
extraFields → Map<String, JsonValue>
Unrecognized fields retained for JSON export. Defaults to empty.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
headers → Map<String, OpenApiV30RefOr<OpenApiV30Header>>?
Reusable headers indexed by component name.
final
Links to related operations, indexed by name.
final
parameters → Map<String, OpenApiV30RefOr<OpenApiV30Parameter>>?
Reusable parameters indexed by component name.
final
requestBodies → Map<String, OpenApiV30RefOr<OpenApiV30RequestBody>>?
Reusable request bodies indexed by component name.
final
responses → Map<String, OpenApiV30RefOr<OpenApiV30Response>>?
Reusable responses indexed by component name.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schemas → Map<String, OpenApiV30RefOr<OpenApiV30Schema>>?
Reusable schemas indexed by component name.
final
securitySchemes → Map<String, OpenApiV30RefOr<OpenApiV30SecurityScheme>>?
Reusable security schemes indexed by component name.
final

Methods

extraToJson() → Map<String, Object?>
Exports extensions and unrecognized fields as JSON.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, Object?>
Returns a detached JSON representation.
override
toString() → String
A string representation of this object.
inherited

Operators

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