Modifier and Type | Method and Description |
---|---|
static Node |
Library.readNode(Object json,
Node node)
Call this to do a "partial read" on a given node.
|
Modifier and Type | Method and Description |
---|---|
static NodePath |
Library.createNodePath(Node node)
Called to create a node path for a given data model node.
|
static Node |
Library.readNode(Object json,
Node node)
Call this to do a "partial read" on a given node.
|
static List<ValidationProblem> |
Library.validate(Node node,
IValidationSeverityRegistry severityRegistry)
Called to validate a data model node.
|
static void |
Library.visitNode(Node node,
IVisitor visitor)
Convenience method for visiting a single data model nodel.
|
static void |
Library.visitTree(Node node,
IVisitor visitor,
TraverserDirection direction)
Convenience method for visiting a data model tree.
|
static Object |
Library.writeNode(Node node)
Called to serialize a given data model node to a JSON object.
|
Modifier and Type | Class and Description |
---|---|
class |
DeleteNodeCommand<T extends Node>
A command used to delete a child node.
|
class |
ReplaceNodeCommand<T extends Node>
Base class for commands that replace entire nodes.
|
Modifier and Type | Method and Description |
---|---|
static <T> ICommand |
CommandFactory.createChangePropertyCommand(Node node,
String property,
T newValue) |
Modifier and Type | Method and Description |
---|---|
void |
CombinedReverseTraverser.traverse(Node node) |
protected void |
CombinedAllNodeVisitor.visitNode(Node node)
Visit a node.
|
protected void |
CombinedReverseTraverser.visitNode(Node node) |
protected void |
CombinedCompositeVisitor.visitNode(Node node) |
Modifier and Type | Method and Description |
---|---|
static int |
NodeCompat.indexOf(Node child,
Node parent,
String propertyName)
Figures out the index of the given child by interrogating the parent node's list of
children at the given property name.
|
Modifier and Type | Method and Description |
---|---|
protected Object |
DataModelWriter.lookupParentJson(Node node)
Lookup a JS object using the model ID of the node's parent.
|
protected Object |
DataModelWriter.lookupParentJson(Node node,
Object jsonDefault) |
protected void |
DataModelReader.readExtraProperties(Object json,
Node node)
Reads all remaining properties.
|
protected void |
DataModelWriter.updateIndex(Node node,
Object json) |
protected void |
DataModelWriter.writeExtraProperties(Object json,
Node node) |
Modifier and Type | Interface and Description |
---|---|
interface |
IIndexedNode<T extends Node>
This interface must be implemented by nodes that represent a `Map[string, T]` data type
in the specification, and therefore can't be modeled as a node containing
a known collection of named fields.
|
Modifier and Type | Class and Description |
---|---|
class |
Document
The base class for all document nodes.
|
class |
ExtensibleNode
All data models that can be extended using the "x-*" approach to adding vendor extension
properties must extend this class.
|
class |
Extension
Models a single extension property of a node in the data model.
|
Modifier and Type | Field and Description |
---|---|
Node |
Node._parent |
Modifier and Type | Method and Description |
---|---|
Node |
Node.parent()
Gets the parent.
|
Node |
NodePath.resolve(Document document)
Resolves a path to its target node within the document model.
|
Node |
NodePath.resolveWithVisitor(Document document,
IVisitor visitor)
Resolves a path to its target node while also visiting all nodes along the way.
|
Modifier and Type | Method and Description |
---|---|
boolean |
NodePath.contains(Node node)
Returns true if this path "contains" the given node.
|
Modifier and Type | Class and Description |
---|---|
class |
AuthorizationCodeOAuthFlow
Models an authorization code OAuth flow.
|
class |
ClientCredentialsOAuthFlow
Models a client credentials OAuth flow.
|
class |
Components
Base class for components defined by AsyncAPI 2+ and OpenAPI 3+.
|
class |
Contact
Models a contact entity.
|
class |
ExternalDocumentation
Models an External Documentation node.
|
class |
ImplicitOAuthFlow
Modles an implicit OAuth flow.
|
class |
Info
Models an Info node.
|
class |
License |
class |
ModernSecurityScheme
Implements the slightly more modern approach to a security scheme.
|
class |
OAuthFlow
Models an OAuth Flow.
|
class |
OAuthFlows
Models an OAuth Flows entity.
|
class |
Operation |
class |
Parameter
Models a parameter.
|
class |
PasswordOAuthFlow
Models a password OAuth flow.
|
class |
Schema
Models a schema.
|
class |
SecurityRequirement
Models a security requirement.
|
class |
SecurityScheme
Models a Security Scheme.
|
class |
Server |
class |
ServerVariable
Models a server variable.
|
class |
Tag
Models a Tag node.
|
Modifier and Type | Method and Description |
---|---|
static Node |
ReferenceUtil.resolveNodeRef(Node node)
Resolves a node reference.
|
static Node |
ReferenceUtil.resolveRef(String $ref,
Node from)
Resolves a reference from a relative position in the data model.
|
Node |
ReferenceResolver.resolveRef(String $ref,
Node from)
Resolves a reference from a relative position in the data model.
|
Modifier and Type | Method and Description |
---|---|
static boolean |
ReferenceUtil.canResolveRef(String $ref,
Node from)
Returns true only if the given reference can be resolved relative to the given document.
|
static NodePath |
NodePathUtil.createNodePath(Node node) |
static Node |
ReferenceUtil.resolveNodeRef(Node node)
Resolves a node reference.
|
static Node |
ReferenceUtil.resolveRef(String $ref,
Node from)
Resolves a reference from a relative position in the data model.
|
Node |
ReferenceResolver.resolveRef(String $ref,
Node from)
Resolves a reference from a relative position in the data model.
|
static void |
VisitorUtil.visitNode(Node node,
IVisitor visitor) |
static void |
VisitorUtil.visitTree(Node node,
IVisitor visitor,
TraverserDirection direction) |
Modifier and Type | Method and Description |
---|---|
protected boolean |
ValidationRule.isValidForType(Object value,
Node node)
Returns true if the given value is valid according to the schema provided.
|
protected void |
ValidationRule.report(Node node,
String property,
Map<String,String> messageParams)
Called by validation rules to report an error.
|
void |
ValidationVisitor.report(ValidationRuleMetaData ruleInfo,
Node node,
String property,
String message) |
void |
IValidationProblemReporter.report(ValidationRuleMetaData rule,
Node node,
String property,
String message)
Called to report a validation rule violation.
|
protected void |
ValidationRule.reportIf(boolean condition,
Node node,
String property,
Map<String,String> messageParams)
Reports a validation error if the given condition is true.
|
protected void |
ValidationRule.reportIfInvalid(boolean isValid,
Node node,
String property,
Map<String,String> messageParams)
Reports a validation error if the property is not valid.
|
protected void |
ValidationRule.reportPathError(Node node,
Map<String,String> messageParams)
Utility function to report path related errors.
|
protected void |
RequiredPropertyValidationRule.requireProperty(Node node,
String propertyName,
Map<String,String> messageProperties)
Called when a required property is missing.
|
protected void |
ValidationProblemsResetVisitor.visitNode(Node node) |
Modifier and Type | Method and Description |
---|---|
protected static OasPathItem |
OasPathParamNotFoundRule.findPathItem(Node node) |
Modifier and Type | Method and Description |
---|---|
protected void |
OasUnknownPropertyRule.visitNode(Node node) |
Modifier and Type | Method and Description |
---|---|
protected void |
OasRequiredPropertyValidationRule.requireProperty(Node node,
String propertyName,
Map<String,String> messageParams)
Called when a required property is missing.
|
protected void |
OasRequiredPropertyValidationRule.requirePropertyWhen(Node node,
String propertyName,
String dependentPropertyName,
Object dependentPropertyExpectedValue,
Map<String,String> messageParams)
Called when a conditionally required property is missing.
|
Modifier and Type | Method and Description |
---|---|
void |
Traverser.traverse(Node node)
Called to traverse the data model starting at the given node and traversing
down until this node and all child nodes have been visited.
|
void |
ITraverser.traverse(Node node)
Traverse a single node in a data model.
|
protected void |
Traverser.traverseValidationProblems(Node node)
Traverse the validation problems, if any are found.
|
protected void |
AllNodeVisitor.visitNode(Node node) |
Modifier and Type | Method and Description |
---|---|
protected void |
Traverser.traverseIndexedNode(IIndexedNode<? extends Node> node)
Traverse all children of the indexed node.
|
Modifier and Type | Class and Description |
---|---|
class |
OasContact |
class |
OasDocument
Models an OpenAPI document.
|
class |
OasExternalDocumentation |
class |
OasHeader
Models an OpenAPI header.
|
class |
OasInfo |
class |
OasLicense |
class |
OasOperation
Models an OpenAPI operation.
|
class |
OasParameter |
class |
OasPathItem
Models an OpenAPI path item.
|
class |
OasPaths
Modles the OpenAPI paths.
|
class |
OasResponse
Models an OpenAPI
|
class |
OasResponses
Models an OpenAPI responses.
|
class |
OasSchema
Models an OpenAPI schema.
|
class |
OasSecurityRequirement
Models an OpenAPI security requirement.
|
class |
OasTag |
class |
OasXML |
Modifier and Type | Class and Description |
---|---|
class |
Oas20Contact |
class |
Oas20Definitions
Models an OpenAPI 2.0 Definitions.
|
class |
Oas20Document
Models the root document of the OpenAPI 2.0 (aka Swagger) data model.
|
class |
Oas20Example
An OpenAPI 2.0 example.
|
class |
Oas20ExternalDocumentation |
class |
Oas20Header
Models an OpenAPI 2.0 header.
|
class |
Oas20Headers |
class |
Oas20Info |
class |
Oas20Items
Models an OpenAPI 2.0 items.
|
class |
Oas20License |
class |
Oas20Operation
Models an OpenAPI 2.0 operation.
|
class |
Oas20Parameter
Models an OpenAPi 2.0 parameter.
|
class |
Oas20ParameterDefinition
Models an OpenAPI 2.0 parameter definition.
|
class |
Oas20ParameterDefinitions
Models an OpenAPI 2.0 Parameter Definitions.
|
class |
Oas20PathItem
Models an OpenAPI 2.0 path item.
|
class |
Oas20Paths |
class |
Oas20Response
Models an OpenAPI 2.0 response.
|
class |
Oas20ResponseDefinition
Models an OpenAPI 2.0 response definition.
|
class |
Oas20ResponseDefinitions
Models an OpenAPI 2.0 responses.
|
class |
Oas20Responses
Implements an OpenAPI 2.0 responses.
|
class |
Oas20Schema |
static class |
Oas20Schema.Oas20AdditionalPropertiesSchema |
static class |
Oas20Schema.Oas20AllOfSchema |
static class |
Oas20Schema.Oas20ItemsSchema |
static class |
Oas20Schema.Oas20PropertySchema |
class |
Oas20SchemaDefinition
Models an OpenAPI 2.0 schema definition.
|
class |
Oas20Scopes
Models an OpenAPI 2.0 scopes.
|
class |
Oas20SecurityDefinitions
Models an OpenAPI security definitions.
|
class |
Oas20SecurityRequirement |
class |
Oas20SecurityScheme
Models an OpenAPI 2.0 security scheme.
|
class |
Oas20Tag |
class |
Oas20XML
Models an OpenAPI 2.0 XML.
|
Modifier and Type | Class and Description |
---|---|
class |
Oas30AuthorizationCodeOAuthFlow
Models an OpenAPI 3.0.x authorization code oauth flow.
|
class |
Oas30Callback |
class |
Oas30CallbackDefinition |
class |
Oas30CallbackPathItem
Models a callback path item.
|
class |
Oas30ClientCredentialsOAuthFlow
Models an OpenAPI 3.0.x client credentials OAuth flow.
|
class |
Oas30Components
Models an OpenAPI 3.0.x Components.
|
class |
Oas30Contact |
class |
Oas30Discriminator
Models an OpenAPI 3.0.x Discriminator.
|
class |
Oas30Document
Models the root document of the OpenAPI 2.0 (aka Swagger) data model.
|
class |
Oas30Encoding
Models an OpenAPI 3.0.x Encoding.
|
class |
Oas30Example
Models an OpenAPI 3.0.x example.
|
class |
Oas30ExampleDefinition
Models an OpenAPI 3.0.x example definition.
|
class |
Oas30ExternalDocumentation |
class |
Oas30Header
Models an OpenAPI 3.0.x header.
|
class |
Oas30HeaderDefinition
Models an OpenAPI 3.0.x header definition.
|
class |
Oas30ImplicitOAuthFlow
Models an OpenAPI 3.0.x implicit OAuth flow.
|
class |
Oas30Info |
class |
Oas30License |
class |
Oas30Link
Models an OpenAPI 3.0.x Link.
|
class |
Oas30LinkDefinition
Models an OpenAPI 3.0.x link definition.
|
class |
Oas30LinkParameterExpression
Models an OpenAPI link parameter expression.
|
class |
Oas30LinkRequestBodyExpression
Models a link request body expression.
|
class |
Oas30LinkServer |
class |
Oas30MediaType
Models an OpenAPI 3.0.x media type.
|
class |
Oas30OAuthFlows
Models an OpenAPI 3.0.x OAuth Flows.
|
class |
Oas30Operation
Models an OpenAPI 3.0.x operation.
|
class |
Oas30Parameter
Models an OpenAPI 3.0.x parameter.
|
class |
Oas30ParameterDefinition
Models an OpenAPI 3.0.x parameter definition.
|
class |
Oas30PasswordOAuthFlow
Models an OpenAPI 3.0.x password OAuth flow.
|
class |
Oas30PathItem
Models an OpenAPI 3.0.x path item.
|
class |
Oas30Paths |
class |
Oas30RequestBody
Models an OpenAPI 3.0.x Request Body.
|
class |
Oas30RequestBodyDefinition
Models an OpenAPI 3.0.x request body definition.
|
class |
Oas30Response
Models an OpenAPI 3.0.x response.
|
class |
Oas30ResponseDefinition
Models an OpenAPI 3.0.x response definition.
|
class |
Oas30Responses
Implements an OpenAPI 3.0.x responses.
|
class |
Oas30Schema
Models an OpenAPI 3.0.x schema.
|
static class |
Oas30Schema.Oas30AdditionalPropertiesSchema |
static class |
Oas30Schema.Oas30AllOfSchema |
static class |
Oas30Schema.Oas30AnyOfSchema |
static class |
Oas30Schema.Oas30ItemsSchema |
static class |
Oas30Schema.Oas30NotSchema |
static class |
Oas30Schema.Oas30OneOfSchema |
static class |
Oas30Schema.Oas30PropertySchema |
class |
Oas30SchemaDefinition |
class |
Oas30SecurityRequirement |
class |
Oas30SecurityScheme
Models an OpenAPI 3.0.x security scheme.
|
class |
Oas30Server |
class |
Oas30ServerVariable
Models an OpenAPI 3 server variable.
|
class |
Oas30Tag |
class |
Oas30XML
Models an OpenAPI 3.0.x XML.
|
Copyright © 2019 Red Hat. All rights reserved.