@Target(value={}) @Retention(value=RUNTIME) @Inherited public @interface Header
ApiResponse.headers()
or Content.encoding()
.
Please note that request headers are defined as Header Parameter
.
ApiResponse
,
Parameter
,
Encoding
Modifier and Type | Required Element and Description |
---|---|
String |
name
Required: The name of the header.
|
Modifier and Type | Optional Element and Description |
---|---|
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
|
String |
ref
A reference to a header defined in components headers.
|
boolean |
required
Determines whether this header is mandatory.
|
Schema |
schema
The schema defining the type used for the header.
|
public abstract String name
public abstract String description
public abstract Schema schema
public abstract boolean required
public abstract boolean deprecated
public abstract String ref
Copyright © 2022. All rights reserved.