public abstract class OasPathItem extends ExtensibleNode implements IOasParameterParent, IReferenceNode
Modifier and Type | Field and Description |
---|---|
String |
$ref |
OasOperation |
delete |
OasOperation |
get |
OasOperation |
head |
OasOperation |
options |
List<OasParameter> |
parameters |
OasOperation |
patch |
OasOperation |
post |
OasOperation |
put |
_extensions
_attributes, _extraProperties, _modelId, _ownerDocument, _parent, _validationProblems
Constructor and Description |
---|
OasPathItem(String path)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
accept(IVisitor visitor)
Called to accept a visitor onto a visitable data model instance.
|
OasParameter |
addParameter(OasParameter param)
Adds a parameter.
|
abstract OasOperation |
createOperation(String method)
Creates an OAS operation object.
|
abstract OasParameter |
createParameter()
Creates a child parameter.
|
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).
|
String |
getPath()
Gets the path string.
|
void |
rename(String newPath)
Rename the path item (change its path value).
|
void |
setOperation(OasOperation operation)
Sets the given operation on this path item.
|
addExtension, clearExtensions, createExtension, getExtension, getExtensions, isExtensible, removeExtension
addExtraProperty, addValidationProblem, clearAttributes, clearValidationProblems, getAttribute, getAttributeNames, getExtraProperty, getExtraPropertyNames, getValidationProblemCodes, getValidationProblems, getValidationProblemsFor, hasExtraProperties, modelId, ownerDocument, parent, removeExtraProperty, setAttribute
public String $ref
public OasOperation get
public OasOperation put
public OasOperation post
public OasOperation delete
public OasOperation options
public OasOperation head
public OasOperation patch
public List<OasParameter> parameters
public OasPathItem(String path)
path
- public void rename(String newPath)
newPath
- 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 getPath()
public void accept(IVisitor visitor)
IVisitable
accept
in interface IVisitable
accept
in class Node
Node.accept(io.apicurio.datamodels.core.visitors.IVisitor)
public abstract OasOperation createOperation(String method)
method
- public abstract OasParameter createParameter()
createParameter
in interface IOasParameterParent
public OasParameter addParameter(OasParameter param)
addParameter
in interface IOasParameterParent
param
- public OasParameter getParameter(String in, String name)
getParameter
in interface IOasParameterParent
in
- name
- public void setOperation(OasOperation operation)
operation
- Copyright © 2021 Red Hat. All rights reserved.