Package software.amazon.smithy.linters

Class StandardOperationVerbValidator

java.lang.Object

software.amazon.smithy.model.validation.AbstractValidator

software.amazon.smithy.linters.StandardOperationVerbValidator

All Implemented Interfaces:

Validator

public final class StandardOperationVerbValidator
extends AbstractValidator

Validates that operation shape names start with standard verbs.

Looks at each operation shape name and determines if the first word in the shape name is one of the pre-defined allowed verbs.

If the verb is a key in the map of verbs that have recommended alternatives, then the event that is emitted contains the list of alternate verbs to use.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StandardOperationVerbValidator.Config	StandardOperationVerb configuration settings.
static final class	StandardOperationVerbValidator.Provider

Field Summary

Fields inherited from interface software.amazon.smithy.model.validation.Validator

MODEL_DEPRECATION, MODEL_ERROR

Method Summary

Modifier and Type	Method	Description
List<ValidationEvent>	validate(Model model)	Validates a model and returns a list of validation events.

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

Methods inherited from class java.lang.Object

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

Method Details

validate

public List<ValidationEvent> validate(Model model)

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.