Package software.amazon.smithy.linters
Class MissingPaginatedTraitValidator
- java.lang.Object
-
- software.amazon.smithy.model.validation.AbstractValidator
-
- software.amazon.smithy.linters.MissingPaginatedTraitValidator
-
- All Implemented Interfaces:
Validator
public final class MissingPaginatedTraitValidator extends AbstractValidator
Checks if an operation should be paginated but is not.- Skip operations that are paginated
- Emit if an operation verb matches one of the
verbsRequirePagination
values - Emit if an operation input member name matches one of the
inputMembersRequirePagination
values - Emit if an operation output member name matches one of the
outputMembersRequirePagination
values - Skip if the operation has no output
- Emit if the operation verb matches one of the
verbsSuggestPagination
and there's a top-level output member that targets a list.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MissingPaginatedTraitValidator.Config
static class
MissingPaginatedTraitValidator.Provider
-
Field Summary
-
Fields inherited from interface software.amazon.smithy.model.validation.Validator
MODEL_DEPRECATION, MODEL_ERROR
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.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
-
-
-
-
Method Detail
-
validate
public java.util.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.
-
-