Index

A B C D E F G H I M O P R S U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AutoBasicSecurityFilter - Class in io.quarkus.smallrye.openapi.runtime.filter

Add Basic Authentication security automatically based on the added security extensions

AutoBasicSecurityFilter() - Constructor for class io.quarkus.smallrye.openapi.runtime.filter.AutoBasicSecurityFilter

AutoBasicSecurityFilter(String, String, Map<String, String>, String) - Constructor for class io.quarkus.smallrye.openapi.runtime.filter.AutoBasicSecurityFilter

AutoBearerTokenSecurityFilter - Class in io.quarkus.smallrye.openapi.runtime.filter

Add JWT Authentication security automatically based on the added security extensions

AutoBearerTokenSecurityFilter() - Constructor for class io.quarkus.smallrye.openapi.runtime.filter.AutoBearerTokenSecurityFilter

AutoBearerTokenSecurityFilter(String, String, Map<String, String>, String, String) - Constructor for class io.quarkus.smallrye.openapi.runtime.filter.AutoBearerTokenSecurityFilter

AutoSecurityFilter - Class in io.quarkus.smallrye.openapi.runtime.filter

Auto add security

AutoSecurityFilter() - Constructor for class io.quarkus.smallrye.openapi.runtime.filter.AutoSecurityFilter

AutoSecurityFilter(String, String, Map<String, String>) - Constructor for class io.quarkus.smallrye.openapi.runtime.filter.AutoSecurityFilter

AutoUrl - Class in io.quarkus.smallrye.openapi.runtime.filter

Create a URL from a config, or a default value

AutoUrl() - Constructor for class io.quarkus.smallrye.openapi.runtime.filter.AutoUrl

AutoUrl(String, String, String) - Constructor for class io.quarkus.smallrye.openapi.runtime.filter.AutoUrl

B

BASE_NAME - Static variable in class io.quarkus.smallrye.openapi.runtime.OpenApiConstants

BOTH - Enum constant in enum class io.quarkus.smallrye.openapi.OpenApiFilter.RunStage

build(boolean) - Method in class io.quarkus.smallrye.openapi.runtime.OpenAPIRuntimeBuilder

BUILD - Enum constant in enum class io.quarkus.smallrye.openapi.OpenApiFilter.RunStage

C

classLoader - Static variable in class io.quarkus.smallrye.openapi.runtime.OpenApiConstants

config - Variable in class io.quarkus.smallrye.openapi.runtime.OpenApiDocumentService

corsFilter(Filter) - Method in class io.quarkus.smallrye.openapi.runtime.OpenApiRecorder

D

DEFAULT_DOCUMENT_NAME - Static variable in annotation interface io.quarkus.smallrye.openapi.OpenApiFilter

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

DEFAULT_DOCUMENT_NAME - Static variable in class io.quarkus.smallrye.openapi.runtime.OpenApiConstants

DelegatingConfigInterceptor(Config) - Constructor for class io.quarkus.smallrye.openapi.runtime.OpenApiConfigHelper.DelegatingConfigInterceptor

disabledEndpoints - Variable in class io.quarkus.smallrye.openapi.runtime.filter.DisabledRestEndpointsFilter

DisabledRestEndpointsFilter - Class in io.quarkus.smallrye.openapi.runtime.filter

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.

documentNames() - Element in annotation interface io.quarkus.smallrye.openapi.OpenApiFilter

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

documents() - Method in interface io.quarkus.smallrye.openapi.runtime.OpenApiRuntimeConfig

OpenAPI documents

DynamicDocument(OpenAPI, ClassLoader, Config, Consumer<SmallRyeOpenAPI.Builder>) - Constructor for class io.quarkus.smallrye.openapi.runtime.OpenApiDocumentService.DynamicDocument

E

EMPTY - Static variable in class io.quarkus.smallrye.openapi.runtime.OpenApiDocumentService.EmptyDocument

EmptyDocument() - Constructor for class io.quarkus.smallrye.openapi.runtime.OpenApiDocumentService.EmptyDocument

enable() - Method in interface io.quarkus.smallrye.openapi.runtime.OpenApiRuntimeConfig

Deprecated, for removal: This API element is subject to removal in a future version.

use quarkus.smallrye-openapi.enabled instead

enabled() - Method in interface io.quarkus.smallrye.openapi.runtime.OpenApiRuntimeConfig

Enable the openapi endpoint.

F

FILTER_RUN_FOR_ANY_DOCUMENT - Static variable in annotation interface io.quarkus.smallrye.openapi.OpenApiFilter

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

filterOpenAPI(OpenAPI) - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoSecurityFilter

filterOpenAPI(OpenAPI) - Method in class io.quarkus.smallrye.openapi.runtime.filter.DisabledRestEndpointsFilter

G

GENERATED_DOC_BASE - Static variable in class io.quarkus.smallrye.openapi.runtime.OpenApiConstants

getBasicSecuritySchemeValue() - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoBasicSecurityFilter

getBearerFormat() - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoBearerTokenSecurityFilter

getConfigKey() - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoUrl

getDefaultValue() - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoUrl

getDocument(String, Format) - Method in class io.quarkus.smallrye.openapi.runtime.OpenApiDocumentService

getFinalUrlValue() - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoUrl

getInterceptor(ConfigSourceInterceptorContext) - Method in class io.quarkus.smallrye.openapi.runtime.OpenApiConfigHelper.DelegatingConfigInterceptor

getJsonDocument() - Method in interface io.quarkus.smallrye.openapi.runtime.OpenApiDocumentHolder

getJsonDocument() - Method in class io.quarkus.smallrye.openapi.runtime.OpenApiDocumentService.DynamicDocument

getJsonDocument() - Method in class io.quarkus.smallrye.openapi.runtime.OpenApiDocumentService.EmptyDocument

getJsonDocument() - Method in class io.quarkus.smallrye.openapi.runtime.OpenApiDocumentService.StaticDocument

getOpenIdConnectUrl() - Method in class io.quarkus.smallrye.openapi.runtime.filter.OpenIDConnectSecurityFilter

getPath() - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoUrl

getPriority() - Method in class io.quarkus.smallrye.openapi.runtime.OpenApiConfigHelper.DelegatingConfigInterceptor

getSecuritySchemeDescription() - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoSecurityFilter

getSecuritySchemeExtensions() - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoSecurityFilter

getSecuritySchemeName() - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoSecurityFilter

getSecuritySchemeValue() - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoBearerTokenSecurityFilter

getUrl(String, String, String) - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoSecurityFilter

getValue(ConfigSourceInterceptorContext, String) - Method in class io.quarkus.smallrye.openapi.runtime.OpenApiConfigMapping

getYamlDocument() - Method in interface io.quarkus.smallrye.openapi.runtime.OpenApiDocumentHolder

getYamlDocument() - Method in class io.quarkus.smallrye.openapi.runtime.OpenApiDocumentService.DynamicDocument

getYamlDocument() - Method in class io.quarkus.smallrye.openapi.runtime.OpenApiDocumentService.EmptyDocument

getYamlDocument() - Method in class io.quarkus.smallrye.openapi.runtime.OpenApiDocumentService.StaticDocument

H

handle(RoutingContext) - Method in class io.quarkus.smallrye.openapi.runtime.OpenApiHandler

handle(RoutingContext) - Method in class io.quarkus.smallrye.openapi.runtime.OpenApiNotFoundHandler

handler(String, boolean) - Method in class io.quarkus.smallrye.openapi.runtime.OpenApiRecorder

I

io.quarkus.smallrye.openapi - package io.quarkus.smallrye.openapi

io.quarkus.smallrye.openapi.runtime - package io.quarkus.smallrye.openapi.runtime

io.quarkus.smallrye.openapi.runtime.filter - package io.quarkus.smallrye.openapi.runtime.filter

M

maybeGetInstance() - Static method in class io.quarkus.smallrye.openapi.runtime.filter.DisabledRestEndpointsFilter

O

OpenApiConfigHelper - Class in io.quarkus.smallrye.openapi.runtime

OpenApiConfigHelper() - Constructor for class io.quarkus.smallrye.openapi.runtime.OpenApiConfigHelper

OpenApiConfigHelper.DelegatingConfigInterceptor - Class in io.quarkus.smallrye.openapi.runtime

OpenApiConfigMapping - Class in io.quarkus.smallrye.openapi.runtime

Maps config from MicroProfile and SmallRye to Quarkus

OpenApiConfigMapping() - Constructor for class io.quarkus.smallrye.openapi.runtime.OpenApiConfigMapping

OpenApiConfigMapping(String) - Constructor for class io.quarkus.smallrye.openapi.runtime.OpenApiConfigMapping

OpenApiConstants - Class in io.quarkus.smallrye.openapi.runtime

OpenApiDocumentHolder - Interface in io.quarkus.smallrye.openapi.runtime

Holds instances of the OpenAPI Document

OpenApiDocumentRuntimeConfig - Interface in io.quarkus.smallrye.openapi.runtime

OpenApiDocumentService - Class in io.quarkus.smallrye.openapi.runtime

Loads the document and make it available

OpenApiDocumentService() - Constructor for class io.quarkus.smallrye.openapi.runtime.OpenApiDocumentService

OpenApiDocumentService.DynamicDocument - Class in io.quarkus.smallrye.openapi.runtime

Generate the document on every request by re-running user-provided OASFilters.

OpenApiDocumentService.EmptyDocument - Class in io.quarkus.smallrye.openapi.runtime

OpenApiDocumentService.StaticDocument - Class in io.quarkus.smallrye.openapi.runtime

Generate the document once on creation.

OpenApiFilter - Annotation Interface in io.quarkus.smallrye.openapi

This extends the MP way to define an `org.eclipse.microprofile.openapi.OASFilter`.

OpenApiFilter.RunStage - Enum Class in io.quarkus.smallrye.openapi

OpenApiHandler - Class in io.quarkus.smallrye.openapi.runtime

Handler that serve the OpenAPI document in either json or yaml format

OpenApiHandler(String, boolean) - Constructor for class io.quarkus.smallrye.openapi.runtime.OpenApiHandler

OpenApiNotFoundHandler - Class in io.quarkus.smallrye.openapi.runtime

Handling not found when disabled

OpenApiNotFoundHandler() - Constructor for class io.quarkus.smallrye.openapi.runtime.OpenApiNotFoundHandler

OpenApiRecorder - Class in io.quarkus.smallrye.openapi.runtime

OpenApiRecorder(RuntimeValue<OpenApiRuntimeConfig>, RuntimeValue<VertxHttpConfig>) - Constructor for class io.quarkus.smallrye.openapi.runtime.OpenApiRecorder

OpenAPIRuntimeBuilder - Class in io.quarkus.smallrye.openapi.runtime

Customized SmallRyeOpenAPI.Builder implementation that only includes functionality that should occur at application runtime.

OpenAPIRuntimeBuilder() - Constructor for class io.quarkus.smallrye.openapi.runtime.OpenAPIRuntimeBuilder

OpenApiRuntimeConfig - Interface in io.quarkus.smallrye.openapi.runtime

OpenIDConnectSecurityFilter - Class in io.quarkus.smallrye.openapi.runtime.filter

Add OAuth 2 (Implicit) Authentication security automatically based on the added security extensions

OpenIDConnectSecurityFilter() - Constructor for class io.quarkus.smallrye.openapi.runtime.filter.OpenIDConnectSecurityFilter

OpenIDConnectSecurityFilter(String, String, Map<String, String>, AutoUrl) - Constructor for class io.quarkus.smallrye.openapi.runtime.filter.OpenIDConnectSecurityFilter

P

prepareDocument(AutoSecurityFilter, List<String>, String) - Method in class io.quarkus.smallrye.openapi.runtime.OpenApiDocumentService

prepareDocument(AutoSecurityFilter, List<String>, String) - Method in class io.quarkus.smallrye.openapi.runtime.OpenApiRecorder

priority() - Element in annotation interface io.quarkus.smallrye.openapi.OpenApiFilter

Filter with a higher priority will be applied first

R

RUN - Enum constant in enum class io.quarkus.smallrye.openapi.OpenApiFilter.RunStage

runtimeRequired() - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoSecurityFilter

runtimeRequired() - Method in class io.quarkus.smallrye.openapi.runtime.filter.OpenIDConnectSecurityFilter

S

servers() - Method in interface io.quarkus.smallrye.openapi.runtime.OpenApiDocumentRuntimeConfig

Specify the list of servers that provide connectivity information

servers() - Method in interface io.quarkus.smallrye.openapi.runtime.OpenApiRuntimeConfig

Deprecated, for removal: This API element is subject to removal in a future version.

Use OpenApiRuntimeConfig.documents() with key OpenApiConstants.DEFAULT_DOCUMENT_NAME instead

setBasicSecuritySchemeValue(String) - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoBasicSecurityFilter

setBearerFormat(String) - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoBearerTokenSecurityFilter

setConfigKey(String) - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoUrl

setDefaultValue(String) - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoUrl

setOpenIdConnectUrl(AutoUrl) - Method in class io.quarkus.smallrye.openapi.runtime.filter.OpenIDConnectSecurityFilter

setPath(String) - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoUrl

setSecuritySchemeDescription(String) - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoSecurityFilter

setSecuritySchemeExtensions(Map<String, String>) - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoSecurityFilter

setSecuritySchemeName(String) - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoSecurityFilter

setSecuritySchemeValue(String) - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoBearerTokenSecurityFilter

setupClDevMode(ShutdownContext) - Method in class io.quarkus.smallrye.openapi.runtime.OpenApiRecorder

StaticDocument(SmallRyeOpenAPI) - Constructor for class io.quarkus.smallrye.openapi.runtime.OpenApiDocumentService.StaticDocument

stripSlash(String) - Static method in class io.quarkus.smallrye.openapi.runtime.filter.DisabledRestEndpointsFilter

Removes any trailing slash character from the path when it is not the root '/' path.

U

updateSecurityScheme(SecurityScheme) - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoBasicSecurityFilter

updateSecurityScheme(SecurityScheme) - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoBearerTokenSecurityFilter

updateSecurityScheme(SecurityScheme) - Method in class io.quarkus.smallrye.openapi.runtime.filter.AutoSecurityFilter

updateSecurityScheme(SecurityScheme) - Method in class io.quarkus.smallrye.openapi.runtime.filter.OpenIDConnectSecurityFilter

V

value() - Element in annotation interface io.quarkus.smallrye.openapi.OpenApiFilter

valueOf(String) - Static method in enum class io.quarkus.smallrye.openapi.OpenApiFilter.RunStage

Returns the enum constant of this class with the specified name.

values() - Static method in enum class io.quarkus.smallrye.openapi.OpenApiFilter.RunStage

Returns an array containing the constants of this enum class, in the order they are declared.

W

wrap(Config, String) - Static method in class io.quarkus.smallrye.openapi.runtime.OpenApiConfigHelper

A B C D E F G H I M O P R S U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form