Package software.amazon.smithy.model.validation.validators

Class OperationValidator

java.lang.Object

software.amazon.smithy.model.validation.AbstractValidator

software.amazon.smithy.model.validation.validators.OperationValidator

All Implemented Interfaces:

Validator

public final class OperationValidator
extends AbstractValidator

Validates operation inputs, outputs, and the use of input and output traits.

• Emits an OperationInputOutputMisuse ERROR when a structure marked with the input trait or output trait is used in other contexts than input or output, or reused by multiple operations.
• Emits an OperationInputOutputName WARNING when the input or output shape name does not start with the name of the operation that targets it (if any).
• Emits an OperationNameAmbiguity WARNING when a shape has a name that starts with the name of an operation and the name ends with Input, Output, Request, or Response but is not used as the input or output of an operation.

Field Summary

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

MODEL_DEPRECATION, MODEL_ERROR

Constructor Summary

Constructors

Constructor	Description
OperationValidator()

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, danger, danger, error, error, getName, note, note, warning, warning

Methods inherited from class java.lang.Object

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

Constructor Details

OperationValidator

public OperationValidator()

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.