Interface PathItem
-
- All Superinterfaces:
Constructible
,Extensible<PathItem>
,Reference<PathItem>
public interface PathItem extends Constructible, Extensible<PathItem>, Reference<PathItem>
PathItemDescribes 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:
- OpenAPI Specification Path Item Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
PathItem.HttpMethod
All of the possible types of HTTP operations for this path
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description PathItem
addParameter(Parameter parameter)
Adds the given parameter to this PathItem's list of parameters.PathItem
addServer(Server server)
Adds the given server to this PathItem's list of servers.default PathItem
DELETE(Operation delete)
Sets this PathItem's delete property to the given operation.default PathItem
description(java.lang.String description)
Sets this PathItem's description property to the given string.default PathItem
GET(Operation get)
Sets this PathItem's get property to the given operation.Operation
getDELETE()
Returns the delete property from a PathItem instance.java.lang.String
getDescription()
Returns the description property from a PathItem instance.Operation
getGET()
Returns the get property from a PathItem instance.Operation
getHEAD()
Returns the head property from a PathItem instance.java.util.Map<PathItem.HttpMethod,Operation>
getOperations()
Returns a map with all the operations for this path where the keys arePathItem.HttpMethod
itemsOperation
getOPTIONS()
Returns the options property from a PathItem instance.java.util.List<Parameter>
getParameters()
Returns the parameters property from this PathItem instance.Operation
getPATCH()
Returns the patch property from a PathItem instance.Operation
getPOST()
Returns the post property from a PathItem instance.Operation
getPUT()
Returns the put property from a PathItem instance.java.util.List<Server>
getServers()
Returns the servers property from a PathItem instance.java.lang.String
getSummary()
Returns the summary property from a PathItem instance.Operation
getTRACE()
Returns the trace property from a PathItem instance.default PathItem
HEAD(Operation head)
Sets this PathItem's head property to the given operation.default PathItem
OPTIONS(Operation options)
Sets this PathItem's options property to the given operation.default PathItem
parameters(java.util.List<Parameter> parameters)
Sets this PathItem's parameters property to the given list.default PathItem
PATCH(Operation patch)
Sets this PathItem's patch property to the given operation.default PathItem
POST(Operation post)
Sets this PathItem's post property to the given operation.default PathItem
PUT(Operation put)
Sets this PathItem's put property to the given operation.default java.util.List<Operation>
readOperations()
Deprecated.since 1.1, use @linkMap.values()
ongetOperations()
insteaddefault java.util.Map<PathItem.HttpMethod,Operation>
readOperationsMap()
Deprecated.since 1.1, usegetOperations()
insteadvoid
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
servers(java.util.List<Server> servers)
Sets this PathItem's servers property to the given list.void
setDELETE(Operation delete)
Sets this PathItem's delete property to the given operation.void
setDescription(java.lang.String description)
Sets this PathItem's description property to the given string.void
setGET(Operation get)
Sets this PathItem's get property to the given operation.void
setHEAD(Operation head)
Sets this PathItem's head property to the given operation.void
setOPTIONS(Operation options)
Sets this PathItem's options property to the given operation.void
setParameters(java.util.List<Parameter> parameters)
Sets this PathItem's parameters property to the given list.void
setPATCH(Operation patch)
Sets this PathItem's patch property to the given operation.void
setPOST(Operation post)
Sets this PathItem's post property to the given operation.void
setPUT(Operation put)
Sets this PathItem's put property to the given operation.void
setServers(java.util.List<Server> servers)
Sets this PathItem's servers property to the given list.void
setSummary(java.lang.String summary)
Sets this PathItem's summary property to the given string.void
setTRACE(Operation trace)
Sets this PathItem's trace property to the given operation.default PathItem
summary(java.lang.String summary)
Sets this PathItem's summary property to the given string.default PathItem
TRACE(Operation trace)
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 Detail
-
getSummary
java.lang.String getSummary()
Returns the summary property from a PathItem instance.- Returns:
- a short summary of what the path item represents
-
setSummary
void setSummary(java.lang.String summary)
Sets this PathItem's summary property to the given string.- Parameters:
summary
- short summary of what the path item represents
-
summary
default PathItem summary(java.lang.String 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
java.lang.String getDescription()
Returns the description property from a PathItem instance.- Returns:
- a detailed description of what the path item represents
-
setDescription
void setDescription(java.lang.String description)
Sets this PathItem's description property to the given string.- Parameters:
description
- detailed description of what the path item represents
-
description
default PathItem description(java.lang.String 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
void setGET(Operation get)
Sets this PathItem's get property to the given operation.- Parameters:
get
- definition of a GET operation
-
GET
default PathItem 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
void setPUT(Operation put)
Sets this PathItem's put property to the given operation.- Parameters:
put
- definition of a PUT operation
-
PUT
default PathItem 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
void setPOST(Operation post)
Sets this PathItem's post property to the given operation.- Parameters:
post
- definition of a PUT operation
-
POST
default PathItem POST(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
void setDELETE(Operation delete)
Sets this PathItem's delete property to the given operation.- Parameters:
delete
- definition of a DELETE operation
-
DELETE
default PathItem 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
void setOPTIONS(Operation options)
Sets this PathItem's options property to the given operation.- Parameters:
options
- definition of an OPTIONS operation
-
OPTIONS
default PathItem 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
void setHEAD(Operation head)
Sets this PathItem's head property to the given operation.- Parameters:
head
- definition of a HEAD operation
-
HEAD
default PathItem 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
void setPATCH(Operation patch)
Sets this PathItem's patch property to the given operation.- Parameters:
patch
- definition of a PATCH operation
-
PATCH
default PathItem 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
void setTRACE(Operation trace)
Sets this PathItem's trace property to the given operation.- Parameters:
trace
- definition of a TRACE operation
-
TRACE
default PathItem 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
-
readOperations
@Deprecated default java.util.List<Operation> readOperations()
Deprecated.since 1.1, use @linkMap.values()
ongetOperations()
insteadReturns a list of all the operations for this path item.- Returns:
- a list of all the operations for this path item
-
readOperationsMap
@Deprecated default java.util.Map<PathItem.HttpMethod,Operation> readOperationsMap()
Deprecated.since 1.1, usegetOperations()
insteadReturns a map with all the operations for this path where the keys are HttpMethods.- Returns:
- a map with all the operations for this path where the keys are HttpMethods
-
getOperations
java.util.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
-
getServers
java.util.List<Server> getServers()
Returns the servers property from a PathItem instance.- Returns:
- a list of all the servers defined in this path item
-
setServers
void setServers(java.util.List<Server> 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
-
servers
default PathItem servers(java.util.List<Server> 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
PathItem addServer(Server server)
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
void removeServer(Server server)
Removes the given server to this PathItem's list of servers.- Parameters:
server
- a server to service operations in this path item
-
getParameters
java.util.List<Parameter> getParameters()
Returns the parameters property from this PathItem instance.- Returns:
- a list of parameters that are applicable to all the operations described under this path
-
setParameters
void setParameters(java.util.List<Parameter> 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
-
parameters
default PathItem parameters(java.util.List<Parameter> 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
PathItem addParameter(Parameter parameter)
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
void removeParameter(Parameter parameter)
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
-
-