Package io.smallrye.openapi.api

Interface OpenApiConfig

  • All Known Implementing Classes:
    OpenApiConfigImpl
    public interface OpenApiConfig
    Accessor to OpenAPI configuration options. Reference: https://github.com/eclipse/microprofile-open-api/blob/master/spec/src/main/asciidoc/microprofile-openapi-spec.adoc#31-list-of-configurable-items
    Author:
    [email protected]

    • Method Detail

      • modelReader

        default String modelReader()

      • filter

        default String filter()

      • scanDisable

        default boolean scanDisable()

      • scanPackages

        default Pattern scanPackages()

      • scanClasses

        default Pattern scanClasses()

      • scanExcludePackages

        default Pattern scanExcludePackages()

      • scanExcludeClasses

        default Pattern scanExcludeClasses()

      • operationServers

        default Set<String> operationServers​(String operationId)

      • scanDependenciesDisable

        default boolean scanDependenciesDisable()

      • scanDependenciesJars

        default Set<String> scanDependenciesJars()

      • arrayReferencesEnable

        default boolean arrayReferencesEnable()

      • customSchemaRegistryClass

        default String customSchemaRegistryClass()

      • applicationPathDisable

        default boolean applicationPathDisable()

      • privatePropertiesEnable

        default boolean privatePropertiesEnable()

      • propertyNamingStrategy

        default String propertyNamingStrategy()

      • sortedPropertiesEnable

        default boolean sortedPropertiesEnable()

      • getOpenApiVersion

        default String getOpenApiVersion()

      • getInfoTitle

        default String getInfoTitle()

      • getInfoVersion

        default String getInfoVersion()

      • getInfoDescription

        default String getInfoDescription()

      • getInfoTermsOfService

        default String getInfoTermsOfService()

      • getInfoContactEmail

        default String getInfoContactEmail()

      • getInfoContactName

        default String getInfoContactName()

      • getInfoContactUrl

        default String getInfoContactUrl()

      • getInfoLicenseName

        default String getInfoLicenseName()

      • getInfoLicenseUrl

        default String getInfoLicenseUrl()

      • getDefaultProduces

        default Optional<String[]> getDefaultProduces()

      • getDefaultConsumes

        default Optional<String[]> getDefaultConsumes()

      • allowNakedPathParameter

        default Optional<Boolean> allowNakedPathParameter()

      • doAllowNakedPathParameter

        default void doAllowNakedPathParameter()