Top Description Fields Constructors Methods
org.eclipse.microprofile.openapi

public final Class OASConfig

extends Object
Class Inheritance

Configurable properties in MicroProfile OpenAPI

Field Summary

Modifier and TypeField and Description
public static final String
EXTENSIONS_PREFIX

Recommended prefix for vendor specific configuration properties.

public static final String
FILTER

Configuration property to specify the fully qualified name of the OASFilter implementation.

public static final String
MODEL_READER

Configuration property to specify the fully qualified name of the OASModelReader implementation.

public static final String
SCAN_BEANVALIDATION

Configuration property to enable or disable scanning Jakarta Bean Validation annotations

public static final String
SCAN_CLASSES

Configuration property to specify the list of classes to scan.

public static final String
SCAN_DISABLE

Configuration property to disable annotation scanning.

public static final String
SCAN_EXCLUDE_CLASSES

Configuration property to specify the list of classes to exclude from scans.

public static final String
SCAN_EXCLUDE_PACKAGES

Configuration property to specify the list of packages to exclude from scans.

public static final String
SCAN_PACKAGES

Configuration property to specify the list of packages to scan.

public static final String
SCHEMA_PREFIX

Prefix of the configuration property to specify a schema for a specific class, in JSON format.

public static final String
SERVERS

Configuration property to specify the list of global servers that provide connectivity information.

public static final String
SERVERS_OPERATION_PREFIX

Prefix of the configuration property to specify an alternative list of servers to service an operation.

public static final String
SERVERS_PATH_PREFIX

Prefix of the configuration property to specify an alternative list of servers to service all operations in a path.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

EXTENSIONS_PREFIXback to summary
public static final String EXTENSIONS_PREFIX

Recommended prefix for vendor specific configuration properties.

FILTERback to summary
public static final String FILTER

Configuration property to specify the fully qualified name of the OASFilter implementation.

See Also
org.eclipse.microprofile.openapi.OASFilter
MODEL_READERback to summary
public static final String MODEL_READER

Configuration property to specify the fully qualified name of the OASModelReader implementation.

See Also
org.eclipse.microprofile.openapi.OASModelReader
SCAN_BEANVALIDATIONback to summary
public static final String SCAN_BEANVALIDATION

Configuration property to enable or disable scanning Jakarta Bean Validation annotations

SCAN_CLASSESback to summary
public static final String SCAN_CLASSES

Configuration property to specify the list of classes to scan.

SCAN_DISABLEback to summary
public static final String SCAN_DISABLE

Configuration property to disable annotation scanning.

SCAN_EXCLUDE_CLASSESback to summary
public static final String SCAN_EXCLUDE_CLASSES

Configuration property to specify the list of classes to exclude from scans.

SCAN_EXCLUDE_PACKAGESback to summary
public static final String SCAN_EXCLUDE_PACKAGES

Configuration property to specify the list of packages to exclude from scans.

SCAN_PACKAGESback to summary
public static final String SCAN_PACKAGES

Configuration property to specify the list of packages to scan.

SCHEMA_PREFIXback to summary
public static final String SCHEMA_PREFIX

Prefix of the configuration property to specify a schema for a specific class, in JSON format.

SERVERSback to summary
public static final String SERVERS

Configuration property to specify the list of global servers that provide connectivity information.

SERVERS_OPERATION_PREFIXback to summary
public static final String SERVERS_OPERATION_PREFIX

Prefix of the configuration property to specify an alternative list of servers to service an operation.

SERVERS_PATH_PREFIXback to summary
public static final String SERVERS_PATH_PREFIX

Prefix of the configuration property to specify an alternative list of servers to service all operations in a path.

Constructor Detail

OASConfigback to summary
private OASConfig()