Interface PathItem
- All Superinterfaces:
Constructible
,Extensible<PathItem>
,Reference<PathItem>
PathItem
Describes the operations available on a single path. A Path Item MAY be empty, due to security constraints. In that case the path itself is still exposed to the documentation viewer but you will not know which operations and parameters are available.
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic enum
All of the possible types of HTTP operations for this path -
Method Summary
Modifier and TypeMethodDescriptionaddParameter
(Parameter parameter) Adds the given parameter to this PathItem's list of parameters.Adds the given server to this PathItem's list of servers.default PathItem
Sets this PathItem's delete property to the given operation.default PathItem
description
(String description) Sets this PathItem's description property to the given string.default PathItem
Sets this PathItem's get property to the given operation.Returns the delete property from a PathItem instance.Returns the description property from a PathItem instance.getGET()
Returns the get property from a PathItem instance.getHEAD()
Returns the head property from a PathItem instance.Returns a map with all the operations for this path where the keys arePathItem.HttpMethod
itemsReturns the options property from a PathItem instance.Returns the parameters property from this PathItem instance.getPATCH()
Returns the patch property from a PathItem instance.getPOST()
Returns the post property from a PathItem instance.getPUT()
Returns the put property from a PathItem instance.Returns the servers property from a PathItem instance.Returns the summary property from a PathItem instance.getTRACE()
Returns the trace property from a PathItem instance.default PathItem
Sets this PathItem's head property to the given operation.default PathItem
Sets this PathItem's options property to the given operation.default PathItem
parameters
(List<Parameter> parameters) Sets this PathItem's parameters property to the given list.default PathItem
Sets this PathItem's patch property to the given operation.default PathItem
Sets this PathItem's post property to the given operation.default PathItem
Sets this PathItem's put property to the given operation.void
removeParameter
(Parameter parameter) Removes the given parameter to this PathItem's list of parameters.void
removeServer
(Server server) Removes the given server to this PathItem's list of servers.default PathItem
Sets this PathItem's servers property to the given list.void
Sets this PathItem's delete property to the given operation.void
setDescription
(String description) Sets this PathItem's description property to the given string.void
Sets this PathItem's get property to the given operation.void
Sets this PathItem's head property to the given operation.void
setOperation
(PathItem.HttpMethod httpMethod, Operation operation) Sets an operation for a given http method.void
setOPTIONS
(Operation options) Sets this PathItem's options property to the given operation.void
setParameters
(List<Parameter> parameters) Sets this PathItem's parameters property to the given list.void
Sets this PathItem's patch property to the given operation.void
Sets this PathItem's post property to the given operation.void
Sets this PathItem's put property to the given operation.void
setServers
(List<Server> servers) Sets this PathItem's servers property to the given list.void
setSummary
(String summary) Sets this PathItem's summary property to the given string.void
Sets this PathItem's trace property to the given operation.default PathItem
Sets this PathItem's summary property to the given string.default PathItem
Sets this PathItem's trace property to the given operation.Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible
addExtension, extensions, getExtensions, removeExtension, setExtensions
-
Method Details
-
getSummary
String getSummary()Returns the summary property from a PathItem instance.- Returns:
- a short summary of what the path item represents
-
setSummary
Sets this PathItem's summary property to the given string.- Parameters:
summary
- short summary of what the path item represents
-
summary
Sets this PathItem's summary property to the given string.- Parameters:
summary
- short summary of what the path item represents- Returns:
- the current PathItem instance
-
getDescription
String getDescription()Returns the description property from a PathItem instance.- Returns:
- a detailed description of what the path item represents
-
setDescription
Sets this PathItem's description property to the given string.- Parameters:
description
- detailed description of what the path item represents
-
description
Sets this PathItem's description property to the given string.- Parameters:
description
- detailed description of what the path item represents- Returns:
- the current PathItem instance
-
getGET
Operation getGET()Returns the get property from a PathItem instance.- Returns:
- definition of a GET operation on this path
-
setGET
Sets this PathItem's get property to the given operation.- Parameters:
get
- definition of a GET operation
-
GET
Sets this PathItem's get property to the given operation.- Parameters:
get
- definition of a GET operation- Returns:
- the current PathItem instance
-
getPUT
Operation getPUT()Returns the put property from a PathItem instance.- Returns:
- definition of a PUT operation on this path
-
setPUT
Sets this PathItem's put property to the given operation.- Parameters:
put
- definition of a PUT operation
-
PUT
Sets this PathItem's put property to the given operation.- Parameters:
put
- definition of a PUT operation- Returns:
- the current PathItem instance
-
getPOST
Operation getPOST()Returns the post property from a PathItem instance.- Returns:
- definition of a POST operation on this path
-
setPOST
Sets this PathItem's post property to the given operation.- Parameters:
post
- definition of a PUT operation
-
POST
Sets this PathItem's post property to the given operation.- Parameters:
post
- definition of a PUT operation- Returns:
- the current PathItem instance
-
getDELETE
Operation getDELETE()Returns the delete property from a PathItem instance.- Returns:
- definition of a DELETE operation on this path
-
setDELETE
Sets this PathItem's delete property to the given operation.- Parameters:
delete
- definition of a DELETE operation
-
DELETE
Sets this PathItem's delete property to the given operation.- Parameters:
delete
- definition of a DELETE operation- Returns:
- the current PathItem instance
-
getOPTIONS
Operation getOPTIONS()Returns the options property from a PathItem instance.- Returns:
- definition of an OPTIONS operation on this path
-
setOPTIONS
Sets this PathItem's options property to the given operation.- Parameters:
options
- definition of an OPTIONS operation
-
OPTIONS
Sets this PathItem's options property to the given operation.- Parameters:
options
- definition of an OPTIONS operation- Returns:
- the current PathItem instance
-
getHEAD
Operation getHEAD()Returns the head property from a PathItem instance.- Returns:
- definition of a HEAD operation on this path
-
setHEAD
Sets this PathItem's head property to the given operation.- Parameters:
head
- definition of a HEAD operation
-
HEAD
Sets this PathItem's head property to the given operation.- Parameters:
head
- definition of a HEAD operation- Returns:
- the current PathItem instance
-
getPATCH
Operation getPATCH()Returns the patch property from a PathItem instance.- Returns:
- definition of a PATCH operation on this path
-
setPATCH
Sets this PathItem's patch property to the given operation.- Parameters:
patch
- definition of a PATCH operation
-
PATCH
Sets this PathItem's patch property to the given operation.- Parameters:
patch
- definition of a PATCH operation- Returns:
- the current PathItem instance
-
getTRACE
Operation getTRACE()Returns the trace property from a PathItem instance.- Returns:
- definition of a TRACE operation on this path
-
setTRACE
Sets this PathItem's trace property to the given operation.- Parameters:
trace
- definition of a TRACE operation
-
TRACE
Sets this PathItem's trace property to the given operation.- Parameters:
trace
- definition of a TRACE operation- Returns:
- the current PathItem instance
-
getOperations
Map<PathItem.HttpMethod,Operation> getOperations()Returns a map with all the operations for this path where the keys arePathItem.HttpMethod
items- Returns:
- a map with all the operations for this path where the keys are HttpMethods
-
setOperation
Sets an operation for a given http method.- Parameters:
httpMethod
- the http methodoperation
- the definition of an operation for the given http method.
-
getServers
Returns the servers property from a PathItem instance.- Returns:
- a copy List (potentially immutable) of all the servers defined in this path item
-
setServers
Sets this PathItem's servers property to the given list.- Parameters:
servers
- a list of the servers to service operations in this path item
-
servers
Sets this PathItem's servers property to the given list.- Parameters:
servers
- a list of the servers to service operations in this path item- Returns:
- the current PathItem instance
-
addServer
Adds the given server to this PathItem's list of servers.- Parameters:
server
- a server to service operations in this path item- Returns:
- the current PathItem instance
-
removeServer
Removes the given server to this PathItem's list of servers.- Parameters:
server
- a server to service operations in this path item
-
getParameters
Returns the parameters property from this PathItem instance.- Returns:
- a copy List (potentially immutable) of parameters that are applicable to all the operations described under this path
-
setParameters
Sets this PathItem's parameters property to the given list.- Parameters:
parameters
- a list of parameters that are applicable to all the operations described under this path
-
parameters
Sets this PathItem's parameters property to the given list.- Parameters:
parameters
- a list of parameters that are applicable to all the operations described under this path- Returns:
- the current PathItem instance
-
addParameter
Adds the given parameter to this PathItem's list of parameters.- Parameters:
parameter
- a parameter that is applicable to all the operations described under this path- Returns:
- the current PathItem instance
-
removeParameter
Removes the given parameter to this PathItem's list of parameters.- Parameters:
parameter
- a parameter that is applicable to all the operations described under this path
-