OpenApiConfig (SmallRye: OpenAPI Core 2.0.25 API)

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:

eric.wittmann@gmail.com

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class OpenApiConfig.OperationIdStrategy

Nested Classes
Modifier and Type	Interface and Description
`static class`	`OpenApiConfig.OperationIdStrategy`

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default boolean`	`applicationPathDisable()`
`default boolean`	`arrayReferencesEnable()`
`default Set<String>`	`asCsvSet(String items)`
`default String`	`customSchemaRegistryClass()`
`default String`	`filter()`
`default Optional<String[]>`	`getDefaultConsumes()`
`default Optional<String[]>`	`getDefaultProduces()`
`default String`	`getInfoContactEmail()`
`default String`	`getInfoContactName()`
`default String`	`getInfoContactUrl()`
`default String`	`getInfoDescription()`
`default String`	`getInfoLicenseName()`
`default String`	`getInfoLicenseUrl()`
`default String`	`getInfoTermsOfService()`
`default String`	`getInfoTitle()`
`default String`	`getInfoVersion()`
`default String`	`getOpenApiVersion()`
`default OpenApiConfig.OperationIdStrategy`	`getOperationIdStrategy()`
`default Map<String,String>`	`getSchemas()`
`default String`	`modelReader()`
`default Set<String>`	`operationServers(String operationId)`
`default Set<String>`	`pathServers(String path)`
`default Pattern`	`patternOf(String configValue)`
`default Pattern`	`patternOf(String configValue, Set<String> buildIn)`
`default boolean`	`privatePropertiesEnable()`
`default Pattern`	`scanClasses()`
`default boolean`	`scanDependenciesDisable()`
`default Set<String>`	`scanDependenciesJars()`
`default boolean`	`scanDisable()`
`default Pattern`	`scanExcludeClasses()`
`default Pattern`	`scanExcludePackages()`
`default Pattern`	`scanPackages()`
`default Set<String>`	`servers()`

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()
```

servers
```
default Set<String> servers()
```

pathServers

default Set<String> pathServers(String path)

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()

getSchemas

default Map<String,String> getSchemas()

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()
```

getOperationIdStrategy

default OpenApiConfig.OperationIdStrategy getOperationIdStrategy()

getDefaultProduces

default Optional<String[]> getDefaultProduces()

getDefaultConsumes

default Optional<String[]> getDefaultConsumes()

patternOf

default Pattern patternOf(String configValue)

patternOf

default Pattern patternOf(String configValue,
                          Set<String> buildIn)

asCsvSet

default Set<String> asCsvSet(String items)

Interface OpenApiConfig

Nested Class Summary

Method Summary

Method Detail

modelReader

filter

scanDisable

scanPackages

scanClasses

scanExcludePackages

scanExcludeClasses

servers

pathServers

operationServers

scanDependenciesDisable

scanDependenciesJars

arrayReferencesEnable

customSchemaRegistryClass

applicationPathDisable

privatePropertiesEnable

getSchemas

getOpenApiVersion

getInfoTitle

getInfoVersion

getInfoDescription

getInfoTermsOfService

getInfoContactEmail

getInfoContactName

getInfoContactUrl

getInfoLicenseName

getInfoLicenseUrl

getOperationIdStrategy

getDefaultProduces

getDefaultConsumes

patternOf

patternOf

asCsvSet