Index

A B C G I J M O P S V
All Classes and Interfaces|All Packages

A

additionalDocsDirectory - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

A list of local directories that should be scanned for yaml and/or json files to be included in the static model.

alwaysRunFilter - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Do not run the filter only at startup, but every time the document is requested (dynamic).

apiKey - Enum constant in enum class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig.SecurityScheme

apiKeyParameterIn - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Required when using `apiKey` security.

apiKeyParameterName - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Required when using `apiKey` security.

autoAddSecurity - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

This will automatically add security based on the security extension included (if any).

autoAddSecurityRequirement - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

This will automatically add the security requirement to all methods/classes that has a `RolesAllowed` annotation.

autoAddServer - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Setting it to `true` will automatically add a default server to the schema if none is provided, using the current running server host and port.

autoAddTags - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

This will automatically add tags to operations based on the Java class name.

B

basic - Enum constant in enum class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig.SecurityScheme

basicSecuritySchemeValue - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Add a scheme value to the Basic HTTP Security Scheme

C

CLASS_METHOD - Enum constant in enum class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig.OperationIdStrategy

G

getValidSecuritySchemeExtentions() - Method in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

I

ignoreStaticDocument - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Do not include the provided static openapi document (eg.

infoContactEmail - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Set the contact email in Info tag in the Schema document

infoContactName - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Set the contact name in Info tag in the Schema document

infoContactUrl - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Set the contact url in Info tag in the Schema document

infoDescription - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Set the description in Info tag in the Schema document

infoLicenseName - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Set the license name in Info tag in the Schema document

infoLicenseUrl - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Set the license url in Info tag in the Schema document

infoTermsOfService - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Set the terms of the service in Info tag in the Schema document

infoTitle - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Set the title in Info tag in the Schema document

infoVersion - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Set the version in Info tag in the Schema document

io.quarkus.smallrye.openapi.common.deployment - package io.quarkus.smallrye.openapi.common.deployment

J

jwt - Enum constant in enum class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig.SecurityScheme

jwtBearerFormat - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Add a bearer format the JWT Security Scheme

jwtSecuritySchemeValue - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Add a scheme value to the JWT Security Scheme

M

managementEnabled - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

If management interface is turned on the openapi schema document will be published under the management interface.

METHOD - Enum constant in enum class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig.OperationIdStrategy

O

oauth2 - Enum constant in enum class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig.SecurityScheme

oauth2BearerFormat - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Add a scheme value to OAuth2 opaque token Security Scheme

oauth2Implicit - Enum constant in enum class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig.SecurityScheme

oauth2ImplicitAuthorizationUrl - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Add an implicit flow authorizationUrl value to the OAuth2 Security Scheme

oauth2ImplicitRefreshUrl - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Add a implicit flow refreshUrl value to the OAuth2 Security Scheme

oauth2ImplicitTokenUrl - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Add an implicit flow tokenUrl value to the OAuth2 Security Scheme

oauth2SecuritySchemeValue - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Add a scheme value to the OAuth2 opaque token Security Scheme

oidc - Enum constant in enum class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig.SecurityScheme

oidcOpenIdConnectUrl - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Add a openIdConnectUrl value to the OIDC Security Scheme

openApiVersion - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Override the openapi version in the Schema document

operationIdStrategy - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Set the strategy to automatically create an operation Id

P

PACKAGE_CLASS_METHOD - Enum constant in enum class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig.OperationIdStrategy

path - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

The path at which to register the OpenAPI Servlet.

S

securityScheme - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Add a certain SecurityScheme with config

securitySchemeDescription - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Add a description to the Security Scheme

securitySchemeExtensions - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Add one or more extensions to the security scheme

securitySchemeName - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

Add a Security Scheme name to the generated OpenAPI document

SmallRyeOpenApiConfig - Class in io.quarkus.smallrye.openapi.common.deployment

SmallRyeOpenApiConfig() - Constructor for class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

SmallRyeOpenApiConfig.OperationIdStrategy - Enum Class in io.quarkus.smallrye.openapi.common.deployment

SmallRyeOpenApiConfig.SecurityScheme - Enum Class in io.quarkus.smallrye.openapi.common.deployment

storeSchemaDirectory - Variable in class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

If set, the generated OpenAPI schema documents will be stored here on build.

V

valueOf(String) - Static method in enum class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig.OperationIdStrategy

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

valueOf(String) - Static method in enum class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig.SecurityScheme

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

values() - Static method in enum class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig.OperationIdStrategy

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

values() - Static method in enum class io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig.SecurityScheme

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

A B C G I J M O P S V
All Classes and Interfaces|All Packages