MPOpenAPISupport (microprofile.openapi) Configuration

Type: io.helidon.microprofile.openapi.MPOpenAPISupport

Config key
mp.openapi
Copied

Configuration options

Optional configuration options
keytypedefault valuedescription
application-path-disable

boolean

false

Sets whether the app path search should be disabled.

cors

CrossOriginConfig

 

Assigns the CORS settings for the OpenAPI endpoint.

custom-schema-registry-class

string

 

Sets the custom schema registry class.

filter

string

 

Sets the developer-provided OpenAPI filter class name.

model.reader

string

 

Sets the developer-provided OpenAPI model reader class name.

scan.classes

string[]

 

Specify the list of classes to scan.

scan.disable

boolean

false

Disable annotation scanning.

scan.exclude.classes

string[]

 

Specify the list of classes to exclude from scans.

scan.exclude.packages

string[]

 

Specify the list of packages to exclude from scans.

scan.packages

string[]

 

Specify the list of packages to scan.

schema.*

string

 

Sets the schema for the indicated fully-qualified class name (represented here by '*'); value is the schema in JSON format. Repeat for multiple classes.

servers

string[]

 

Sets servers.

servers.operation.*

string[]

 

Sets alternative servers to service the indicated operation (represented here by '*'). Repeat for multiple operations.

servers.path.*

string[]

 

Sets alternative servers to service all operations at the indicated path (represented here by '*'). Repeat for multiple paths.

static-file

string

META-INF/openapi.*

Sets the file system path of the static OpenAPI document file. Default types are json, yaml, and yml.

web-context

string

/openapi

Sets the web context path for the OpenAPI endpoint.