Package io.quarkus.smallrye.openapi.runtime.filter

Class DisabledRestEndpointsFilter

java.lang.Object

io.quarkus.smallrye.openapi.runtime.filter.DisabledRestEndpointsFilter

All Implemented Interfaces:

org.eclipse.microprofile.openapi.OASFilter

public class DisabledRestEndpointsFilter
extends Object
implements org.eclipse.microprofile.openapi.OASFilter

If the RESTEasy Reactive extension passed us a list of REST paths that are disabled via the @DisabledRestEndpoint annotation, remove them from the OpenAPI document. This has to be done at runtime because the annotation is controlled by a runtime config property.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final Map<String,List<String>>	disabledEndpoints

Method Summary

Modifier and Type	Method	Description
void	filterOpenAPI(org.eclipse.microprofile.openapi.models.OpenAPI openAPI)
static Optional<org.eclipse.microprofile.openapi.OASFilter>	maybeGetInstance()
(package private) static String	stripSlash(String path)	Removes any trailing slash character from the path when it is not the root '/' path.

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

disabledEndpoints

final Map<String,List<String>> disabledEndpoints

Method Details

maybeGetInstance

public static Optional<org.eclipse.microprofile.openapi.OASFilter> maybeGetInstance()

filterOpenAPI

public void filterOpenAPI(org.eclipse.microprofile.openapi.models.OpenAPI openAPI)

Specified by:

filterOpenAPI in interface org.eclipse.microprofile.openapi.OASFilter

stripSlash

static String stripSlash(String path)

Removes any trailing slash character from the path when it is not the root '/' path. This is necessary to align with the paths generated in the OpenAPI model.