OpenApiRuntimeConfig (Quarkus - SmallRye OpenAPI - Runtime 9.9.9-ckronberger API)

@ConfigRoot(phase=RUN_TIME) @ConfigMapping(prefix="quarkus.smallrye-openapi") public interface OpenApiRuntimeConfig

Method Summary

Modifier and Type

Method

Description

@WithUnnamedKey("<default>") Map<String,OpenApiDocumentRuntimeConfig>

documents()

OpenAPI documents

Optional<Boolean>

enable()

Deprecated, for removal: This API element is subject to removal in a future version.
use quarkus.smallrye-openapi.enabled instead

boolean

enabled()

Enable the openapi endpoint.

default Optional<Set<String>>

servers()

Deprecated, for removal: This API element is subject to removal in a future version.
Use documents() with key OpenApiConstants.DEFAULT_DOCUMENT_NAME instead

Method Details
- enabled
  
  @WithDefault("true") boolean enabled()
  
  Enable the openapi endpoint. By default it's enabled.
- enable
  
  @Deprecated(since="3.26", forRemoval=true) Optional<Boolean> enable()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  use quarkus.smallrye-openapi.enabled instead
  
  Enable the openapi endpoint. By default it's enabled.
- servers
  
  @Deprecated(since="3.31", forRemoval=true) default Optional<Set<String>> servers()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Use documents() with key OpenApiConstants.DEFAULT_DOCUMENT_NAME instead
  
  Specify the list of global servers that provide connectivity information
- documents
  
  @WithParentName @WithUnnamedKey("<default>") @WithDefaults @WithUnnamedKey("<default>") Map<String,OpenApiDocumentRuntimeConfig> documents()
  
  OpenAPI documents