Package io.smallrye.openapi.runtime.util

Class ProfileFilter

java.lang.Object
io.smallrye.openapi.runtime.util.ProfileFilter
All Implemented Interfaces:
org.eclipse.microprofile.openapi.OASFilter
public class ProfileFilter extends Object implements org.eclipse.microprofile.openapi.OASFilter
Not intended for use outside of smallrye-open-api. Interface and functionality may not be stable for general use. Removes operations and path items from the model if they are not included based on configuration. Note that path items will be removed if all operations have been removed by the filter and if the path item is not specified in the OpenAPI components section.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ProfileFilter(org.eclipse.microprofile.openapi.models.OpenAPI model, OpenApiConfig config)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.eclipse.microprofile.openapi.models.PathItem
    filterPathItem(org.eclipse.microprofile.openapi.models.PathItem pathItem)
     

    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, filterOpenAPI, filterOperation, filterParameter, filterRequestBody, filterSchema, filterSecurityScheme, filterServer, filterTag

  • Constructor Details

    • ProfileFilter

      public ProfileFilter(org.eclipse.microprofile.openapi.models.OpenAPI model, OpenApiConfig config)

  • Method Details

    • filterPathItem

      public org.eclipse.microprofile.openapi.models.PathItem filterPathItem(org.eclipse.microprofile.openapi.models.PathItem pathItem)
      Specified by:
      filterPathItem in interface org.eclipse.microprofile.openapi.OASFilter