Package io.apicurio.datamodels.validation.rules.invalid.format

Class AaInvalidChannelDescriptionRule

java.lang.Object

io.apicurio.datamodels.models.visitors.AllNodeVisitor

io.apicurio.datamodels.validation.ValidationRule

io.apicurio.datamodels.validation.rules.invalid.format.AaInvalidChannelDescriptionRule

All Implemented Interfaces:

AsyncApi20Visitor, AsyncApi21Visitor, AsyncApi22Visitor, AsyncApi23Visitor, AsyncApi24Visitor, AsyncApi25Visitor, AsyncApi26Visitor, AsyncApi30Visitor, AsyncApiVisitor, OpenApi20Visitor, OpenApi30Visitor, OpenApi31Visitor, OpenApiVisitor, CombinedVisitor, TraversingVisitor, Visitor

public class AaInvalidChannelDescriptionRule
extends ValidationRule

Rule: CHAN-002 Validates that Channel description is in valid CommonMark format if provided. Applies to both AsyncAPI 2.x (AsyncApiChannelItem) and 3.0 (AsyncApi30Channel).

Author:

eric.wittmann@gmail.com

Nested Class Summary

Nested classes/interfaces inherited from class io.apicurio.datamodels.validation.ValidationRule

ValidationRule.PathSegment

Field Summary

Fields inherited from class io.apicurio.datamodels.validation.ValidationRule

traversalContext

Constructor Summary

Constructors

Constructor	Description
AaInvalidChannelDescriptionRule(ValidationRuleMetaData ruleInfo)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	visitChannel(AsyncApi30Channel node)
void	visitChannelItem(AsyncApiChannelItem node)

Methods inherited from class io.apicurio.datamodels.validation.ValidationRule

array, equals, getDefinitionName, getEncodingName, getMappedNodeName, getOperationMethod, getPathSegments, getPathTemplate, getStatusCode, hasRef, hasValue, isDefined, isDefinition, isNullOrUndefined, isPathWellFormed, isValidCommonMark, isValidEmailAddress, isValidEnumItem, isValidForType, isValidGFM, isValidHttpCode, isValidMimeType, isValidUrl, isValidUrlTemplate, map, report, reportIf, reportIfInvalid, reportPathError, setReporter, setTraversalContext, visitNode

Methods inherited from class io.apicurio.datamodels.models.visitors.AllNodeVisitor

visitBinding, visitCallback, visitChannelBindings, visitChannels, visitComponents, visitContact, visitCorrelationID, visitDefinitions, visitDiscriminator, visitDocument, visitEncoding, visitExample, visitExternalDocumentation, visitHeader, visitInfo, visitItems, visitLicense, visitLink, visitMediaType, visitMessage, visitMessageBindings, visitMessageExample, visitMessageTrait, visitMultiFormatSchema, visitOAuthFlow, visitOAuthFlows, visitOneOfMessages, visitOperation, visitOperationBindings, visitOperationReply, visitOperationReplyAddress, visitOperations, visitOperationTrait, visitParameter, visitParameterDefinitions, visitParameters, visitPathItem, visitPaths, visitReference, visitRequestBody, visitResponse, visitResponseDefinitions, visitResponses, visitSchema, visitScopes, visitSecurityDefinitions, visitSecurityRequirement, visitSecurityScheme, visitServer, visitServerBindings, visitServers, visitServerVariable, visitTag, visitXML

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.apicurio.datamodels.models.visitors.Visitor

visitContact, visitDocument, visitExternalDocumentation, visitInfo, visitLicense, visitOperation, visitParameter, visitSchema, visitSecurityScheme, visitTag

Constructor Detail

AaInvalidChannelDescriptionRule

public AaInvalidChannelDescriptionRule(ValidationRuleMetaData ruleInfo)

Constructor.

Parameters:

ruleInfo -

Method Detail

visitChannelItem

public void visitChannelItem(AsyncApiChannelItem node)

Specified by:

visitChannelItem in interface AsyncApi20Visitor

Specified by:

visitChannelItem in interface AsyncApi21Visitor

Specified by:

visitChannelItem in interface AsyncApi22Visitor

Specified by:

visitChannelItem in interface AsyncApi23Visitor

Specified by:

visitChannelItem in interface AsyncApi24Visitor

Specified by:

visitChannelItem in interface AsyncApi25Visitor

Specified by:

visitChannelItem in interface AsyncApi26Visitor

Overrides:

visitChannelItem in class AllNodeVisitor

visitChannel

public void visitChannel(AsyncApi30Channel node)

Specified by:

visitChannel in interface AsyncApi30Visitor

Overrides:

visitChannel in class AllNodeVisitor