SecurityScheme constructor

@JsonSerializable.new(includeIfNull: false, explicitToJson: true) const SecurityScheme({ required String type, String? description, String? name, @JsonKey.new(name: 'in') ParameterLocation? location, String? scheme, String? bearerFormat, String? flow, String? authorizationUrl, Map<String, String>? scopes, })

Creates a SecurityScheme object.

Implementation

@JsonSerializable(includeIfNull: false, explicitToJson: true)
const factory SecurityScheme({
  /// The type of the security scheme.
  required String type,

  /// A short description of the security scheme.
  String? description,

  /// The name of the header, query, or cookie parameter to be used.
  String? name,

  /// The location of the API key.
  @JsonKey(name: 'in') ParameterLocation? location,

  /// The name of the HTTP Authorization scheme to be used in
  /// the Authorization header.
  String? scheme,

  /// A hint to the client to identify the bearer token scheme.
  String? bearerFormat,

  /// The flow used by the OAuth2 security scheme.
  String? flow,

  /// The authorization URL to be used for this flow.
  String? authorizationUrl,

  /// The available scopes for the OAuth2 flow.
  Map<String, String>? scopes,
}) = _SecurityScheme;