Package io.smallrye.openapi.api.util

Class UnusedComponentFilter

java.lang.Object
io.smallrye.openapi.api.util.UnusedComponentFilter
All Implemented Interfaces:
org.eclipse.microprofile.openapi.OASFilter
public class UnusedComponentFilter extends Object implements org.eclipse.microprofile.openapi.OASFilter
An implementation of OASFilter that scans the OpenAPI model and removes any entries in `components` that are not referenced elsewhere in the same model.

  • Constructor Summary

    Constructors
    Constructor
    Description
    UnusedComponentFilter()
    By default, unused components of all types will be removed.
    UnusedComponentFilter(Set<io.smallrye.openapi.model.ReferenceType> filterTypes)
    Only remove unused components of the given types.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.eclipse.microprofile.openapi.models.responses.APIResponse
    filterAPIResponse(org.eclipse.microprofile.openapi.models.responses.APIResponse response)
     
    org.eclipse.microprofile.openapi.models.callbacks.Callback
    filterCallback(org.eclipse.microprofile.openapi.models.callbacks.Callback callback)
     
    org.eclipse.microprofile.openapi.models.headers.Header
    filterHeader(org.eclipse.microprofile.openapi.models.headers.Header header)
     
    org.eclipse.microprofile.openapi.models.links.Link
    filterLink(org.eclipse.microprofile.openapi.models.links.Link link)
     
    void
    filterOpenAPI(org.eclipse.microprofile.openapi.models.OpenAPI openAPI)
     
    org.eclipse.microprofile.openapi.models.Operation
    filterOperation(org.eclipse.microprofile.openapi.models.Operation operation)
     
    org.eclipse.microprofile.openapi.models.parameters.Parameter
    filterParameter(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter)
     
    org.eclipse.microprofile.openapi.models.PathItem
    filterPathItem(org.eclipse.microprofile.openapi.models.PathItem pathItem)
     
    org.eclipse.microprofile.openapi.models.parameters.RequestBody
    filterRequestBody(org.eclipse.microprofile.openapi.models.parameters.RequestBody requestBody)
     
    org.eclipse.microprofile.openapi.models.media.Schema
    filterSchema(org.eclipse.microprofile.openapi.models.media.Schema schema)
     
    org.eclipse.microprofile.openapi.models.security.SecurityScheme
    filterSecurityScheme(org.eclipse.microprofile.openapi.models.security.SecurityScheme securityScheme)
     

    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

    filterServer, filterTag

  • Constructor Details

    • UnusedComponentFilter

      public UnusedComponentFilter()
      By default, unused components of all types will be removed.

    • UnusedComponentFilter

      public UnusedComponentFilter(Set<io.smallrye.openapi.model.ReferenceType> filterTypes)
      Only remove unused components of the given types.

  • Method Details

    • filterCallback

      public org.eclipse.microprofile.openapi.models.callbacks.Callback filterCallback(org.eclipse.microprofile.openapi.models.callbacks.Callback callback)
      Specified by:
      filterCallback in interface org.eclipse.microprofile.openapi.OASFilter

    • filterHeader

      public org.eclipse.microprofile.openapi.models.headers.Header filterHeader(org.eclipse.microprofile.openapi.models.headers.Header header)
      Specified by:
      filterHeader in interface org.eclipse.microprofile.openapi.OASFilter

    • filterLink

      public org.eclipse.microprofile.openapi.models.links.Link filterLink(org.eclipse.microprofile.openapi.models.links.Link link)
      Specified by:
      filterLink in interface org.eclipse.microprofile.openapi.OASFilter

    • filterParameter

      public org.eclipse.microprofile.openapi.models.parameters.Parameter filterParameter(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter)
      Specified by:
      filterParameter in interface org.eclipse.microprofile.openapi.OASFilter

    • 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

    • filterOperation

      public org.eclipse.microprofile.openapi.models.Operation filterOperation(org.eclipse.microprofile.openapi.models.Operation operation)
      Specified by:
      filterOperation in interface org.eclipse.microprofile.openapi.OASFilter

    • filterRequestBody

      public org.eclipse.microprofile.openapi.models.parameters.RequestBody filterRequestBody(org.eclipse.microprofile.openapi.models.parameters.RequestBody requestBody)
      Specified by:
      filterRequestBody in interface org.eclipse.microprofile.openapi.OASFilter

    • filterAPIResponse

      public org.eclipse.microprofile.openapi.models.responses.APIResponse filterAPIResponse(org.eclipse.microprofile.openapi.models.responses.APIResponse response)
      Specified by:
      filterAPIResponse in interface org.eclipse.microprofile.openapi.OASFilter

    • filterSchema

      public org.eclipse.microprofile.openapi.models.media.Schema filterSchema(org.eclipse.microprofile.openapi.models.media.Schema schema)
      Specified by:
      filterSchema in interface org.eclipse.microprofile.openapi.OASFilter

    • filterSecurityScheme

      public org.eclipse.microprofile.openapi.models.security.SecurityScheme filterSecurityScheme(org.eclipse.microprofile.openapi.models.security.SecurityScheme securityScheme)
      Specified by:
      filterSecurityScheme in interface org.eclipse.microprofile.openapi.OASFilter

    • filterOpenAPI

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