Annotation Interface OpenApi.HttpSecurityScheme

Enclosing class:

OpenApi

@Target(TYPE)
@Retention(CLASS)
@Repeatable(OpenApi.HttpSecuritySchemes.class)
@Documented
public static @interface OpenApi.HttpSecurityScheme

OpenAPI HTTP Security Scheme Object metadata.

Use only on @OpenApi.Document metadata types.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	name	Component name.
String	scheme	HTTP authorization scheme.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	bearerFormat	Bearer format.
boolean	deprecated	Whether the security scheme is deprecated.
String	description	Security scheme description.

Element Details

name

String name

Component name.

Returns:

name

description

String description

Security scheme description.

Returns:

description

Default:

""

scheme

String scheme

HTTP authorization scheme.

Returns:

scheme

bearerFormat

String bearerFormat

Bearer format. Valid only when scheme() is bearer.

Returns:

bearer format

Default:

""

deprecated

boolean deprecated

Whether the security scheme is deprecated.

Rendered only for OpenAPI 3.2 output.

Returns:

deprecated flag

Default:

false