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

Interface OpenApi31Operation

All Superinterfaces:

Extensible, Node, OpenApi31Extensible, OpenApi31ParametersParent, OpenApi31SecurityRequirementsParent, OpenApi31ServersParent, OpenApiExtensible, OpenApiOperation, OpenApiParametersParent, OpenApiSecurityRequirementsParent, OpenApiServersParent, Operation, SecurityRequirementsParent, Visitable

All Known Implementing Classes:

OpenApi31OperationImpl

public interface OpenApi31Operation
extends OpenApiOperation, OpenApi31Extensible, OpenApi31ServersParent, OpenApi31ParametersParent, OpenApi31SecurityRequirementsParent

Method Summary

Modifier and Type	Method	Description
void	addCallback(String name, OpenApi31Callback value)
void	addExtension(String name, com.fasterxml.jackson.databind.JsonNode value)
void	addParameter(OpenApiParameter value)
void	addSecurity(SecurityRequirement value)
void	addServer(OpenApiServer value)
void	clearCallbacks()
void	clearExtensions()
void	clearParameters()
void	clearSecurity()
void	clearServers()
OpenApi31Callback	createCallback()
OpenApi31Parameter	createParameter()
OpenApi31RequestBody	createRequestBody()
OpenApi31SecurityRequirement	createSecurityRequirement()
OpenApi31Server	createServer()
Map<String,OpenApi31Callback>	getCallbacks()
Map<String,com.fasterxml.jackson.databind.JsonNode>	getExtensions()
List<OpenApiParameter>	getParameters()
OpenApi31RequestBody	getRequestBody()
List<SecurityRequirement>	getSecurity()
List<OpenApiServer>	getServers()
void	insertCallback(String name, OpenApi31Callback value, int atIndex)
void	insertExtension(String name, com.fasterxml.jackson.databind.JsonNode value, int atIndex)
void	insertParameter(OpenApiParameter value, int atIndex)
void	insertSecurity(SecurityRequirement value, int atIndex)
void	insertServer(OpenApiServer value, int atIndex)
void	removeCallback(String name)
void	removeExtension(String name)
void	removeParameter(OpenApiParameter value)
void	removeSecurity(SecurityRequirement value)
void	removeServer(OpenApiServer value)
void	setRequestBody(OpenApi31RequestBody 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.OpenApiOperation

createResponses, getOperationId, getResponses, getTags, isDeprecated, setDeprecated, setOperationId, setResponses, setTags

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

createExternalDocumentation, getDescription, getExternalDocs, getSummary, setDescription, setExternalDocs, setSummary

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

accept

Method Detail

getRequestBody

OpenApi31RequestBody getRequestBody()

setRequestBody

void setRequestBody(OpenApi31RequestBody value)

createRequestBody

OpenApi31RequestBody createRequestBody()

createCallback

OpenApi31Callback createCallback()

getCallbacks

Map<String,OpenApi31Callback> getCallbacks()

addCallback

void addCallback(String name,
                 OpenApi31Callback value)

clearCallbacks

void clearCallbacks()

removeCallback

void removeCallback(String name)

insertCallback

void insertCallback(String name,
                    OpenApi31Callback value,
                    int atIndex)

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

createSecurityRequirement

OpenApi31SecurityRequirement createSecurityRequirement()

Specified by:

createSecurityRequirement in interface SecurityRequirementsParent

getSecurity

List<SecurityRequirement> getSecurity()

Specified by:

getSecurity in interface SecurityRequirementsParent

addSecurity

void addSecurity(SecurityRequirement value)

Specified by:

addSecurity in interface SecurityRequirementsParent

clearSecurity

void clearSecurity()

Specified by:

clearSecurity in interface SecurityRequirementsParent

removeSecurity

void removeSecurity(SecurityRequirement value)

Specified by:

removeSecurity in interface SecurityRequirementsParent

insertSecurity

void insertSecurity(SecurityRequirement value,
                    int atIndex)

Specified by:

insertSecurity in interface SecurityRequirementsParent

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

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