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

Class AaOAuthFlowScopesVsAvailableScopesRule

java.lang.Object

io.apicurio.datamodels.models.visitors.AllNodeVisitor

io.apicurio.datamodels.validation.ValidationRule

io.apicurio.datamodels.validation.rules.invalid.value.AaOAuthFlowScopesVsAvailableScopesRule

All Implemented Interfaces:

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

public class AaOAuthFlowScopesVsAvailableScopesRule
extends ValidationRule

Rule: AAFLOW-001 Validates that OAuth flows use the correct property name for scopes based on AsyncAPI version. In AsyncAPI 2.x, OAuth flows use the 'scopes' property. In AsyncAPI 3.0, OAuth flows use the 'availableScopes' property.

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
AaOAuthFlowScopesVsAvailableScopesRule(ValidationRuleMetaData ruleInfo)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	visitOAuthFlow(OAuthFlow 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, visitChannel, visitChannelBindings, visitChannelItem, visitChannels, visitComponents, visitContact, visitCorrelationID, visitDefinitions, visitDiscriminator, visitDocument, visitEncoding, visitExample, visitExternalDocumentation, visitHeader, visitInfo, visitItems, visitLicense, visitLink, visitMediaType, visitMessage, visitMessageBindings, visitMessageExample, visitMessageTrait, visitMultiFormatSchema, 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

AaOAuthFlowScopesVsAvailableScopesRule

public AaOAuthFlowScopesVsAvailableScopesRule(ValidationRuleMetaData ruleInfo)

Constructor.

Parameters:

ruleInfo -

Method Detail

visitOAuthFlow

public void visitOAuthFlow(OAuthFlow node)

Specified by:

visitOAuthFlow in interface AsyncApiVisitor

Specified by:

visitOAuthFlow in interface OpenApi30Visitor

Specified by:

visitOAuthFlow in interface OpenApi31Visitor

Overrides:

visitOAuthFlow in class AllNodeVisitor