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

Class OasInvalidExampleDescriptionRule

java.lang.Object

io.apicurio.datamodels.models.visitors.AllNodeVisitor

io.apicurio.datamodels.validation.ValidationRule

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

All Implemented Interfaces:

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

public class OasInvalidExampleDescriptionRule
extends ValidationRule

Implements the Invalid Example Description Rule

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

Method Summary

Modifier and Type	Method	Description
void	visitExample(OpenApiExample node)

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

array, equals, getDefinitionName, getEncodingName, getMappedNodeName, getOperationMethod, getPathSegments, getPathTemplate, getStatusCode, 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, 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

OasInvalidExampleDescriptionRule

public OasInvalidExampleDescriptionRule(ValidationRuleMetaData ruleInfo)

Constructor.

Parameters:

ruleInfo -

Method Detail

visitExample

public void visitExample(OpenApiExample node)

Specified by:

visitExample in interface OpenApiVisitor

Overrides:

visitExample in class AllNodeVisitor