io.apicurio.datamodels.openapi.models

Class OasOperation

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

All Implemented Interfaces:

IExternalDocumentationParent, ISecurityRequirementParent, IVisitable, IOasParameterParent

Direct Known Subclasses:

Oas20Operation, Oas30Operation

public abstract class OasOperation
extends Operation
implements IOasParameterParent, ISecurityRequirementParent

Models an OpenAPI operation.

Author:

eric.wittmann@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	deprecated
List<OasParameter>	parameters
OasResponses	responses
List<SecurityRequirement>	security
List<String>	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
OasOperation(String method) Constructor.

Method Summary

Modifier and Type	Method and Description
OasParameter	addParameter(OasParameter parameter) Adds a parameter.
SecurityRequirement	addSecurityRequirement(SecurityRequirement securityRequirement) Adds a security requirement child.
abstract OasParameter	createParameter() Creates a child parameter model.
abstract OasResponses	createResponses() Creates a child responses model.
abstract OasSecurityRequirement	createSecurityRequirement() Creates an OAS Security Requirement object.
String	getMethod() Gets the operation's method.
OasParameter	getParameter(String in, String name) Returns a single, unique parameter identified by "in" and "name" (which are the two properties that uniquely identify a parameter).
List<OasParameter>	getParameters() Gets the parameters.
List<OasParameter>	getParametersIn(String in) Gets all parameter for a location (path, query, etc).
List<SecurityRequirement>	getSecurityRequirements() Returns a list of all security requirements.

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

accept, createExternalDocumentation, 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

tags

public List<String> tags

parameters

public List<OasParameter> parameters

responses

public OasResponses responses

deprecated

public Boolean deprecated

security

public List<SecurityRequirement> security

Constructor Detail

OasOperation

public OasOperation(String method)

Constructor.

Parameters:

method -

Method Detail

getParameters

public List<OasParameter> getParameters()

Description copied from interface: IOasParameterParent

Gets the parameters.

Specified by:

getParameters in interface IOasParameterParent

See Also:

IOasParameterParent.getParameters()

getParametersIn

public List<OasParameter> getParametersIn(String in)

Description copied from interface: IOasParameterParent

Gets all parameter for a location (path, query, etc).

Specified by:

getParametersIn in interface IOasParameterParent

See Also:

IOasParameterParent.getParametersIn(java.lang.String)

getMethod

public String getMethod()

Gets the operation's method.

createParameter

public abstract OasParameter createParameter()

Creates a child parameter model.

Specified by:

createParameter in interface IOasParameterParent

getParameter

public OasParameter getParameter(String in,
                                 String name)

Returns a single, unique parameter identified by "in" and "name" (which are the two properties that uniquely identify a parameter). Returns null if no parameter is found.

Specified by:

getParameter in interface IOasParameterParent

Parameters:

in -

name -

addParameter

public OasParameter addParameter(OasParameter parameter)

Adds a parameter.

Specified by:

addParameter in interface IOasParameterParent

Parameters:

parameter -

createResponses

public abstract OasResponses createResponses()

Creates a child responses model.

createSecurityRequirement

public abstract OasSecurityRequirement createSecurityRequirement()

Description copied from interface: ISecurityRequirementParent

Creates an OAS Security Requirement object.

Specified by:

createSecurityRequirement in interface ISecurityRequirementParent

See Also:

ISecurityRequirementParent.createSecurityRequirement()

addSecurityRequirement

public SecurityRequirement addSecurityRequirement(SecurityRequirement securityRequirement)

Description copied from interface: ISecurityRequirementParent

Adds a security requirement child.

Specified by:

addSecurityRequirement in interface ISecurityRequirementParent

See Also:

ISecurityRequirementParent.addSecurityRequirement(io.apicurio.datamodels.core.models.common.SecurityRequirement)

getSecurityRequirements

public List<SecurityRequirement> getSecurityRequirements()

Description copied from interface: ISecurityRequirementParent

Returns a list of all security requirements.

Specified by:

getSecurityRequirements in interface ISecurityRequirementParent

See Also:

ISecurityRequirementParent.getSecurityRequirements()