io.apicurio.datamodels.openapi.v3.models

Class Oas30Operation

java.lang.Object

io.apicurio.datamodels.core.models.Node

io.apicurio.datamodels.core.models.ExtensibleNode

io.apicurio.datamodels.core.models.common.Operation

io.apicurio.datamodels.openapi.models.OasOperation

io.apicurio.datamodels.openapi.v3.models.Oas30Operation

All Implemented Interfaces:

IExternalDocumentationParent, ISecurityRequirementParent, IServerParent, IVisitable, IOasParameterParent

public class Oas30Operation
extends OasOperation
implements IServerParent

Models an OpenAPI 3.0.x operation.

Author:

eric.wittmann@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,Oas30Callback>	callbacks
Oas30RequestBody	requestBody
List<Server>	servers

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

deprecated, parameters, responses, security, tags

Fields inherited from class io.apicurio.datamodels.core.models.common.Operation

description, externalDocs, operationId, summary

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
Oas30Operation(String method) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addCallback(String name, Oas30Callback callback) Adds a callback.
void	addServer(Server server) Adds a server.
Oas30Callback	createCallback(String name) Creates a callback.
ExternalDocumentation	createExternalDocumentation() Creates an External Documentation node.
OasParameter	createParameter() Creates a child parameter model.
Oas30RequestBody	createRequestBody() Creates a child RequestBody model.
OasResponses	createResponses() Creates a child responses model.
OasSecurityRequirement	createSecurityRequirement() Creates an OAS Security Requirement object.
Server	createServer() Creates a server.
Oas30Callback	getCallback(String name) Gets a single callback by name.
List<Oas30Callback>	getCallbacks() Gets a list of all callbacks.
Server	getServer(String url) Gets a server by URL.
List<Server>	getServers() Gets the list of servers.
Oas30Callback	removeCallback(String name) Removes a single callback and returns it.

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

addParameter, addSecurityRequirement, getMethod, getParameter, getParameters, getParametersIn, getSecurityRequirements

Methods inherited from class io.apicurio.datamodels.core.models.common.Operation

accept, getType, setExternalDocumentation, setExternalDocumentation

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

requestBody

public Oas30RequestBody requestBody

callbacks

public Map<String,Oas30Callback> callbacks

servers

public List<Server> servers

Constructor Detail

Oas30Operation

public Oas30Operation(String method)

Constructor.

Parameters:

method -

Method Detail

createExternalDocumentation

public ExternalDocumentation createExternalDocumentation()

Description copied from class: Operation

Creates an External Documentation node.

Specified by:

createExternalDocumentation in interface IExternalDocumentationParent

Specified by:

createExternalDocumentation in class Operation

See Also:

Operation.createExternalDocumentation()

createParameter

public OasParameter createParameter()

Description copied from class: OasOperation

Creates a child parameter model.

Specified by:

createParameter in interface IOasParameterParent

Specified by:

createParameter in class OasOperation

See Also:

OasOperation.createParameter()

createResponses

public OasResponses createResponses()

Description copied from class: OasOperation

Creates a child responses model.

Specified by:

createResponses in class OasOperation

See Also:

OasOperation.createResponses()

createSecurityRequirement

public OasSecurityRequirement createSecurityRequirement()

Description copied from interface: ISecurityRequirementParent

Creates an OAS Security Requirement object.

Specified by:

createSecurityRequirement in interface ISecurityRequirementParent

Specified by:

createSecurityRequirement in class OasOperation

See Also:

OasOperation.createSecurityRequirement()

createCallback

public Oas30Callback createCallback(String name)

Creates a callback.

Parameters:

name -

addCallback

public void addCallback(String name,
                        Oas30Callback callback)

Adds a callback.

Parameters:

name -

callback -

getCallback

public Oas30Callback getCallback(String name)

Gets a single callback by name.

Parameters:

name -

removeCallback

public Oas30Callback removeCallback(String name)

Removes a single callback and returns it. This may return null or undefined if none found.

Parameters:

name -

getCallbacks

public List<Oas30Callback> getCallbacks()

Gets a list of all callbacks.

createRequestBody

public Oas30RequestBody createRequestBody()

Creates a child RequestBody model.

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(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)

getServers

public List<Server> getServers()

Description copied from interface: IServerParent

Gets the list of servers.

Specified by:

getServers in interface IServerParent

See Also:

IServerParent.getServers()