Index

A B D G I J M O P S V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

additionalDocsDirectory() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

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

additionalDocsDirectory() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

alwaysRunFilter() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

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

alwaysRunFilter() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

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

apiKeyParameterIn() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Required when using `apiKey` security.

apiKeyParameterIn() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

apiKeyParameterName() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Required when using `apiKey` security.

apiKeyParameterName() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

autoAddBadRequestResponse() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

This will automatically add Bad Request (400 HTTP response) API response to operations with an input.

autoAddBadRequestResponse() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

autoAddOpenApiEndpoint() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

This will automatically add the OpenAPI specification document endpoint to the schema.

autoAddOpenApiEndpoint() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

autoAddOperationSummary() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

This will automatically add a summary to operations based on the Java method name.

autoAddOperationSummary() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

autoAddSecurity() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

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

autoAddSecurity() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

autoAddSecurityRequirement() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

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

autoAddSecurityRequirement() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

autoAddServer() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

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.

autoAddServer() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

autoAddTags() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

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

autoAddTags() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

B

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

basicSecuritySchemeValue() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Add a scheme value to the Basic HTTP Security Scheme

basicSecuritySchemeValue() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

D

DEFAULT_DOCUMENT_NAME - Static variable in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

DEFAULT_PATH - Static variable in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

DEFAULT_STORE_SCHEMA_FILE_NAME - Static variable in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

documents() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

OpenAPI documents

G

getValidSecuritySchemeExtensions() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Get valid security scheme extensions (those starting with "x-")

getValidSecuritySchemeExtensions() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use OpenApiDocumentConfig.getValidSecuritySchemeExtensions() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

getValue(ConfigSourceInterceptorContext, String) - Method in class io.quarkus.smallrye.openapi.common.deployment.OpenApiConfigSourceInterceptor

I

ignoreStaticDocument() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Do not include the provided static openapi document (eg.

ignoreStaticDocument() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

infoContactEmail() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Set the contact email in Info tag in the Schema document

infoContactEmail() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

infoContactName() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Set the contact name in Info tag in the Schema document

infoContactName() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

infoContactUrl() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Set the contact url in Info tag in the Schema document

infoContactUrl() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

infoDescription() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Set the description in Info tag in the Schema document

infoDescription() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

infoLicenseName() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Set the license name in Info tag in the Schema document

infoLicenseName() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

infoLicenseUrl() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Set the license url in Info tag in the Schema document

infoLicenseUrl() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

infoTermsOfService() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

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

infoTermsOfService() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

infoTitle() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Set the title in Info tag in the Schema document

infoTitle() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

infoVersion() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Set the version in Info tag in the Schema document

infoVersion() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

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() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Add a bearer format the JWT Security Scheme

jwtBearerFormat() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

jwtSecuritySchemeValue() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Add a scheme value to the JWT Security Scheme

jwtSecuritySchemeValue() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

M

managementEnabled() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

mergeSchemaExamples() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Set this boolean value to enable or disable the merging of the deprecated `@Schema` `example` property into the `examples` array introduced in OAS 3.1.0.

mergeSchemaExamples() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

O

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

oauth2BearerFormat() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Add a scheme value to OAuth2 opaque token Security Scheme

oauth2BearerFormat() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

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

oauth2ImplicitAuthorizationUrl() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Add an implicit flow authorizationUrl value to the OAuth2 Security Scheme

oauth2ImplicitAuthorizationUrl() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

oauth2ImplicitRefreshUrl() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Add a implicit flow refreshUrl value to the OAuth2 Security Scheme

oauth2ImplicitRefreshUrl() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

oauth2ImplicitTokenUrl() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Add an implicit flow tokenUrl value to the OAuth2 Security Scheme

oauth2ImplicitTokenUrl() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

oauth2SecuritySchemeValue() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Add a scheme value to the OAuth2 opaque token Security Scheme

oauth2SecuritySchemeValue() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

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

oidcOpenIdConnectUrl() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Add a openIdConnectUrl value to the OIDC Security Scheme

oidcOpenIdConnectUrl() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

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

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

OpenApiDocumentConfig - Interface in io.quarkus.smallrye.openapi.common.deployment

Configuration for an individual OpenAPI document

openApiVersion() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Override the openapi version in the Schema document

openApiVersion() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

operationIdStrategy() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Set the strategy to automatically create an operation Id.

operationIdStrategy() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

P

path() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

The path at which to register the OpenAPI Servlet.

path() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

S

scanExcludeProfiles() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Profiles which explicitly exclude operations.

scanProfiles() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Profiles which explicitly include operations.

securityScheme() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Add a certain SecurityScheme with config

securityScheme() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

securitySchemeDescription() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Add a description to the Security Scheme

securitySchemeDescription() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

securitySchemeExtensions() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Add one or more extensions to the security scheme

securitySchemeExtensions() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

securitySchemeName() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

Add a Security Scheme name to the generated OpenAPI document

securitySchemeName() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

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

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

storeSchemaDirectory() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

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

storeSchemaDirectory() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

storeSchemaFileName() - Method in interface io.quarkus.smallrye.openapi.common.deployment.OpenApiDocumentConfig

The name of the file in case it is being stored.

storeSchemaFileName() - Method in interface io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

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

Use SmallRyeOpenApiConfig.documents() with key SmallRyeOpenApiConfig.DEFAULT_DOCUMENT_NAME instead

V

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.SecurityScheme

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

A B D G I J M O P S V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form