public abstract class HeaderDocumentation extends Object
Modifier and Type | Method and Description |
---|---|
static HeaderDescriptor |
headerWithName(String name)
Creates a
HeaderDescriptor that describes a header with the given
name . |
static RequestHeadersSnippet |
requestHeaders(HeaderDescriptor... descriptors)
Returns a new
Snippet that will document the headers of the API operation's
request. |
static RequestHeadersSnippet |
requestHeaders(List<HeaderDescriptor> descriptors)
Returns a new
Snippet that will document the headers of the API operation's
request. |
static RequestHeadersSnippet |
requestHeaders(Map<String,Object> attributes,
HeaderDescriptor... descriptors)
Returns a new
Snippet that will document the headers of the API
operations's request. |
static RequestHeadersSnippet |
requestHeaders(Map<String,Object> attributes,
List<HeaderDescriptor> descriptors)
Returns a new
Snippet that will document the headers of the API
operations's request. |
static ResponseHeadersSnippet |
responseHeaders(HeaderDescriptor... descriptors)
Returns a new
Snippet that will document the headers of the API operation's
response. |
static ResponseHeadersSnippet |
responseHeaders(List<HeaderDescriptor> descriptors)
Returns a new
Snippet that will document the headers of the API operation's
response. |
static ResponseHeadersSnippet |
responseHeaders(Map<String,Object> attributes,
HeaderDescriptor... descriptors)
Returns a new
Snippet that will document the headers of the API
operations's response. |
static ResponseHeadersSnippet |
responseHeaders(Map<String,Object> attributes,
List<HeaderDescriptor> descriptors)
Returns a new
Snippet that will document the headers of the API
operations's response. |
public static HeaderDescriptor headerWithName(String name)
HeaderDescriptor
that describes a header with the given
name
.name
- the name of the headerHeaderDescriptor
ready for further configurationpublic static RequestHeadersSnippet requestHeaders(HeaderDescriptor... descriptors)
Snippet
that will document the headers of the API operation's
request. The headers will be documented using the given descriptors
.
If a header is documented, is not marked as optional, and is not present in the request, a failure will occur.
descriptors
- the descriptions of the request's headersheaderWithName(String)
public static RequestHeadersSnippet requestHeaders(List<HeaderDescriptor> descriptors)
Snippet
that will document the headers of the API operation's
request. The headers will be documented using the given descriptors
.
If a header is documented, is not marked as optional, and is not present in the request, a failure will occur.
descriptors
- the descriptions of the request's headersheaderWithName(String)
public static RequestHeadersSnippet requestHeaders(Map<String,Object> attributes, HeaderDescriptor... descriptors)
Snippet
that will document the headers of the API
operations's request. The given attributes
will be available during snippet
generation and the headers will be documented using the given descriptors
.
If a header is documented, is not marked as optional, and is not present in the request, a failure will occur.
attributes
- the attributesdescriptors
- the descriptions of the request's headersheaderWithName(String)
public static RequestHeadersSnippet requestHeaders(Map<String,Object> attributes, List<HeaderDescriptor> descriptors)
Snippet
that will document the headers of the API
operations's request. The given attributes
will be available during snippet
generation and the headers will be documented using the given descriptors
.
If a header is documented, is not marked as optional, and is not present in the request, a failure will occur.
attributes
- the attributesdescriptors
- the descriptions of the request's headersheaderWithName(String)
public static ResponseHeadersSnippet responseHeaders(HeaderDescriptor... descriptors)
Snippet
that will document the headers of the API operation's
response. The headers will be documented using the given descriptors
.
If a header is documented, is not marked as optional, and is not present in the request, a failure will occur.
descriptors
- the descriptions of the response's headersheaderWithName(String)
public static ResponseHeadersSnippet responseHeaders(List<HeaderDescriptor> descriptors)
Snippet
that will document the headers of the API operation's
response. The headers will be documented using the given descriptors
.
If a header is documented, is not marked as optional, and is not present in the request, a failure will occur.
descriptors
- the descriptions of the response's headersheaderWithName(String)
public static ResponseHeadersSnippet responseHeaders(Map<String,Object> attributes, HeaderDescriptor... descriptors)
Snippet
that will document the headers of the API
operations's response. The given attributes
will be available during
snippet generation and the headers will be documented using the given
descriptors
.
If a header is documented, is not marked as optional, and is not present in the response, a failure will occur.
attributes
- the attributesdescriptors
- the descriptions of the response's headersheaderWithName(String)
public static ResponseHeadersSnippet responseHeaders(Map<String,Object> attributes, List<HeaderDescriptor> descriptors)
Snippet
that will document the headers of the API
operations's response. The given attributes
will be available during
snippet generation and the headers will be documented using the given
descriptors
.
If a header is documented, is not marked as optional, and is not present in the response, a failure will occur.
attributes
- the attributesdescriptors
- the descriptions of the response's headersheaderWithName(String)