Package io.swagger.v3.oas.models

Class PathItem

java.lang.Object

io.swagger.v3.oas.models.PathItem

public class PathItem
extends Object

PathItem

See Also:

"https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#path-item-object", "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#path-item-object"

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PathItem.HttpMethod

Constructor Summary

Constructors

Constructor	Description
PathItem()

Method Summary

Modifier and Type	Method	Description
PathItem	$ref(String $ref)
void	addExtension(String name, Object value)
void	addExtension31(String name, Object value)
PathItem	addParametersItem(Parameter parametersItem)
PathItem	addServersItem(Server serversItem)
PathItem	delete(Operation delete)
PathItem	description(String description)
boolean	equals(Object o)
PathItem	extensions(Map<String,Object> extensions)
PathItem	get(Operation get)
String	get$ref()	returns the ref property from a PathItem instance.
Operation	getDelete()	returns the delete property from a PathItem instance.
String	getDescription()	returns the description property from a PathItem instance.
Map<String,Object>	getExtensions()
Operation	getGet()	returns the get property from a PathItem instance.
Operation	getHead()	returns the head property from a PathItem instance.
Operation	getOptions()	returns the options property from a PathItem instance.
List<Parameter>	getParameters()	returns the parameters property from a 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.
List<Server>	getServers()	returns the servers property from a PathItem instance.
String	getSummary()	returns the summary property from a PathItem instance.
Operation	getTrace()	returns the trace property from a PathItem instance.
int	hashCode()
PathItem	head(Operation head)
void	operation(PathItem.HttpMethod method, Operation operation)
PathItem	options(Operation options)
PathItem	parameters(List<Parameter> parameters)
PathItem	patch(Operation patch)
PathItem	post(Operation post)
PathItem	put(Operation put)
List<Operation>	readOperations()
Map<PathItem.HttpMethod,Operation>	readOperationsMap()
PathItem	servers(List<Server> servers)
void	set$ref(String $ref)
void	setDelete(Operation delete)
void	setDescription(String description)
void	setExtensions(Map<String,Object> extensions)
void	setGet(Operation get)
void	setHead(Operation head)
void	setOptions(Operation options)
void	setParameters(List<Parameter> parameters)
void	setPatch(Operation patch)
void	setPost(Operation post)
void	setPut(Operation put)
void	setServers(List<Server> servers)
void	setSummary(String summary)
void	setTrace(Operation trace)
PathItem	summary(String summary)
String	toString()
PathItem	trace(Operation trace)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PathItem

public PathItem()

Method Detail

getSummary

public String getSummary()

returns the summary property from a PathItem instance.

Returns:

String summary

setSummary

public void setSummary(String summary)

summary

public PathItem summary(String summary)

getDescription

public String getDescription()

returns the description property from a PathItem instance.

Returns:

String description

setDescription

public void setDescription(String description)

description

public PathItem description(String description)

getGet

public Operation getGet()

returns the get property from a PathItem instance.

Returns:

Operation get

setGet

public void setGet(Operation get)

get

public PathItem get(Operation get)

getPut

public Operation getPut()

returns the put property from a PathItem instance.

Returns:

Operation put

setPut

public void setPut(Operation put)

put

public PathItem put(Operation put)

getPost

public Operation getPost()

returns the post property from a PathItem instance.

Returns:

Operation post

setPost

public void setPost(Operation post)

post

public PathItem post(Operation post)

getDelete

public Operation getDelete()

returns the delete property from a PathItem instance.

Returns:

Operation delete

setDelete

public void setDelete(Operation delete)

delete

public PathItem delete(Operation delete)

getOptions

public Operation getOptions()

returns the options property from a PathItem instance.

Returns:

Operation options

setOptions

public void setOptions(Operation options)

options

public PathItem options(Operation options)

getHead

public Operation getHead()

returns the head property from a PathItem instance.

Returns:

Operation head

setHead

public void setHead(Operation head)

head

public PathItem head(Operation head)

getPatch

public Operation getPatch()

returns the patch property from a PathItem instance.

Returns:

Operation patch

setPatch

public void setPatch(Operation patch)

patch

public PathItem patch(Operation patch)

getTrace

public Operation getTrace()

returns the trace property from a PathItem instance.

Returns:

Operation trace

setTrace

public void setTrace(Operation trace)

trace

public PathItem trace(Operation trace)

readOperations

public List<Operation> readOperations()

operation

public void operation(PathItem.HttpMethod method,
                      Operation operation)

readOperationsMap

public Map<PathItem.HttpMethod,Operation> readOperationsMap()

getServers

public List<Server> getServers()

returns the servers property from a PathItem instance.

Returns:

List<Server> servers

setServers

public void setServers(List<Server> servers)

servers

public PathItem servers(List<Server> servers)

addServersItem

public PathItem addServersItem(Server serversItem)

getParameters

public List<Parameter> getParameters()

returns the parameters property from a PathItem instance.

Returns:

List<Parameter> parameters

setParameters

public void setParameters(List<Parameter> parameters)

parameters

public PathItem parameters(List<Parameter> parameters)

addParametersItem

public PathItem addParametersItem(Parameter parametersItem)

getExtensions

public Map<String,Object> getExtensions()

addExtension

public void addExtension(String name,
                         Object value)

addExtension31

public void addExtension31(String name,
                           Object value)

setExtensions

public void setExtensions(Map<String,Object> extensions)

extensions

public PathItem extensions(Map<String,Object> extensions)

get$ref

public String get$ref()

returns the ref property from a PathItem instance.

Returns:

String ref

set$ref

public void set$ref(String $ref)

$ref

public PathItem $ref(String $ref)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object