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
String[]	documentNames	Names of the OpenAPI document configurations this filter should be applicable for
int	priority	Filter with a higher priority will be applied first
OpenApiFilter.RunStage	value

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_DOCUMENT_NAME	Default document name which is used for the unnamed default document configuration.
static final String	FILTER_RUN_FOR_ANY_DOCUMENT	Marker to indicate that a filter should run for any document name.

Field Details

DEFAULT_DOCUMENT_NAME

static final String DEFAULT_DOCUMENT_NAME

Default document name which is used for the unnamed default document configuration.

See Also:

• Constant Field Values

FILTER_RUN_FOR_ANY_DOCUMENT

static final String FILTER_RUN_FOR_ANY_DOCUMENT

Marker to indicate that a filter should run for any document name.

See Also:

• Constant Field Values

Element Details

value

OpenApiFilter.RunStage value

Default:

RUN

priority

int priority

Filter with a higher priority will be applied first

Returns:

Default:

1

documentNames

String[] documentNames

Names of the OpenAPI document configurations this filter should be applicable for

Returns:

Default:

{"<ALL>"}