Interface Operation
- All Superinterfaces:
Constructible
,Extensible<Operation>
Operation
Describes a single API operation on a path.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionaddCallback
(String key, Callback callback) Adds the given callback item to this Operation's map of callbacks.addParameter
(Parameter parameter) Adds the given parameter item to this Operation's list of parameters.addSecurityRequirement
(SecurityRequirement securityRequirement) Adds the given security requirement item to this Operation's list of security mechanisms.Adds the given server to this Operation's list of servers.Adds the given tag to this Operation's list of tags.default Operation
Sets this Operation's callbacks property to the given map.default Operation
deprecated
(Boolean deprecated) Sets this Operation's deprecated property to the given value.default Operation
description
(String description) Sets this Operation's description property to the given string.default Operation
externalDocs
(ExternalDocumentation externalDocs) Sets this Operation's externalDocs property to the given object.Returns the callbacks property from an Operation instance.Returns the deprecated property from an Operation instance.Returns the description property from an Operation instance.Returns the externalDocs property from an Operation instance.Returns the operationId property from an Operation instance.Returns the parameters property from an Operation instance.Returns the requestBody property from an Operation instance.Returns the responses property from an Operation instance.Returns the security property from an Operation instance.Returns the servers property from an Operation instance.Returns the summary property from an Operation instance.getTags()
Returns the tags property from an Operation instance.default Operation
operationId
(String operationId) Sets this Operation's operationId property to the given string.default Operation
parameters
(List<Parameter> parameters) Sets this Operation's parameters property to the given parameter list.void
removeCallback
(String key) Removes the given callback item to this Operation's map of callbacks.void
removeParameter
(Parameter parameter) Removes the given parameter item to this Operation's list of parameters.void
removeSecurityRequirement
(SecurityRequirement securityRequirement) Removes the given security requirement item to this Operation's list of security mechanisms.void
removeServer
(Server server) Removes the given server to this Operation's list of servers.void
Removes the given tag to this Operation's list of tags.default Operation
requestBody
(RequestBody requestBody) Sets this Operation's requestBody property to the given object.default Operation
responses
(APIResponses responses) Sets this Operation's responses property to the given responses.default Operation
security
(List<SecurityRequirement> security) Sets this Operation's security property to the given list.default Operation
Sets this Operation's servers property to the given list.void
setCallbacks
(Map<String, Callback> callbacks) Sets this Operation's callbacks property to the given map.void
setDeprecated
(Boolean deprecated) Sets this Operation's deprecated property to the given value.void
setDescription
(String description) Sets this Operation's description property to the given string.void
setExternalDocs
(ExternalDocumentation externalDocs) Sets this Operation's externalDocs property to the given object.void
setOperationId
(String operationId) Sets this Operation's operationId property to the given string.void
setParameters
(List<Parameter> parameters) Sets this Operation's parameters property to the given parameter list.void
setRequestBody
(RequestBody requestBody) Sets this Operation's requestBody property to the given object.void
setResponses
(APIResponses responses) Sets this Operation's responses property to the given responses.void
setSecurity
(List<SecurityRequirement> security) Sets this Operation's security property to the given list.void
setServers
(List<Server> servers) Sets this Operation's servers property to the given list.void
setSummary
(String summary) Sets this Operation's summary property to the given string.void
Sets this Operation's tags property to the given tags.default Operation
Sets this Operation's summary property to the given string.default Operation
Sets this Operation's tags property to the given tags.Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible
addExtension, extensions, getExtensions, removeExtension, setExtensions
-
Method Details
-
getTags
Returns the tags property from an Operation instance.- Returns:
- a list of the operation's tags
-
setTags
Sets this Operation's tags property to the given tags.- Parameters:
tags
- a list of tags for API documentation control
-
tags
Sets this Operation's tags property to the given tags.- Parameters:
tags
- a list of tags for API documentation control- Returns:
- the current Operation object
-
addTag
Adds the given tag to this Operation's list of tags.- Parameters:
tag
- a tag for API documentation control- Returns:
- the current Operation object
-
removeTag
Removes the given tag to this Operation's list of tags.- Parameters:
tag
- a tag for API documentation control
-
getSummary
String getSummary()Returns the summary property from an Operation instance.- Returns:
- a short summary of what the operation does
-
setSummary
Sets this Operation's summary property to the given string.- Parameters:
summary
- a short summary of what the operation does
-
summary
Sets this Operation's summary property to the given string.- Parameters:
summary
- a short summary of what the operation does- Returns:
- the current Operation object
-
getDescription
String getDescription()Returns the description property from an Operation instance.- Returns:
- a verbose explanation of the operation behavior
-
setDescription
Sets this Operation's description property to the given string.- Parameters:
description
- a verbose explanation of the operation behavior
-
description
Sets this Operation's description property to the given string.- Parameters:
description
- a verbose explanation of the operation behavior- Returns:
- the current Operation object
-
getExternalDocs
ExternalDocumentation getExternalDocs()Returns the externalDocs property from an Operation instance.- Returns:
- additional external documentation for this operation
-
setExternalDocs
Sets this Operation's externalDocs property to the given object.- Parameters:
externalDocs
- additional external documentation for this operation
-
externalDocs
Sets this Operation's externalDocs property to the given object.- Parameters:
externalDocs
- additional external documentation for this operation- Returns:
- the current Operation object
-
getOperationId
String getOperationId()Returns the operationId property from an Operation instance.- Returns:
- unique string used to identify the operation
-
setOperationId
Sets this Operation's operationId property to the given string.- Parameters:
operationId
- unique string used to identify the operation
-
operationId
Sets this Operation's operationId property to the given string.- Parameters:
operationId
- unique string used to identify the operation- Returns:
- the current Operation object
-
getParameters
Returns the parameters property from an Operation instance.- Returns:
- a list of parameters that are applicable for this operation
-
setParameters
Sets this Operation's parameters property to the given parameter list.- Parameters:
parameters
- a list of parameters that are applicable for this operation
-
parameters
Sets this Operation's parameters property to the given parameter list.- Parameters:
parameters
- a list of parameters that are applicable for this operation- Returns:
- the current Operation object
-
addParameter
Adds the given parameter item to this Operation's list of parameters.- Parameters:
parameter
- a parameter that is applicable for this operation- Returns:
- the current Operation object
-
removeParameter
Removes the given parameter item to this Operation's list of parameters.- Parameters:
parameter
- a parameter that is applicable for this operation
-
getRequestBody
RequestBody getRequestBody()Returns the requestBody property from an Operation instance.- Returns:
- the request body applicable for this operation
-
setRequestBody
Sets this Operation's requestBody property to the given object.- Parameters:
requestBody
- the request body applicable for this operation
-
requestBody
Sets this Operation's requestBody property to the given object.- Parameters:
requestBody
- the request body applicable for this operation- Returns:
- the current Operation object
-
getResponses
APIResponses getResponses()Returns the responses property from an Operation instance.- Returns:
- collection of possible responses from executing this operation
-
setResponses
Sets this Operation's responses property to the given responses.- Parameters:
responses
- collection of possible responses from executing this operation
-
responses
Sets this Operation's responses property to the given responses.- Parameters:
responses
- collection of possible responses from executing this operation- Returns:
- the current Operation object
-
getCallbacks
Returns the callbacks property from an Operation instance.- Returns:
- map of possible out-of-band callbacks related to the operation
-
setCallbacks
Sets this Operation's callbacks property to the given map.- Parameters:
callbacks
- map of possible out-of-band callbacks related to the operation. The key value must be the correct format for this field.
-
callbacks
Sets this Operation's callbacks property to the given map.- Parameters:
callbacks
- map of possible out-of-band callbacks related to the operation. The key value must be the correct format for this field.- Returns:
- the current Operation object
-
addCallback
Adds the given callback item to this Operation's map of callbacks.- Parameters:
key
- a key conforming to the format required for this objectcallback
- a callback that is applicable for this operation. null values will be rejected (implementation will throw an exception) or ignored.- Returns:
- the current Operation object
-
removeCallback
Removes the given callback item to this Operation's map of callbacks.- Parameters:
key
- a key conforming to the format required for this object
-
getDeprecated
Boolean getDeprecated()Returns the deprecated property from an Operation instance.- Returns:
- declaration whether this operation is deprecated
-
setDeprecated
Sets this Operation's deprecated property to the given value.- Parameters:
deprecated
- declaration whether this operation is deprecated
-
deprecated
Sets this Operation's deprecated property to the given value.- Parameters:
deprecated
- declaration whether this operation is deprecated- Returns:
- the current Operation object
-
getSecurity
List<SecurityRequirement> getSecurity()Returns the security property from an Operation instance.- Returns:
- a list of which security mechanisms can be used for this operation
-
setSecurity
Sets this Operation's security property to the given list.- Parameters:
security
- list of which security mechanisms can be used for this operation
-
security
Sets this Operation's security property to the given list.- Parameters:
security
- list of which security mechanisms can be used for this operation- Returns:
- the current Operation object
-
addSecurityRequirement
Adds the given security requirement item to this Operation's list of security mechanisms.- Parameters:
securityRequirement
- security mechanism which can be used for this operation- Returns:
- the current Operation object
-
removeSecurityRequirement
Removes the given security requirement item to this Operation's list of security mechanisms.- Parameters:
securityRequirement
- security mechanism which can be used for this operation
-
getServers
Returns the servers property from an Operation instance.- Returns:
- a list of servers to service this operation
-
setServers
Sets this Operation's servers property to the given list.- Parameters:
servers
- list of servers to service this operation
-
servers
Sets this Operation's servers property to the given list.- Parameters:
servers
- list of servers to service this operation- Returns:
- the current Operation object
-
addServer
Adds the given server to this Operation's list of servers.- Parameters:
server
- server which can service this operation- Returns:
- the current Operation object
-
removeServer
Removes the given server to this Operation's list of servers.- Parameters:
server
- server which can service this operation
-