Package software.amazon.smithy.linters

Class MissingPaginatedTraitValidator

java.lang.Object
software.amazon.smithy.model.validation.AbstractValidator
software.amazon.smithy.linters.MissingPaginatedTraitValidator
All Implemented Interfaces:
software.amazon.smithy.model.validation.Validator
public final class MissingPaginatedTraitValidator extends software.amazon.smithy.model.validation.AbstractValidator
Checks if an operation should be paginated but is not.
  1. Skip operations that are paginated
  2. Emit if an operation verb matches one of the verbsRequirePagination values
  3. Emit if an operation input member name matches one of the inputMembersRequirePagination values
  4. Emit if an operation output member name matches one of the outputMembersRequirePagination values
  5. Skip if the operation has no output
  6. 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 final class 
    MissingPaginatedTraitValidator.Config
     
    static final class 
    MissingPaginatedTraitValidator.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<software.amazon.smithy.model.validation.ValidationEvent>
    validate(software.amazon.smithy.model.Model model)
     

    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<software.amazon.smithy.model.validation.ValidationEvent> validate(software.amazon.smithy.model.Model model)