public abstract class OasOperation extends Operation implements IOasParameterParent, ISecurityRequirementParent
Modifier and Type | Field and Description |
---|---|
Boolean |
deprecated |
List<OasParameter> |
parameters |
OasResponses |
responses |
List<SecurityRequirement> |
security |
List<String> |
tags |
_type, description, externalDocs, operationId, summary
_extensions
_attributes, _extraProperties, _modelId, _ownerDocument, _parent, _validationProblems
Constructor and Description |
---|
OasOperation(String method)
Constructor.
|
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.
|
accept, createExternalDocumentation, getType, setExternalDocumentation, setExternalDocumentation
addExtension, clearExtensions, createExtension, getExtension, getExtensions, isExtensible, removeExtension
addExtraProperty, addValidationProblem, attachToParent, clearAttributes, clearValidationProblems, getAttribute, getAttributeNames, getExtraProperty, getExtraPropertyNames, getValidationProblemCodes, getValidationProblems, getValidationProblemsFor, hasExtraProperties, isAttached, modelId, ownerDocument, parent, removeExtraProperty, setAttribute
public List<OasParameter> parameters
public OasResponses responses
public Boolean deprecated
public List<SecurityRequirement> security
public OasOperation(String method)
method
- public List<OasParameter> getParameters()
IOasParameterParent
getParameters
in interface IOasParameterParent
IOasParameterParent.getParameters()
public List<OasParameter> getParametersIn(String in)
IOasParameterParent
getParametersIn
in interface IOasParameterParent
IOasParameterParent.getParametersIn(java.lang.String)
public String getMethod()
public abstract OasParameter createParameter()
createParameter
in interface IOasParameterParent
public OasParameter getParameter(String in, String name)
getParameter
in interface IOasParameterParent
in
- name
- public OasParameter addParameter(OasParameter parameter)
addParameter
in interface IOasParameterParent
parameter
- public abstract OasResponses createResponses()
public abstract OasSecurityRequirement createSecurityRequirement()
ISecurityRequirementParent
createSecurityRequirement
in interface ISecurityRequirementParent
ISecurityRequirementParent.createSecurityRequirement()
public SecurityRequirement addSecurityRequirement(SecurityRequirement securityRequirement)
ISecurityRequirementParent
public List<SecurityRequirement> getSecurityRequirements()
ISecurityRequirementParent
getSecurityRequirements
in interface ISecurityRequirementParent
ISecurityRequirementParent.getSecurityRequirements()
Copyright © 2020 Red Hat. All rights reserved.