Package io.quarkus.smallrye.openapi

Annotation Interface OpenApiFilter

@Retention(RUNTIME) @Target(TYPE) public @interface OpenApiFilter
This extends the MP way to define an `org.eclipse.microprofile.openapi.OASFilter`. Currently in MP, this needs to be added to a config `mp.openapi.filter` and only allows one filter (class) per application. This Annotation, that is Quarkus specific, will allow users to annotate one or more classes and that will be all that is needed to include the filter. (No config needed). Filters still need to extend.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    OpenApiFilter.RunStage
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    int
    priority
    Filter with a higher priority will applied first
    OpenApiFilter.RunStage
    value
     

  • Element Details

    • value

      OpenApiFilter.RunStage value
      Default:
      RUN

    • priority

      int priority
      Filter with a higher priority will applied first
      Returns:
      Default:
      1