Interface APIResponse
- All Superinterfaces:
Constructible
,Extensible<APIResponse>
,Reference<APIResponse>
This interface represents a single response from an API Operation, including design-time, static links to operations
based on the response.
- See Also:
-
- "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#responseObject"
-
Method Summary
Modifier and TypeMethodDescriptionAdds the given Header to this ApiResponse instance's map of Headers with the given name and return this instance of ApiResponse.Adds a link to this instance of ApiResponse using the given name and Link, and returns this ApiResponse instance.default APIResponse
Sets the map containing descriptions of potential response payload for this instance of ApiResponse and returns this ApiResponse instance.default APIResponse
description
(String description) Sets the description of this instance of ApiResponse and returns this ApiResponse instance.Returns the map containing descriptions of potential response payload for this instance of ApiResponse.Returns a short description of this instance of ApiResponse.Returns the map of Headers in this instance of ApiResponse.getLinks()
Returns the operations links that can be followed from this instance of ApiResponse.default APIResponse
Sets the Headers for this instance of ApiResponse with the given map of Headers and returns this instance of ApiResponse.default APIResponse
Sets the operations links that can be followed from this instance of ApiResponse.void
removeHeader
(String name) Removes the given Header to this ApiResponse instance's map of Headers with the given name and return this instance of ApiResponse.void
removeLink
(String name) Removes a link to this instance of ApiResponse using the given name and Link.void
setContent
(Content content) Sets the map containing descriptions of potential response payload for this instance of ApiResponse.void
setDescription
(String description) Sets the description of this instance of ApiResponse.void
setHeaders
(Map<String, Header> headers) Sets the Headers for this instance of ApiResponse with the given map of Headers.void
Sets the operations links that can be followed from this instance of ApiResponse.Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible
addExtension, extensions, getExtensions, removeExtension, setExtensions
-
Method Details
-
getDescription
String getDescription()Returns a short description of this instance of ApiResponse.- Returns:
- a short description of the response
-
setDescription
Sets the description of this instance of ApiResponse.- Parameters:
description
- a short description of the response
-
description
Sets the description of this instance of ApiResponse and returns this ApiResponse instance.- Parameters:
description
- a short description of the response- Returns:
- this ApiResponse instance
-
getHeaders
Returns the map of Headers in this instance of ApiResponse.- Returns:
- a copy Map (potentially immutable) of the headers of this response
-
setHeaders
Sets the Headers for this instance of ApiResponse with the given map of Headers. The Header names are case insensitive and if a Header is defined with the name 'Content-Type', then it will be ignored.- Parameters:
headers
- the headers of the response
-
headers
Sets the Headers for this instance of ApiResponse with the given map of Headers and returns this instance of ApiResponse. The Header names are case insensitive and if a Header is defined with the name 'Content-Type', then it will be ignored.- Parameters:
headers
- the headers of the response- Returns:
- this ApiResponse instance
-
addHeader
Adds the given Header to this ApiResponse instance's map of Headers with the given name and return this instance of ApiResponse. If this ApiResponse instance does not have any headers, a new map is created and the given header is added.- Parameters:
name
- the unique name of the headerheader
- a header for the response. null values will be rejected (implementation will throw an exception) or ignored.- Returns:
- this ApiResponse instance
-
removeHeader
Removes the given Header to this ApiResponse instance's map of Headers with the given name and return this instance of ApiResponse. If this ApiResponse instance does not have any headers, a new map is created and the given header is added.- Parameters:
name
- the unique name of the header
-
getContent
Content getContent()Returns the map containing descriptions of potential response payload for this instance of ApiResponse.- Returns:
- the potential content of the response
-
setContent
Sets the map containing descriptions of potential response payload for this instance of ApiResponse.- Parameters:
content
- the potential content of the response
-
content
Sets the map containing descriptions of potential response payload for this instance of ApiResponse and returns this ApiResponse instance.- Parameters:
content
- the potential content of the response- Returns:
- this ApiResponse instance
-
getLinks
Returns the operations links that can be followed from this instance of ApiResponse.- Returns:
- a copy Map (potentially immutable) of links that can be followed from the response
-
setLinks
Sets the operations links that can be followed from this instance of ApiResponse.- Parameters:
links
- the operation links followed from the response
-
links
Sets the operations links that can be followed from this instance of ApiResponse.- Parameters:
links
- the operation links followed from the response- Returns:
- current APIResponse instance
-
addLink
Adds a link to this instance of ApiResponse using the given name and Link, and returns this ApiResponse instance.- Parameters:
name
- the short name of the linklink
- the operation link that can be followed from the response. null values will be rejected (implementation will throw an exception) or ignored.- Returns:
- this ApiResponse instance
-
removeLink
Removes a link to this instance of ApiResponse using the given name and Link.- Parameters:
name
- the short name of the link
-