Package io.apicurio.datamodels.models.openapi.v31

Interface OpenApi31PathItem

All Superinterfaces:

Extensible, Node, OpenApi31Extensible, OpenApi31ParametersParent, OpenApi31Referenceable, OpenApi31ServersParent, OpenApiExtensible, OpenApiParametersParent, OpenApiPathItem, OpenApiReferenceable, OpenApiServersParent, Referenceable, Visitable

All Known Implementing Classes:

OpenApi31PathItemImpl

public interface OpenApi31PathItem
extends OpenApiPathItem, OpenApi31Extensible, OpenApi31Referenceable, OpenApi31ServersParent, OpenApi31ParametersParent

Method Summary

Modifier and Type	Method	Description
void	addExtension(String name, com.fasterxml.jackson.databind.JsonNode value)
void	addParameter(OpenApiParameter value)
void	addServer(OpenApiServer value)
void	clearExtensions()
void	clearParameters()
void	clearServers()
OpenApi31Operation	createOperation()
OpenApi31Parameter	createParameter()
OpenApi31Server	createServer()
String	get$ref()
String	getDescription()
Map<String,com.fasterxml.jackson.databind.JsonNode>	getExtensions()
List<OpenApiParameter>	getParameters()
List<OpenApiServer>	getServers()
String	getSummary()
OpenApi31Operation	getTrace()
void	insertExtension(String name, com.fasterxml.jackson.databind.JsonNode value, int atIndex)
void	insertParameter(OpenApiParameter value, int atIndex)
void	insertServer(OpenApiServer value, int atIndex)
void	removeExtension(String name)
void	removeParameter(OpenApiParameter value)
void	removeServer(OpenApiServer value)
void	set$ref(String value)
void	setDescription(String value)
void	setSummary(String value)
void	setTrace(OpenApi31Operation value)

Methods inherited from interface io.apicurio.datamodels.models.Node

addExtraProperty, attach, clearNodeAttributes, emptyClone, getExtraProperty, getExtraPropertyNames, getNodeAttribute, getNodeAttributeNames, hasExtraProperties, isAttached, mapPropertyName, modelId, parent, parentPropertyName, parentPropertyType, removeExtraProperty, root, setNodeAttribute

Methods inherited from interface io.apicurio.datamodels.models.openapi.OpenApiPathItem

getDelete, getGet, getHead, getOptions, getPatch, getPost, getPut, setDelete, setGet, setHead, setOptions, setPatch, setPost, setPut

Methods inherited from interface io.apicurio.datamodels.models.Visitable

accept

Method Detail

getSummary

String getSummary()

Specified by:

getSummary in interface OpenApi31Referenceable

setSummary

void setSummary(String value)

Specified by:

setSummary in interface OpenApi31Referenceable

getDescription

String getDescription()

Specified by:

getDescription in interface OpenApi31Referenceable

setDescription

void setDescription(String value)

Specified by:

setDescription in interface OpenApi31Referenceable

getTrace

OpenApi31Operation getTrace()

setTrace

void setTrace(OpenApi31Operation value)

createOperation

OpenApi31Operation createOperation()

Specified by:

createOperation in interface OpenApiPathItem

get$ref

String get$ref()

Specified by:

get$ref in interface Referenceable

set$ref

void set$ref(String value)

Specified by:

set$ref in interface Referenceable

createServer

OpenApi31Server createServer()

Specified by:

createServer in interface OpenApiServersParent

getServers

List<OpenApiServer> getServers()

Specified by:

getServers in interface OpenApiServersParent

addServer

void addServer(OpenApiServer value)

Specified by:

addServer in interface OpenApiServersParent

clearServers

void clearServers()

Specified by:

clearServers in interface OpenApiServersParent

removeServer

void removeServer(OpenApiServer value)

Specified by:

removeServer in interface OpenApiServersParent

insertServer

void insertServer(OpenApiServer value,
                  int atIndex)

Specified by:

insertServer in interface OpenApiServersParent

createParameter

OpenApi31Parameter createParameter()

Specified by:

createParameter in interface OpenApiParametersParent

getParameters

List<OpenApiParameter> getParameters()

Specified by:

getParameters in interface OpenApiParametersParent

addParameter

void addParameter(OpenApiParameter value)

Specified by:

addParameter in interface OpenApiParametersParent

clearParameters

void clearParameters()

Specified by:

clearParameters in interface OpenApiParametersParent

removeParameter

void removeParameter(OpenApiParameter value)

Specified by:

removeParameter in interface OpenApiParametersParent

insertParameter

void insertParameter(OpenApiParameter value,
                     int atIndex)

Specified by:

insertParameter in interface OpenApiParametersParent

getExtensions

Map<String,com.fasterxml.jackson.databind.JsonNode> getExtensions()

Specified by:

getExtensions in interface Extensible

addExtension

void addExtension(String name,
                  com.fasterxml.jackson.databind.JsonNode value)

Specified by:

addExtension in interface Extensible

clearExtensions

void clearExtensions()

Specified by:

clearExtensions in interface Extensible

removeExtension

void removeExtension(String name)

Specified by:

removeExtension in interface Extensible

insertExtension

void insertExtension(String name,
                     com.fasterxml.jackson.databind.JsonNode value,
                     int atIndex)

Specified by:

insertExtension in interface Extensible