io.apicurio.datamodels.openapi.v2.models

Class Oas20Operation

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.v2.models.Oas20Operation

All Implemented Interfaces:

IExternalDocumentationParent, ISecurityRequirementParent, IVisitable, IOasParameterParent

public class Oas20Operation
extends OasOperation

Models an OpenAPI 2.0 operation.

Author:

eric.wittmann@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
List<String>	consumes
List<String>	produces
List<String>	schemes

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

Method Summary

Modifier and Type	Method and Description
ExternalDocumentation	createExternalDocumentation() Creates an External Documentation node.
OasParameter	createParameter() Creates a child parameter model.
OasResponses	createResponses() Creates a child responses model.
OasSecurityRequirement	createSecurityRequirement() Creates an OAS Security Requirement object.

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

consumes

public List<String> consumes

produces

public List<String> produces

schemes

public List<String> schemes

Constructor Detail

Oas20Operation

public Oas20Operation(String method)

Constructor.

Parameters:

method -

Method Detail

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

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