OpenApiFeature (openapi) Configuration

Type: io.helidon.openapi.OpenApiFeature

This is a standalone configuration type, prefix from configuration root: openapi

Configuration options

Optional configuration options
keytypedefault valuedescription
cors 

CORS config.

@return CORS config
enabled

boolean

true

Sets whether the feature should be enabled.

@return `true` if enabled, `false` otherwise
manager

io.helidon.openapi.OpenApiManager (service provider interface)

 

OpenAPI manager.

@return the OpenAPI manager
permit-all

boolean

 

Whether to allow anybody to access the endpoint.

@return whether to permit access to metrics endpoint to anybody, defaults to `true`
@see #roles()
roles

string[]

 

Hints for role names the user is expected to be in.

@return list of hints
services

io.helidon.openapi.OpenApiService[] (service provider interface)

 

OpenAPI services.

@return the OpenAPI services
static-file

string

 

Path of the static OpenAPI document file. Default types are json, yaml, and yml.

@return location of the static OpenAPI document file
web-context

string

/openapi

Web context path for the OpenAPI endpoint.

@return webContext to use