Annotation Interface OpenApi.OAuth2SecurityScheme

Enclosing class:

OpenApi

@Target(TYPE)
@Retention(CLASS)
@Repeatable(OpenApi.OAuth2SecuritySchemes.class)
@Documented
public static @interface OpenApi.OAuth2SecurityScheme

OpenAPI OAuth 2 Security Scheme Object metadata.

Use only on @OpenApi.Document metadata types.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
OpenApi.OAuthFlows	flows	OAuth flows.
String	name	Component name.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	deprecated	Whether the security scheme is deprecated.
String	description	Security scheme description.
String	oauth2MetadataUrl	OpenAPI 3.2 OAuth 2 metadata URL.

Element Details

name

String name

Component name.

Returns:

name

description

String description

Security scheme description.

Returns:

description

Default:

""

flows

OpenApi.OAuthFlows flows

OAuth flows. At least one flow must be configured.

Returns:

OAuth flows

oauth2MetadataUrl

String oauth2MetadataUrl

OpenAPI 3.2 OAuth 2 metadata URL.

Rendered only for OpenAPI 3.2 output.

Returns:

OAuth 2 metadata URL

Default:

""

deprecated

boolean deprecated

Whether the security scheme is deprecated.

Rendered only for OpenAPI 3.2 output.

Returns:

deprecated flag

Default:

false