Module io.helidon.openapi

Package io.helidon.openapi.internal

Class OpenAPIConfigImpl

java.lang.Object

io.helidon.openapi.internal.OpenAPIConfigImpl

All Implemented Interfaces:

io.smallrye.openapi.api.OpenApiConfig

public class OpenAPIConfigImpl
extends Object
implements io.smallrye.openapi.api.OpenApiConfig

Helidon-specific implementation of the smallrye OpenApiConfig interface, loadable from a Helidon Config object as well as individual items settable programmatically.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenAPIConfigImpl.Builder	Fluent builder for OpenAPIConfigImpl.

Nested classes/interfaces inherited from interface io.smallrye.openapi.api.OpenApiConfig

io.smallrye.openapi.api.OpenApiConfig.OperationIdStrategy

Method Summary

Modifier and Type	Method	Description
boolean	applicationPathDisable()
static OpenAPIConfigImpl.Builder	builder()	Creates a new builder for composing an OpenAPI config instance.
String	customSchemaRegistryClass()
String	filter()
Map<String,String>	getSchemas()
String	modelReader()
Set<String>	operationServers(String operationID)
Set<String>	pathServers(String path)
Pattern	scanClasses()
boolean	scanDependenciesDisable()
Set<String>	scanDependenciesJars()
boolean	scanDisable()
Pattern	scanExcludeClasses()
Pattern	scanExcludePackages()
Pattern	scanPackages()
Set<String>	servers()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.smallrye.openapi.api.OpenApiConfig

allowNakedPathParameter, arrayReferencesEnable, asCsvSet, doAllowNakedPathParameter, getDefaultConsumes, getDefaultProduces, getInfoContactEmail, getInfoContactName, getInfoContactUrl, getInfoDescription, getInfoLicenseName, getInfoLicenseUrl, getInfoTermsOfService, getInfoTitle, getInfoVersion, getOpenApiVersion, getOperationIdStrategy, getScanExcludeProfiles, getScanProfiles, patternOf, patternOf, privatePropertiesEnable, propertyNamingStrategy, sortedPropertiesEnable

Method Details

builder

public static OpenAPIConfigImpl.Builder builder()

Creates a new builder for composing an OpenAPI config instance.

Returns:

the new Builder

modelReader

public String modelReader()

Specified by:

modelReader in interface io.smallrye.openapi.api.OpenApiConfig

filter

public String filter()

Specified by:

filter in interface io.smallrye.openapi.api.OpenApiConfig

scanDisable

public boolean scanDisable()

Specified by:

scanDisable in interface io.smallrye.openapi.api.OpenApiConfig

scanPackages

public Pattern scanPackages()

Specified by:

scanPackages in interface io.smallrye.openapi.api.OpenApiConfig

scanClasses

public Pattern scanClasses()

Specified by:

scanClasses in interface io.smallrye.openapi.api.OpenApiConfig

scanExcludePackages

public Pattern scanExcludePackages()

Specified by:

scanExcludePackages in interface io.smallrye.openapi.api.OpenApiConfig

scanExcludeClasses

public Pattern scanExcludeClasses()

Specified by:

scanExcludeClasses in interface io.smallrye.openapi.api.OpenApiConfig

servers

public Set<String> servers()

Specified by:

servers in interface io.smallrye.openapi.api.OpenApiConfig

pathServers

public Set<String> pathServers(String path)

Specified by:

pathServers in interface io.smallrye.openapi.api.OpenApiConfig

operationServers

public Set<String> operationServers(String operationID)

Specified by:

operationServers in interface io.smallrye.openapi.api.OpenApiConfig

scanDependenciesDisable

public boolean scanDependenciesDisable()

Specified by:

scanDependenciesDisable in interface io.smallrye.openapi.api.OpenApiConfig

scanDependenciesJars

public Set<String> scanDependenciesJars()

Specified by:

scanDependenciesJars in interface io.smallrye.openapi.api.OpenApiConfig

customSchemaRegistryClass

public String customSchemaRegistryClass()

Specified by:

customSchemaRegistryClass in interface io.smallrye.openapi.api.OpenApiConfig

applicationPathDisable

public boolean applicationPathDisable()

Specified by:

applicationPathDisable in interface io.smallrye.openapi.api.OpenApiConfig

getSchemas

public Map<String,String> getSchemas()

Specified by:

getSchemas in interface io.smallrye.openapi.api.OpenApiConfig