Index

A B D F G I L M O P Q R S T U V W
All Classes and Interfaces|All Packages

A

alwaysInclude() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

If this should be included every time.

B

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

D

deepLinking() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

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

defaultModelExpandDepth() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

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

defaultModelRendering() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

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

defaultModelsExpandDepth() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

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

displayOperationId() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

Controls the display of operationId in operations list.

displayRequestDuration() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

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

docExpansion() - Method in interface 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() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

If set, enables filtering.

footer() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

A footer for the html page.

G

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

getSwaggerUiFinalDestination(NonApplicationRootPathBuildItem, LaunchModeBuildItem, SwaggerUiConfig, SmallRyeOpenApiConfig, Optional<DevServicesLauncherConfigResultBuildItem>, BuildProducer<WebJarBuildItem>) - 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() - Method in interface 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() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

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

modelPropertyMacro() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

Function to set default values to each property in model.

O

oauth2RedirectUrl() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

OAuth redirect URL.

oauthAdditionalQueryStringParams() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

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

oauthAppName() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

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

oauthClientId() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

OAuth default clientId - Used in the initOAuth method.

oauthClientSecret() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

OAuth default clientSecret - Used in the initOAuth method.

oauthRealm() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

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

oauthScopes() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

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

oauthScopeSeparator() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

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

oauthUseBasicAuthenticationWithAccessCodeGrant() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

OAuth only activated for the accessCode flow.

oauthUsePkceWithAuthorizationCodeGrant() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

OAuth only applies to authorization code flows.

onComplete() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

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

operationsSorter() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

Apply a sort to the operation list of each API.

P

parameterMacro() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

Function to set default value to parameters.

path() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

The path where Swagger UI is available.

persistAuthorization() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

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

plugins() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

A list of plugin functions to use in Swagger UI.

preauthorizeApiKeyApiKeyValue() - Method in interface 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() - Method in interface 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() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

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

preauthorizeBasicPassword() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

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

preauthorizeBasicUsername() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

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

presets() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

A list of presets to use in Swagger UI.

Q

queryConfigEnabled() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

If set to true, this allows the user to modify and test different query parameters in the API request

R

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

requestCurlOptions() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

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

requestInterceptor() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

MUST be a function.

responseInterceptor() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

MUST be a function.

S

scripts() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

A list of external scripts (usually plugins) to use in Swagger UI.

showCommonExtensions() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

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

showExtensions() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

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

showMutatedRequest() - Method in interface 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() - Method in interface 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 - Interface in io.quarkus.swaggerui.deployment

SwaggerUiProcessor - Class in io.quarkus.swaggerui.deployment

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

syntaxHighlight() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

Set to false to deactivate syntax highlighting of payloads and cURL command.

T

tagsSorter() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

Apply a sort to the tag list of each API.

theme() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

Swagger UI theme to be used.

title() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

The html title for the page.

tryItOutEnabled() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

If try it out should be enabled by default

U

urls() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

The urls that will be included as options.

urlsPrimaryName() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

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

V

validatorUrl() - Method in interface io.quarkus.swaggerui.deployment.SwaggerUiConfig

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

W

withCredentials() - Method in interface 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 Q R S T U V W
All Classes and Interfaces|All Packages