io.quarkus.smallrye.openapi.common.deployment

Class SmallRyeOpenApiConfig

java.lang.Object

io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig

@ConfigRoot(name="smallrye-openapi")
public final class SmallRyeOpenApiConfig
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SmallRyeOpenApiConfig.SecurityScheme

Field Summary

Fields

Modifier and Type	Field and Description
String	basicSecuritySchemeValue Add a scheme value to the Basic HTTP Security Scheme
String	jwtBearerFormat Add a scheme value to the JWT Security Scheme
String	jwtSecuritySchemeValue Add a scheme value to the JWT Security Scheme
Optional<String>	oauth2ImplicitAuthorizationUrl Add an implicit flow authorizationUrl value to the OAuth2 Security Scheme
Optional<String>	oauth2ImplicitRefreshUrl Add a implicit flow refreshUrl value to the OAuth2 Security Scheme
Optional<String>	oauth2ImplicitTokenUrl Add an implicit flow tokenUrl value to the OAuth2 Security Scheme
Optional<String>	oidcOpenIdConnectUrl Add a openIdConnectUrl value to the OIDC Security Scheme
String	path The path at which to register the OpenAPI Servlet.
Optional<SmallRyeOpenApiConfig.SecurityScheme>	securityScheme Add a certain SecurityScheme with config
String	securitySchemeDescription Add a description to the Security Scheme
String	securitySchemeName Add a Security Scheme name to the generated OpenAPI document
Optional<Path>	storeSchemaDirectory If set, the generated OpenAPI schema documents will be stored here on build.

Constructor Summary

Constructors

Constructor and Description
SmallRyeOpenApiConfig()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

path

@ConfigItem(defaultValue="openapi")
public String path

The path at which to register the OpenAPI Servlet.

storeSchemaDirectory

@ConfigItem
public Optional<Path> storeSchemaDirectory

If set, the generated OpenAPI schema documents will be stored here on build. Both openapi.json and openapi.yaml will be stored here if this is set.

securityScheme

public Optional<SmallRyeOpenApiConfig.SecurityScheme> securityScheme

Add a certain SecurityScheme with config

securitySchemeName

@ConfigItem(defaultValue="SecurityScheme")
public String securitySchemeName

Add a Security Scheme name to the generated OpenAPI document

securitySchemeDescription

@ConfigItem(defaultValue="Authentication")
public String securitySchemeDescription

Add a description to the Security Scheme

basicSecuritySchemeValue

@ConfigItem(defaultValue="basic")
public String basicSecuritySchemeValue

Add a scheme value to the Basic HTTP Security Scheme

jwtSecuritySchemeValue

@ConfigItem(defaultValue="bearer")
public String jwtSecuritySchemeValue

Add a scheme value to the JWT Security Scheme

jwtBearerFormat

@ConfigItem(defaultValue="JWT")
public String jwtBearerFormat

Add a scheme value to the JWT Security Scheme

oidcOpenIdConnectUrl

@ConfigItem
public Optional<String> oidcOpenIdConnectUrl

Add a openIdConnectUrl value to the OIDC Security Scheme

oauth2ImplicitRefreshUrl

@ConfigItem
public Optional<String> oauth2ImplicitRefreshUrl

Add a implicit flow refreshUrl value to the OAuth2 Security Scheme

oauth2ImplicitAuthorizationUrl

@ConfigItem
public Optional<String> oauth2ImplicitAuthorizationUrl

Add an implicit flow authorizationUrl value to the OAuth2 Security Scheme

oauth2ImplicitTokenUrl

@ConfigItem
public Optional<String> oauth2ImplicitTokenUrl

Add an implicit flow tokenUrl value to the OAuth2 Security Scheme

Constructor Detail

SmallRyeOpenApiConfig

public SmallRyeOpenApiConfig()