Top Description Inners Methods
org.eclipse.microprofile.openapi.models

public Interface PathItem

extends Constructible, Extensible<PathItem>, Reference<PathItem>
Imports
java.util.List, .Map, org.eclipse.microprofile.openapi.models.parameters.Parameter, org.eclipse.microprofile.openapi.models.servers.Server
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
OpenAPI Specification Path Item Object

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
PathItem.HttpMethod

All of the possible types of HTTP operations for this path

Method Summary

Modifier and TypeMethod and Description
public PathItem

Returns:

the current PathItem instance
addParameter(Parameter
a parameter that is applicable to all the operations described under this path
parameter)

Adds the given parameter to this PathItem's list of parameters.

public PathItem

Returns:

the current PathItem instance
addServer(Server
a server to service operations in this path item
server)

Adds the given server to this PathItem's list of servers.

public default PathItem

Returns:

the current PathItem instance
DELETE(Operation
definition of a DELETE operation
delete)

Sets this PathItem's delete property to the given operation.

public default PathItem

Returns:

the current PathItem instance
description(String
detailed description of what the path item represents
description)

Sets this PathItem's description property to the given string.

public default PathItem

Returns:

the current PathItem instance
GET(Operation
definition of a GET operation
get)

Sets this PathItem's get property to the given operation.

public Operation

Returns:

definition of a DELETE operation on this path
getDELETE()

Returns the delete property from a PathItem instance.

public String

Returns:

a detailed description of what the path item represents
getDescription()

Returns the description property from a PathItem instance.

public Operation

Returns:

definition of a GET operation on this path
getGET()

Returns the get property from a PathItem instance.

public Operation

Returns:

definition of a HEAD operation on this path
getHEAD()

Returns the head property from a PathItem instance.

public Map<PathItem.HttpMethod, Operation>

Returns:

a map with all the operations for this path where the keys are HttpMethods
getOperations()

Returns a map with all the operations for this path where the keys are PathItem.HttpMethod items

public Operation

Returns:

definition of an OPTIONS operation on this path
getOPTIONS()

Returns the options property from a PathItem instance.

public List<Parameter>

Returns:

a copy List (potentially immutable) of parameters that are applicable to all the operations described under this path
getParameters()

Returns the parameters property from this PathItem instance.

public Operation

Returns:

definition of a PATCH operation on this path
getPATCH()

Returns the patch property from a PathItem instance.

public Operation

Returns:

definition of a POST operation on this path
getPOST()

Returns the post property from a PathItem instance.

public Operation

Returns:

definition of a PUT operation on this path
getPUT()

Returns the put property from a PathItem instance.

public List<Server>

Returns:

a copy List (potentially immutable) of all the servers defined in this path item
getServers()

Returns the servers property from a PathItem instance.

public String

Returns:

a short summary of what the path item represents
getSummary()

Returns the summary property from a PathItem instance.

public Operation

Returns:

definition of a TRACE operation on this path
getTRACE()

Returns the trace property from a PathItem instance.

public default PathItem

Returns:

the current PathItem instance
HEAD(Operation
definition of a HEAD operation
head)

Sets this PathItem's head property to the given operation.

public default PathItem

Returns:

the current PathItem instance
OPTIONS(Operation
definition of an OPTIONS operation
options)

Sets this PathItem's options property to the given operation.

public default PathItem

Returns:

the current PathItem instance
parameters(List<Parameter>
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.

public default PathItem

Returns:

the current PathItem instance
PATCH(Operation
definition of a PATCH operation
patch)

Sets this PathItem's patch property to the given operation.

public default PathItem

Returns:

the current PathItem instance
POST(Operation
definition of a PUT operation
post)

Sets this PathItem's post property to the given operation.

public default PathItem

Returns:

the current PathItem instance
PUT(Operation
definition of a PUT operation
put)

Sets this PathItem's put property to the given operation.

public void
removeParameter(Parameter
a parameter that is applicable to all the operations described under this path
parameter)

Removes the given parameter to this PathItem's list of parameters.

public void
removeServer(Server
a server to service operations in this path item
server)

Removes the given server to this PathItem's list of servers.

public default PathItem

Returns:

the current PathItem instance
servers(List<Server>
a list of the servers to service operations in this path item
servers)

Sets this PathItem's servers property to the given list.

public void
setDELETE(Operation
definition of a DELETE operation
delete)

Sets this PathItem's delete property to the given operation.

public void
setDescription(String
detailed description of what the path item represents
description)

Sets this PathItem's description property to the given string.

public void
setGET(Operation
definition of a GET operation
get)

Sets this PathItem's get property to the given operation.

public void
setHEAD(Operation
definition of a HEAD operation
head)

Sets this PathItem's head property to the given operation.

public void
setOperation(PathItem.HttpMethod
the http method
httpMethod, Operation
the definition of an operation for the given http method.
operation)

Sets an operation for a given http method.

public void
setOPTIONS(Operation
definition of an OPTIONS operation
options)

Sets this PathItem's options property to the given operation.

public void
setParameters(List<Parameter>
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.

public void
setPATCH(Operation
definition of a PATCH operation
patch)

Sets this PathItem's patch property to the given operation.

public void
setPOST(Operation
definition of a PUT operation
post)

Sets this PathItem's post property to the given operation.

public void
setPUT(Operation
definition of a PUT operation
put)

Sets this PathItem's put property to the given operation.

public void
setServers(List<Server>
a list of the servers to service operations in this path item
servers)

Sets this PathItem's servers property to the given list.

public void
setSummary(String
short summary of what the path item represents
summary)

Sets this PathItem's summary property to the given string.

public void
setTRACE(Operation
definition of a TRACE operation
trace)

Sets this PathItem's trace property to the given operation.

public default PathItem

Returns:

the current PathItem instance
summary(String
short summary of what the path item represents
summary)

Sets this PathItem's summary property to the given string.

public default PathItem

Returns:

the current PathItem instance
TRACE(Operation
definition of a TRACE operation
trace)

Sets this PathItem's trace property to the given operation.

Inherited from org.eclipse.microprofile.openapi.models.Extensible:
addExtensionextensionsgetExtensionsremoveExtensionsetExtensions
Inherited from org.eclipse.microprofile.openapi.models.Reference:
getRefrefsetRef

Method Detail

addParameterback to summary
public PathItem addParameter(Parameter parameter)

Adds the given parameter to this PathItem's list of parameters.

Parameters
parameter:Parameter

a parameter that is applicable to all the operations described under this path

Returns:PathItem

the current PathItem instance

addServerback to summary
public PathItem addServer(Server server)

Adds the given server to this PathItem's list of servers.

Parameters
server:Server

a server to service operations in this path item

Returns:PathItem

the current PathItem instance

DELETEback to summary
public default PathItem DELETE(Operation delete)

Sets this PathItem's delete property to the given operation.

Parameters
delete:Operation

definition of a DELETE operation

Returns:PathItem

the current PathItem instance

Annotations
@SuppressWarnings:checkstyle:methodname
descriptionback to summary
public default PathItem description(String description)

Sets this PathItem's description property to the given string.

Parameters
description:String

detailed description of what the path item represents

Returns:PathItem

the current PathItem instance

GETback to summary
public default PathItem GET(Operation get)

Sets this PathItem's get property to the given operation.

Parameters
get:Operation

definition of a GET operation

Returns:PathItem

the current PathItem instance

Annotations
@SuppressWarnings:checkstyle:methodname
getDELETEback to summary
public Operation getDELETE()

Returns the delete property from a PathItem instance.

Returns:Operation

definition of a DELETE operation on this path

getDescriptionback to summary
public String getDescription()

Returns the description property from a PathItem instance.

Returns:String

a detailed description of what the path item represents

getGETback to summary
public Operation getGET()

Returns the get property from a PathItem instance.

Returns:Operation

definition of a GET operation on this path

getHEADback to summary
public Operation getHEAD()

Returns the head property from a PathItem instance.

Returns:Operation

definition of a HEAD operation on this path

getOperationsback to summary
public Map<PathItem.HttpMethod, Operation> getOperations()

Returns a map with all the operations for this path where the keys are PathItem.HttpMethod items

Returns:Map<PathItem.HttpMethod, Operation>

a map with all the operations for this path where the keys are HttpMethods

getOPTIONSback to summary
public Operation getOPTIONS()

Returns the options property from a PathItem instance.

Returns:Operation

definition of an OPTIONS operation on this path

getParametersback to summary
public List<Parameter> getParameters()

Returns the parameters property from this PathItem instance.

Returns:List<Parameter>

a copy List (potentially immutable) of parameters that are applicable to all the operations described under this path

getPATCHback to summary
public Operation getPATCH()

Returns the patch property from a PathItem instance.

Returns:Operation

definition of a PATCH operation on this path

getPOSTback to summary
public Operation getPOST()

Returns the post property from a PathItem instance.

Returns:Operation

definition of a POST operation on this path

getPUTback to summary
public Operation getPUT()

Returns the put property from a PathItem instance.

Returns:Operation

definition of a PUT operation on this path

getServersback to summary
public List<Server> getServers()

Returns the servers property from a PathItem instance.

Returns:List<Server>

a copy List (potentially immutable) of all the servers defined in this path item

getSummaryback to summary
public String getSummary()

Returns the summary property from a PathItem instance.

Returns:String

a short summary of what the path item represents

getTRACEback to summary
public Operation getTRACE()

Returns the trace property from a PathItem instance.

Returns:Operation

definition of a TRACE operation on this path

HEADback to summary
public default PathItem HEAD(Operation head)

Sets this PathItem's head property to the given operation.

Parameters
head:Operation

definition of a HEAD operation

Returns:PathItem

the current PathItem instance

Annotations
@SuppressWarnings:checkstyle:methodname
OPTIONSback to summary
public default PathItem OPTIONS(Operation options)

Sets this PathItem's options property to the given operation.

Parameters
options:Operation

definition of an OPTIONS operation

Returns:PathItem

the current PathItem instance

Annotations
@SuppressWarnings:checkstyle:methodname
parametersback to summary
public default PathItem parameters(List<Parameter> parameters)

Sets this PathItem's parameters property to the given list.

Parameters
parameters:List<Parameter>

a list of parameters that are applicable to all the operations described under this path

Returns:PathItem

the current PathItem instance

PATCHback to summary
public default PathItem PATCH(Operation patch)

Sets this PathItem's patch property to the given operation.

Parameters
patch:Operation

definition of a PATCH operation

Returns:PathItem

the current PathItem instance

Annotations
@SuppressWarnings:checkstyle:methodname
POSTback to summary
public default PathItem POST(Operation post)

Sets this PathItem's post property to the given operation.

Parameters
post:Operation

definition of a PUT operation

Returns:PathItem

the current PathItem instance

Annotations
@SuppressWarnings:checkstyle:methodname
PUTback to summary
public default PathItem PUT(Operation put)

Sets this PathItem's put property to the given operation.

Parameters
put:Operation

definition of a PUT operation

Returns:PathItem

the current PathItem instance

Annotations
@SuppressWarnings:checkstyle:methodname
removeParameterback to summary
public void removeParameter(Parameter parameter)

Removes the given parameter to this PathItem's list of parameters.

Parameters
parameter:Parameter

a parameter that is applicable to all the operations described under this path

removeServerback to summary
public void removeServer(Server server)

Removes the given server to this PathItem's list of servers.

Parameters
server:Server

a server to service operations in this path item

serversback to summary
public default PathItem servers(List<Server> servers)

Sets this PathItem's servers property to the given list.

Parameters
servers:List<Server>

a list of the servers to service operations in this path item

Returns:PathItem

the current PathItem instance

setDELETEback to summary
public void setDELETE(Operation delete)

Sets this PathItem's delete property to the given operation.

Parameters
delete:Operation

definition of a DELETE operation

setDescriptionback to summary
public void setDescription(String description)

Sets this PathItem's description property to the given string.

Parameters
description:String

detailed description of what the path item represents

setGETback to summary
public void setGET(Operation get)

Sets this PathItem's get property to the given operation.

Parameters
get:Operation

definition of a GET operation

setHEADback to summary
public void setHEAD(Operation head)

Sets this PathItem's head property to the given operation.

Parameters
head:Operation

definition of a HEAD operation

setOperationback to summary
public void setOperation(PathItem.HttpMethod httpMethod, Operation operation)

Sets an operation for a given http method.

Parameters
httpMethod:PathItem.HttpMethod

the http method

operation:Operation

the definition of an operation for the given http method.

setOPTIONSback to summary
public void setOPTIONS(Operation options)

Sets this PathItem's options property to the given operation.

Parameters
options:Operation

definition of an OPTIONS operation

setParametersback to summary
public void setParameters(List<Parameter> parameters)

Sets this PathItem's parameters property to the given list.

Parameters
parameters:List<Parameter>

a list of parameters that are applicable to all the operations described under this path

setPATCHback to summary
public void setPATCH(Operation patch)

Sets this PathItem's patch property to the given operation.

Parameters
patch:Operation

definition of a PATCH operation

setPOSTback to summary
public void setPOST(Operation post)

Sets this PathItem's post property to the given operation.

Parameters
post:Operation

definition of a PUT operation

setPUTback to summary
public void setPUT(Operation put)

Sets this PathItem's put property to the given operation.

Parameters
put:Operation

definition of a PUT operation

setServersback to summary
public void setServers(List<Server> servers)

Sets this PathItem's servers property to the given list.

Parameters
servers:List<Server>

a list of the servers to service operations in this path item

setSummaryback to summary
public void setSummary(String summary)

Sets this PathItem's summary property to the given string.

Parameters
summary:String

short summary of what the path item represents

setTRACEback to summary
public void setTRACE(Operation trace)

Sets this PathItem's trace property to the given operation.

Parameters
trace:Operation

definition of a TRACE operation

summaryback to summary
public default PathItem summary(String summary)

Sets this PathItem's summary property to the given string.

Parameters
summary:String

short summary of what the path item represents

Returns:PathItem

the current PathItem instance

TRACEback to summary
public default PathItem TRACE(Operation trace)

Sets this PathItem's trace property to the given operation.

Parameters
trace:Operation

definition of a TRACE operation

Returns:PathItem

the current PathItem instance

Annotations
@SuppressWarnings:checkstyle:methodname
org.eclipse.microprofile.openapi.models back to summary

public final Enum PathItem.HttpMethod

extends Enum<PathItem.HttpMethod>
Class Inheritance
All of the possible types of HTTP operations for this path

Field Summary

Modifier and TypeField and Description
public static final PathItem.HttpMethod
DELETE

public static final PathItem.HttpMethod
GET

public static final PathItem.HttpMethod
HEAD

public static final PathItem.HttpMethod
OPTIONS

public static final PathItem.HttpMethod
PATCH

public static final PathItem.HttpMethod
POST

public static final PathItem.HttpMethod
PUT

public static final PathItem.HttpMethod
TRACE

Constructor Summary

AccessConstructor and Description
private
HttpMethod()

Method Summary

Modifier and TypeMethod and Description
public static PathItem.HttpMethod
valueOf(String name)

public static PathItem.HttpMethod[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

DELETEback to summary
public static final PathItem.HttpMethod DELETE
GETback to summary
public static final PathItem.HttpMethod GET
HEADback to summary
public static final PathItem.HttpMethod HEAD
OPTIONSback to summary
public static final PathItem.HttpMethod OPTIONS
PATCHback to summary
public static final PathItem.HttpMethod PATCH
POSTback to summary
public static final PathItem.HttpMethod POST
PUTback to summary
public static final PathItem.HttpMethod PUT
TRACEback to summary
public static final PathItem.HttpMethod TRACE

Constructor Detail

HttpMethodback to summary
private HttpMethod()

Method Detail

valueOfback to summary
public static PathItem.HttpMethod valueOf(String name)
valuesback to summary
public static PathItem.HttpMethod[] values()