io.apicurio.datamodels.openapi.v3.models

Class Oas30PathItem

java.lang.Object

io.apicurio.datamodels.core.models.Node

io.apicurio.datamodels.core.models.ExtensibleNode

io.apicurio.datamodels.openapi.models.OasPathItem

io.apicurio.datamodels.openapi.v3.models.Oas30PathItem

All Implemented Interfaces:

IServerParent, IReferenceNode, IVisitable, IOasParameterParent

Direct Known Subclasses:

Oas30CallbackPathItem

public class Oas30PathItem
extends OasPathItem
implements IServerParent

Models an OpenAPI 3.0.x path item.

Author:

eric.wittmann@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
String	description
List<Server>	servers
String	summary
Oas30Operation	trace

Fields inherited from class io.apicurio.datamodels.openapi.models.OasPathItem

$ref, delete, get, head, options, parameters, patch, post, put

Fields inherited from class io.apicurio.datamodels.core.models.ExtensibleNode

_extensions

Fields inherited from class io.apicurio.datamodels.core.models.Node

_attributes, _extraProperties, _modelId, _ownerDocument, _parent, _validationProblems

Constructor Summary

Constructors

Constructor and Description
Oas30PathItem(String path) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addServer(Oas30Server server) Adds a server.
void	addServer(Server server) Adds a server.
OasOperation	createOperation(String method) Creates an OAS operation object.
OasParameter	createParameter() Creates a child parameter.
Server	createServer() Creates a server.
Server	getServer(String url) Gets a server by URL.
List<Server>	getServers() Gets the servers.
void	setOperation(OasOperation operation) Sets the given operation on this path item.

Methods inherited from class io.apicurio.datamodels.openapi.models.OasPathItem

accept, addParameter, getParameter, getParameters, getParametersIn, getPath, rename

Methods inherited from class io.apicurio.datamodels.core.models.ExtensibleNode

addExtension, clearExtensions, createExtension, getExtension, getExtensions, isExtensible, removeExtension

Methods inherited from class io.apicurio.datamodels.core.models.Node

addExtraProperty, addValidationProblem, clearAttributes, clearValidationProblems, getAttribute, getAttributeNames, getExtraProperty, getExtraPropertyNames, getValidationProblemCodes, getValidationProblems, getValidationProblemsFor, hasExtraProperties, modelId, ownerDocument, parent, removeExtraProperty, setAttribute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

summary

public String summary

description

public String description

trace

public Oas30Operation trace

servers

public List<Server> servers

Constructor Detail

Oas30PathItem

public Oas30PathItem(String path)

Constructor.

Parameters:

path -

Method Detail

createOperation

public OasOperation createOperation(String method)

Description copied from class: OasPathItem

Creates an OAS operation object.

Specified by:

createOperation in class OasPathItem

See Also:

OasPathItem.createOperation(java.lang.String)

createParameter

public OasParameter createParameter()

Description copied from class: OasPathItem

Creates a child parameter.

Specified by:

createParameter in interface IOasParameterParent

Specified by:

createParameter in class OasPathItem

See Also:

OasPathItem.createParameter()

createServer

public Server createServer()

Description copied from interface: IServerParent

Creates a server.

Specified by:

createServer in interface IServerParent

See Also:

IServerParent.createServer()

addServer

public void addServer(Oas30Server server)

Adds a server.

Parameters:

server -

getServers

public List<Server> getServers()

Gets the servers.

Specified by:

getServers in interface IServerParent

setOperation

public void setOperation(OasOperation operation)

Description copied from class: OasPathItem

Sets the given operation on this path item.

Overrides:

setOperation in class OasPathItem

See Also:

OasPathItem.setOperation(io.apicurio.datamodels.openapi.models.OasOperation)

addServer

public void addServer(Server server)

Description copied from interface: IServerParent

Adds a server.

Specified by:

addServer in interface IServerParent

See Also:

IServerParent.addServer(io.apicurio.datamodels.core.models.common.Server)

getServer

public Server getServer(String url)

Description copied from interface: IServerParent

Gets a server by URL.

Specified by:

getServer in interface IServerParent

See Also:

IServerParent.getServer(java.lang.String)