Module io.helidon.microprofile.openapi

Package io.helidon.microprofile.openapi

Interface MpOpenApiManagerConfig

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

MpOpenApiManagerConfig.BuilderBase.MpOpenApiManagerConfigImpl

public interface MpOpenApiManagerConfig
extends Prototype.Api

MpOpenApiManager prototype.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	MpOpenApiManagerConfig.Builder	Fluent API builder for MpOpenApiManagerConfig.
static class	MpOpenApiManagerConfig.BuilderBase<BUILDER extends MpOpenApiManagerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends MpOpenApiManagerConfig>	Fluent API builder base for MpOpenApiManagerConfig.

Method Summary

Modifier and Type	Method	Description
static MpOpenApiManagerConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static MpOpenApiManagerConfig.Builder	builder(MpOpenApiManagerConfig instance)	Create a new fluent API builder from an existing instance.
static MpOpenApiManagerConfig	create()	Create a new instance with default values.
static MpOpenApiManagerConfig	create(Config config)	Deprecated. use create(io.helidon.config.Config)
static MpOpenApiManagerConfig	create(Config config)	Create a new instance from configuration.
List<String>	indexPaths()	Specify the set of Jandex index path.
boolean	useJaxRsSemantics()	If true and the jakarta.ws.rs.core.Application class returns a non-empty set, endpoints defined by other resources are not included in the OpenAPI document.

Method Details

builder

static MpOpenApiManagerConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static MpOpenApiManagerConfig.Builder builder(MpOpenApiManagerConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static MpOpenApiManagerConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

@Deprecated
static MpOpenApiManagerConfig create(Config config)

Deprecated.

use create(io.helidon.config.Config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static MpOpenApiManagerConfig create()

Create a new instance with default values.

Returns:

a new instance

useJaxRsSemantics

boolean useJaxRsSemantics()

If true and the jakarta.ws.rs.core.Application class returns a non-empty set, endpoints defined by other resources are not included in the OpenAPI document.

Returns:

true if enabled, false otherwise

indexPaths

List<String> indexPaths()

Specify the set of Jandex index path.

Returns:

list of Jandex index path