io.apicurio.datamodels.core.validation.rules.required

Class OasRequiredPropertyValidationRule

java.lang.Object

io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor

io.apicurio.datamodels.core.validation.ValidationRule

io.apicurio.datamodels.core.validation.rules.required.OasRequiredPropertyValidationRule

All Implemented Interfaces:

IAai20Visitor, IAaiVisitor, IVisitor, IOas20Visitor, IOas30Visitor, IOasVisitor

Direct Known Subclasses:

OasMissingApiInformationRule, OasMissingApiKeySchemeParamLocationRule, OasMissingApiKeySchemeParamNameRule, OasMissingApiPathsRule, OasMissingApiTitleRule, OasMissingApiVersionRule, OasMissingBodyParameterSchemaRule, OasMissingDiscriminatorPropertyNameRule, OasMissingExternalDocumentationUrlRule, OasMissingHeaderArrayInformationRule, OasMissingHeaderTypeRule, OasMissingHttpSecuritySchemeTypeRule, OasMissingItemsArrayInformationRule, OasMissingItemsTypeRule, OasMissingLicenseNameRule, OasMissingOAuthFlowAuthUrlRule, OasMissingOAuthFlowRokenUrlRule, OasMissingOAuthFlowScopesRule, OasMissingOAuthSchemeAuthUrlRule, OasMissingOAuthSchemeFlowTypeRule, OasMissingOAuthSchemeScopesRule, OasMissingOAuthSchemeTokenUrlRule, OasMissingOAuthSecuritySchemeFlowsRule, OasMissingOpenApiPropertyRule, OasMissingOpenIdConnectSecuritySchemeConnectUrlRule, OasMissingOperationDescriptionRule, OasMissingOperationIdRule, OasMissingOperationResponsesRule, OasMissingOperationSummaryRule, OasMissingOperationTagsRule, OasMissingParameterArrayTypeRule, OasMissingParameterLocationRule, OasMissingParameterNameRule, OasMissingParameterTypeRule, OasMissingRequestBodyContentRule, OasMissingResponseDescriptionRule, OasMissingSchemaArrayInformationRule, OasMissingSecuritySchemeTypeRule, OasMissingServerTemplateUrlRule, OasMissingServerVarDefaultValueRule, OasMissingTagNameRule, OasPathParamsMustBeRequiredRule

public abstract class OasRequiredPropertyValidationRule
extends ValidationRule

Base class for all Required Property rules.

Author:

eric.wittmann@gmail.com

Nested Class Summary

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

ValidationRule.PathSegment

Constructor Summary

Constructors

Constructor and Description
OasRequiredPropertyValidationRule(ValidationRuleMetaData ruleInfo) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	requireProperty(Node node, String propertyName, Map<String,String> messageParams) Called when a required property is missing.
protected void	requirePropertyWhen(Node node, String propertyName, String dependentPropertyName, Object dependentPropertyExpectedValue, Map<String,String> messageParams) Called when a conditionally required property is missing.

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

array, equals, getPathSegments, hasValue, isDefined, isNullOrUndefined, isPathWellFormed, isValidCommonMark, isValidEmailAddress, isValidEnumItem, isValidForType, isValidGFM, isValidHttpCode, isValidMimeType, isValidUrl, isValidUrlTemplate, map, report, reportIf, reportIfInvalid, reportPathError, setReporter

Methods inherited from class io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor

visitAaiParameter, visitAdditionalPropertiesSchema, visitAllOfSchema, visitAnyOfSchema, visitAuthorizationCodeOAuthFlow, visitAuthorizationCodeOAuthFlow, visitCallback, visitCallbackDefinition, visitCallbackPathItem, visitChannelItem, visitClientCredentialsOAuthFlow, visitClientCredentialsOAuthFlow, visitComponents, visitContact, visitCorrelationId, visitDefinitions, visitDiscriminator, visitDocument, visitEncoding, visitExample, visitExample, visitExampleDefinition, visitExtension, visitExternalDocumentation, visitHeader, visitHeaderDefinition, visitHeaderItem, visitHeaders, visitImplicitOAuthFlow, visitImplicitOAuthFlow, visitInfo, visitItems, visitItemsSchema, visitLicense, visitLink, visitLinkDefinition, visitLinkParameterExpression, visitLinkRequestBodyExpression, visitLinkServer, visitMediaType, visitMessage, visitMessageTrait, visitMessageTraitExtendedItem, visitMessageTraitItems, visitNode, visitNotSchema, visitOAuthFlows, visitOAuthFlows, visitOneOfSchema, visitOperation, visitOperationTrait, visitOperationTraitExtendedItem, visitOperationTraitItems, visitParameter, visitParameterDefinition, visitParameterDefinitions, visitPasswordOAuthFlow, visitPasswordOAuthFlow, visitPathItem, visitPaths, visitPropertySchema, visitProtocolInfo, visitRequestBody, visitRequestBodyDefinition, visitResponse, visitResponseDefinition, visitResponseDefinitions, visitResponses, visitSchema, visitSchemaDefinition, visitScopes, visitSecurityDefinitions, visitSecurityRequirement, visitSecurityScheme, visitServer, visitServerVariable, visitTag, visitUnknownTrait, visitValidationProblem, 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.core.visitors.IVisitor

visitContact, visitDocument, visitExtension, visitExternalDocumentation, visitInfo, visitLicense, visitOperation, visitParameter, visitParameterDefinition, visitSchema, visitSchemaDefinition, visitSecurityRequirement, visitSecurityScheme, visitTag, visitValidationProblem

Constructor Detail

OasRequiredPropertyValidationRule

public OasRequiredPropertyValidationRule(ValidationRuleMetaData ruleInfo)

Constructor.

Parameters:

ruleInfo -

Method Detail

requireProperty

protected void requireProperty(Node node,
                               String propertyName,
                               Map<String,String> messageParams)

Called when a required property is missing.

Parameters:

node -

propertyName -

messageParams -

requirePropertyWhen

protected void requirePropertyWhen(Node node,
                                   String propertyName,
                                   String dependentPropertyName,
                                   Object dependentPropertyExpectedValue,
                                   Map<String,String> messageParams)

Called when a conditionally required property is missing.

Parameters:

node -

propertyName -

dependentPropertyName -

dependentPropertyExpectedValue -

messageParams -