io.swagger.v3.oas.annotations.headers

Annotation Type Header

@Target(value={})
 @Retention(value=RUNTIME)
 @Inherited
public @interface Header

The annotation may be used to add one or more headers to the definition of a response or as attribute of content encoding by definining it as field ApiResponse.headers() or Content.encoding().

Please note that request headers are defined as Header Parameter.

See Also:

Header (OpenAPI specification), ApiResponse, Parameter, Encoding

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name Required: The name of the header.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	allowEmptyValue When true, allows sending an empty value.
boolean	deprecated Specifies that a header is deprecated and should be transitioned out of usage.
String	description Additional description data to provide on the purpose of the header
boolean	required Determines whether this header is mandatory.
Schema	schema The schema defining the type used for the header.

Element Detail

name

public abstract String name

Required: The name of the header. The name is only used as the key to store this header in a map.

Returns:

the header's name

description

public abstract String description

Additional description data to provide on the purpose of the header

Returns:

the header's description

Default:

""

schema

public abstract Schema schema

The schema defining the type used for the header. Ignored if the properties content or array are specified.

Returns:

the schema of the header

Default:

@io.swagger.v3.oas.annotations.media.Schema

required

public abstract boolean required

Determines whether this header is mandatory. The property may be included and its default value is false.

Returns:

whether or not the header is required

Default:

false

deprecated

public abstract boolean deprecated

Specifies that a header is deprecated and should be transitioned out of usage.

Returns:

whether or not the header is deprecated

Default:

false

allowEmptyValue

public abstract boolean allowEmptyValue

When true, allows sending an empty value. If false, the header will be considered \"null\" if no value is present. This may create validation errors when the header is required.

Returns:

whether or not the header allows empty values

Default:

false