Class RuleSetParamMissingDocsValidator
java.lang.Object
software.amazon.smithy.model.validation.AbstractValidator
software.amazon.smithy.rulesengine.validators.RuleSetParamMissingDocsValidator
- All Implemented Interfaces:
Validator
Validator to ensure that all parameters have documentation (in BDD and ruleset).
-
Field Summary
Fields inherited from interface software.amazon.smithy.model.validation.Validator
MODEL_DEPRECATION, MODEL_ERROR
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionValidates a model and returns a list of validation events.void
visitParams
(List<ValidationEvent> events, ServiceShape serviceShape, Iterable<Parameter> parameters) Methods inherited from class software.amazon.smithy.model.validation.AbstractValidator
createEvent, createEvent, createEvent, createEvent, danger, danger, danger, danger, danger, danger, danger, danger, error, error, error, error, error, error, error, error, getName, note, note, note, note, note, note, note, note, warning, warning, warning, warning, warning, warning, warning, warning
-
Constructor Details
-
RuleSetParamMissingDocsValidator
public RuleSetParamMissingDocsValidator()
-
-
Method Details
-
validate
Description copied from interface:Validator
Validates a model and returns a list of validation events.- Parameters:
model
- Model to validate.- Returns:
- List of validation events.
-
visitParams
public void visitParams(List<ValidationEvent> events, ServiceShape serviceShape, Iterable<Parameter> parameters)
-