Package io.quarkus.smallrye.openapi.deployment.filter

Class OperationFilter

java.lang.Object
io.quarkus.smallrye.openapi.deployment.filter.OperationFilter
All Implemented Interfaces:
org.eclipse.microprofile.openapi.OASFilter
public class OperationFilter extends Object implements org.eclipse.microprofile.openapi.OASFilter
This filter replaces the former AutoTagFilter and AutoRolesAllowedFilter and has three functions:
  • Add operation descriptions based on the associated Java method name handling the operation
  • Add operation tags based on the associated Java class of the operation
  • Add security requirements based on discovered RolesAllowed, PermissionsAllowed, and Authenticated annotations.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    EXT_METHOD_REF
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    OperationFilter(Map<String,ClassAndMethod> classNameMap, Map<String,List<String>> rolesAllowedMethodReferences, List<String> authenticatedMethodReferences, String defaultSecuritySchemeName, boolean doAutoTag, boolean doAutoOperation, boolean alwaysIncludeScopesValidForScheme)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    filterOpenAPI(org.eclipse.microprofile.openapi.models.OpenAPI openAPI)
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.eclipse.microprofile.openapi.OASFilter

    filterAPIResponse, filterCallback, filterHeader, filterLink, filterOperation, filterParameter, filterPathItem, filterRequestBody, filterSchema, filterSecurityScheme, filterServer, filterTag

  • Field Details

  • Constructor Details

    • OperationFilter

      public OperationFilter(Map<String,ClassAndMethod> classNameMap, Map<String,List<String>> rolesAllowedMethodReferences, List<String> authenticatedMethodReferences, String defaultSecuritySchemeName, boolean doAutoTag, boolean doAutoOperation, boolean alwaysIncludeScopesValidForScheme)

  • Method Details

    • filterOpenAPI

      public void filterOpenAPI(org.eclipse.microprofile.openapi.models.OpenAPI openAPI)
      Specified by:
      filterOpenAPI in interface org.eclipse.microprofile.openapi.OASFilter