A B D F G I L M O P R S T U V W

A

alwaysInclude - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

If this should be included every time.

B

brandingFiles() - Method in class io.quarkus.swaggerui.deployment.SwaggerUiProcessor

D

deepLinking - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

If set to true, enables deep linking for tags and operations.

defaultModelExpandDepth - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

The default expansion depth for the model on the model-example section.

defaultModelRendering - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

Controls how the model is shown when the API is first rendered.

defaultModelsExpandDepth - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

The default expansion depth for models (set to -1 completely hide the models).

displayOperationId - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

Controls the display of operationId in operations list.

displayRequestDuration - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

Controls the display of the request duration (in milliseconds) for "Try it out" requests.

docExpansion - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

Controls the default expansion setting for the operations and tags.

F

feature(BuildProducer<FeatureBuildItem>, LaunchModeBuildItem, SwaggerUiConfig) - Method in class io.quarkus.swaggerui.deployment.SwaggerUiProcessor

filter - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

If set, enables filtering.

footer - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

A footer for the html page.

G

get_alwaysInclude(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_deepLinking(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_defaultModelExpandDepth(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_defaultModelRendering(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_defaultModelsExpandDepth(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_displayOperationId(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_displayRequestDuration(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_docExpansion(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_filter(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_footer(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_layout(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_maxDisplayedTags(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_modelPropertyMacro(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_oauth2RedirectUrl(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_oauthAdditionalQueryStringParams(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_oauthAppName(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_oauthClientId(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_oauthClientSecret(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_oauthRealm(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_oauthScopes(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_oauthScopeSeparator(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_oauthUseBasicAuthenticationWithAccessCodeGrant(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_oauthUsePkceWithAuthorizationCodeGrant(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_onComplete(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_operationsSorter(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_parameterMacro(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_path(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_persistAuthorization(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_plugins(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_preauthorizeApiKeyApiKeyValue(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_preauthorizeApiKeyAuthDefinitionKey(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_preauthorizeBasicAuthDefinitionKey(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_preauthorizeBasicPassword(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_preauthorizeBasicUsername(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_presets(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_requestCurlOptions(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_requestInterceptor(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_responseInterceptor(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_showCommonExtensions(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_showExtensions(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_showMutatedRequest(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_supportedSubmitMethods(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_syntaxHighlight(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_tagsSorter(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_theme(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_title(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_urls(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_urlsPrimaryName(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_validatorUrl(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

get_withCredentials(Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

getSwaggerUiFinalDestination() - Method in class io.quarkus.swaggerui.deployment.SwaggerUiBuildItem

getSwaggerUiFinalDestination(BuildProducer<GeneratedResourceBuildItem>, BuildProducer<NativeImageResourceBuildItem>, BuildProducer<SwaggerUiBuildItem>, NonApplicationRootPathBuildItem, CurateOutcomeBuildItem, LaunchModeBuildItem, SwaggerUiConfig, SmallRyeOpenApiConfig, LiveReloadBuildItem) - Method in class io.quarkus.swaggerui.deployment.SwaggerUiProcessor

getSwaggerUiPath() - Method in class io.quarkus.swaggerui.deployment.SwaggerUiBuildItem

I

io.quarkus.swaggerui.deployment - package io.quarkus.swaggerui.deployment

L

layout - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

The name of a component available via the plugin system to use as the top-level layout for Swagger UI.

M

maxDisplayedTags - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

If set, limits the number of tagged operations displayed to at most this many.

modelPropertyMacro - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

Function to set default values to each property in model.

O

oauth2RedirectUrl - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

OAuth redirect URL.

oauthAdditionalQueryStringParams - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

OAuth additional query parameters added to authorizationUrl and tokenUrl - Used in the initOAuth method.

oauthAppName - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

OAuth application name, displayed in authorization popup - Used in the initOAuth method.

oauthClientId - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

OAuth default clientId - Used in the initOAuth method.

oauthClientSecret - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

OAuth default clientSecret - Used in the initOAuth method.

oauthRealm - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

OAuth1 Realm query parameter added to authorizationUrl and tokenUrl - Used in the initOAuth method.

oauthScopes - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

OAuth Scopes, separated using the oauthScopeSeparator - Used in the initOAuth method.

oauthScopeSeparator - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

OAuth scope separator for passing scopes - Used in the initOAuth method.

oauthUseBasicAuthenticationWithAccessCodeGrant - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

OAuth only activated for the accessCode flow.

oauthUsePkceWithAuthorizationCodeGrant - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

OAuth only applies to authorizatonCode flows.

onComplete - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

Provides a mechanism to be notified when Swagger UI has finished rendering a newly provided definition.

operationsSorter - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

Apply a sort to the operation list of each API.

P

parameterMacro - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

Function to set default value to parameters.

path - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

The path where Swagger UI is available.

persistAuthorization - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

If set to true, it persists authorization data and it would not be lost on browser close/refresh

plugins - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

A list of plugin functions to use in Swagger UI.

preauthorizeApiKeyApiKeyValue - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

Pre-authorize ApiKey Auth, programmatically set ApiKeyValue for an API key or Bearer authorization scheme - Used in the preauthorizeApiKey method.

preauthorizeApiKeyAuthDefinitionKey - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

Pre-authorize ApiKey Auth, programmatically set DefinitionKey for an API key or Bearer authorization scheme - Used in the preauthorizeApiKey method.

preauthorizeBasicAuthDefinitionKey - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

Pre-authorize Basic Auth, programmatically set DefinitionKey for a Basic authorization scheme - Used in the preauthorizeBasic method.

preauthorizeBasicPassword - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

Pre-authorize Basic Auth, programmatically set Password for a Basic authorization scheme - Used in the preauthorizeBasic method.

preauthorizeBasicUsername - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

Pre-authorize Basic Auth, programmatically set Username for a Basic authorization scheme - Used in the preauthorizeBasic method.

presets - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

A list of presets to use in Swagger UI.

R

registerSwaggerUiHandler(SwaggerUiRecorder, BuildProducer<RouteBuildItem>, NonApplicationRootPathBuildItem, SwaggerUiBuildItem, SwaggerUiRuntimeConfig, LaunchModeBuildItem, SwaggerUiConfig) - Method in class io.quarkus.swaggerui.deployment.SwaggerUiProcessor

requestCurlOptions - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

If set, MUST be an array of command line options available to the curl command.

requestInterceptor - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

MUST be a function.

responseInterceptor - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

MUST be a function.

S

set_alwaysInclude(Object, boolean) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_deepLinking(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_defaultModelExpandDepth(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_defaultModelRendering(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_defaultModelsExpandDepth(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_displayOperationId(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_displayRequestDuration(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_docExpansion(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_filter(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_footer(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_layout(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_maxDisplayedTags(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_modelPropertyMacro(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_oauth2RedirectUrl(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_oauthAdditionalQueryStringParams(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_oauthAppName(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_oauthClientId(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_oauthClientSecret(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_oauthRealm(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_oauthScopes(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_oauthScopeSeparator(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_oauthUseBasicAuthenticationWithAccessCodeGrant(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_oauthUsePkceWithAuthorizationCodeGrant(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_onComplete(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_operationsSorter(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_parameterMacro(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_path(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_persistAuthorization(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_plugins(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_preauthorizeApiKeyApiKeyValue(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_preauthorizeApiKeyAuthDefinitionKey(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_preauthorizeBasicAuthDefinitionKey(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_preauthorizeBasicPassword(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_preauthorizeBasicUsername(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_presets(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_requestCurlOptions(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_requestInterceptor(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_responseInterceptor(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_showCommonExtensions(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_showExtensions(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_showMutatedRequest(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_supportedSubmitMethods(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_syntaxHighlight(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_tagsSorter(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_theme(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_title(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_urls(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_urlsPrimaryName(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_validatorUrl(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

set_withCredentials(Object, Object) - Static method in class io.quarkus.swaggerui.deployment.SwaggerUiConfig$$accessor

showCommonExtensions - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

Controls the display of extensions (pattern, maxLength, minLength, maximum, minimum) fields and values for Parameters.

showExtensions - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

Controls the display of vendor extension (x-) fields and values for Operations, Parameters, and Schema.

showMutatedRequest - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

If set to true, uses the mutated request returned from a requestInterceptor to produce the curl command in the UI, otherwise the request before the requestInterceptor was applied is used.

supportedSubmitMethods - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

List of HTTP methods that have the "Try it out" feature enabled.

SwaggerUiBuildItem - Class in io.quarkus.swaggerui.deployment

SwaggerUiBuildItem(String, String) - Constructor for class io.quarkus.swaggerui.deployment.SwaggerUiBuildItem

SwaggerUiConfig - Class in io.quarkus.swaggerui.deployment

SwaggerUiConfig() - Constructor for class io.quarkus.swaggerui.deployment.SwaggerUiConfig

SwaggerUiConfig$$accessor - Class in io.quarkus.swaggerui.deployment

SwaggerUiProcessor - Class in io.quarkus.swaggerui.deployment

SwaggerUiProcessor() - Constructor for class io.quarkus.swaggerui.deployment.SwaggerUiProcessor

syntaxHighlight - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

Set to false to deactivate syntax highlighting of payloads and cURL command, can be otherwise an object with the activate and theme properties.

T

tagsSorter - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

Apply a sort to the tag list of each API.

theme - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

Swagger UI theme to be used.

title - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

The html title for the page.

U

urls - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

The urls that will be included as options.

urlsPrimaryName - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

If urls option is used, this will be the name of the default selection.

V

validatorUrl - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

By default, Swagger UI attempts to validate specs against swagger.io's online validator.

W

withCredentials - Variable in class io.quarkus.swaggerui.deployment.SwaggerUiConfig

If set to true, enables passing credentials, as defined in the Fetch standard, in CORS requests that are sent by the browser.

A B D F G I L M O P R S T U V W