Package io.smallrye.openapi.api.constants

Class OpenApiConstants

java.lang.Object

io.smallrye.openapi.api.constants.OpenApiConstants

public final class OpenApiConstants
extends Object

Author:

eric.wittmann@gmail.com

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APP_PATH_DISABLE
static final String	AUTO_INHERITANCE
static final String	CLASS_SUFFIX
static final String	CUSTOM_SCHEMA_REGISTRY_CLASS
static final Set<String>	DEFAULT_COMPOSITION_EXCLUDE_PACKAGES	Default set of packages with annotations that should not be checked for nested/composed annotations.
static final String	DEFAULT_CONSUMES
static final String	DEFAULT_CONSUMES_PRIMITIVES
static final String	DEFAULT_CONSUMES_STREAMING
static final Supplier<String[]>	DEFAULT_MEDIA_TYPES
static final String	DEFAULT_PRODUCES
static final String	DEFAULT_PRODUCES_PRIMITIVES
static final String	DEFAULT_PRODUCES_STREAMING
static final String	DUPLICATE_OPERATION_ID_BEHAVIOR
static final String	EXTENSION_PROFILE_PREFIX
static final String	INFO_CONTACT_EMAIL
static final String	INFO_CONTACT_NAME
static final String	INFO_CONTACT_URL
static final String	INFO_DESCRIPTION
static final String	INFO_LICENSE_NAME
static final String	INFO_LICENSE_URL
static final String	INFO_TERMS
static final String	INFO_TITLE
static final String	INFO_VERSION
static final String	JAR_SUFFIX
static final String	MAXIMUM_STATIC_FILE_SIZE
static final Set<String>	NEVER_SCAN_CLASSES	Set of classes which should never be scanned, regardless of user configuration.
static final Set<String>	NEVER_SCAN_PACKAGES	Set of packages which should never be scanned, regardless of user configuration.
static final String	OPEN_API_VERSION
static final String	OPERATION_ID_STRAGEGY
static final String	PROP_MEDIA_TYPE
static final String	PROP_OPERATION_ID
static final String	PROP_OPERATION_REF
static final String	PROP_SERVER
static final Set<org.jboss.jandex.DotName>	PROPERTY_ANNOTATIONS
static final String	REF
static final String	REF_PREFIX_API_RESPONSE
static final String	REF_PREFIX_CALLBACK
static final String	REF_PREFIX_EXAMPLE
static final String	REF_PREFIX_HEADER
static final String	REF_PREFIX_LINK
static final String	REF_PREFIX_PARAMETER
static final String	REF_PREFIX_REQUEST_BODY
static final String	REF_PREFIX_SCHEMA
static final String	REF_PREFIX_SECURITY_SCHEME
static final String	REFS
static final String	SCAN_COMPOSITION_EXCLUDE_PACKAGES
static final String	SCAN_DEPENDENCIES_DISABLE
static final String	SCAN_DEPENDENCIES_JARS
static final String	SCAN_EXCLUDE_PROFILES
static final String	SCAN_PROFILES
static final String	SCAN_RESOURCE_CLASS_PREFIX
static final String	SCHEMA_REFERENCES_ENABLE
static final String	SMALLRYE_APP_PATH_DISABLE
static final String	SMALLRYE_ARRAY_REFERENCES_ENABLE
static final String	SMALLRYE_CUSTOM_SCHEMA_REGISTRY_CLASS
static final String	SMALLRYE_PREFIX
static final String	SMALLRYE_PRIVATE_PROPERTIES_ENABLE
static final String	SMALLRYE_PROPERTY_NAMING_STRATEGY
static final String	SMALLRYE_REMOVE_UNUSED_SCHEMAS
static final String	SMALLRYE_SCAN_DEPENDENCIES_DISABLE
static final String	SMALLRYE_SCAN_DEPENDENCIES_JARS
static final String	SMALLRYE_SORTED_PROPERTIES_ENABLE
static final String	SUFFIX_APP_PATH_DISABLE
static final String	SUFFIX_ARRAY_REFERENCES_ENABLE
static final String	SUFFIX_CUSTOM_SCHEMA_REGISTRY_CLASS
static final String	SUFFIX_PRIVATE_PROPERTIES_ENABLE
static final String	SUFFIX_PROPERTY_NAMING_STRATEGY
static final String	SUFFIX_REMOVE_UNUSED_SCHEMAS_ENABLE
static final String	SUFFIX_SCAN_DEPENDENCIES_DISABLE
static final String	SUFFIX_SCAN_DEPENDENCIES_JARS
static final String	SUFFIX_SCHEMA_REFERENCES_ENABLE
static final String	SUFFIX_SORTED_PROPERTIES_ENABLE
static final String	VALUE
static final String	VENDOR_NAME
static final String	VERSION
static final String	WEB_ARCHIVE_CLASS_PREFIX

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

VENDOR_NAME

public static final String VENDOR_NAME

See Also:

• Constant Field Values

SUFFIX_SCAN_DEPENDENCIES_DISABLE

public static final String SUFFIX_SCAN_DEPENDENCIES_DISABLE

See Also:

• Constant Field Values

SUFFIX_SCAN_DEPENDENCIES_JARS

public static final String SUFFIX_SCAN_DEPENDENCIES_JARS

See Also:

• Constant Field Values

SUFFIX_SCHEMA_REFERENCES_ENABLE

public static final String SUFFIX_SCHEMA_REFERENCES_ENABLE

See Also:

• Constant Field Values

SUFFIX_ARRAY_REFERENCES_ENABLE

public static final String SUFFIX_ARRAY_REFERENCES_ENABLE

See Also:

• Constant Field Values

SUFFIX_CUSTOM_SCHEMA_REGISTRY_CLASS

public static final String SUFFIX_CUSTOM_SCHEMA_REGISTRY_CLASS

See Also:

• Constant Field Values

SUFFIX_APP_PATH_DISABLE

public static final String SUFFIX_APP_PATH_DISABLE

See Also:

• Constant Field Values

SUFFIX_PRIVATE_PROPERTIES_ENABLE

public static final String SUFFIX_PRIVATE_PROPERTIES_ENABLE

See Also:

• Constant Field Values

SUFFIX_PROPERTY_NAMING_STRATEGY

public static final String SUFFIX_PROPERTY_NAMING_STRATEGY

See Also:

• Constant Field Values

SUFFIX_SORTED_PROPERTIES_ENABLE

public static final String SUFFIX_SORTED_PROPERTIES_ENABLE

See Also:

• Constant Field Values

SUFFIX_REMOVE_UNUSED_SCHEMAS_ENABLE

public static final String SUFFIX_REMOVE_UNUSED_SCHEMAS_ENABLE

See Also:

• Constant Field Values

SCAN_DEPENDENCIES_DISABLE

public static final String SCAN_DEPENDENCIES_DISABLE

See Also:

• Constant Field Values

SCAN_DEPENDENCIES_JARS

public static final String SCAN_DEPENDENCIES_JARS

See Also:

• Constant Field Values

SCHEMA_REFERENCES_ENABLE

public static final String SCHEMA_REFERENCES_ENABLE

See Also:

• Constant Field Values

CUSTOM_SCHEMA_REGISTRY_CLASS

public static final String CUSTOM_SCHEMA_REGISTRY_CLASS

See Also:

• Constant Field Values

APP_PATH_DISABLE

public static final String APP_PATH_DISABLE

See Also:

• Constant Field Values

SMALLRYE_PREFIX

public static final String SMALLRYE_PREFIX

See Also:

• Constant Field Values

SMALLRYE_SCAN_DEPENDENCIES_DISABLE

public static final String SMALLRYE_SCAN_DEPENDENCIES_DISABLE

See Also:

• Constant Field Values

SMALLRYE_SCAN_DEPENDENCIES_JARS

public static final String SMALLRYE_SCAN_DEPENDENCIES_JARS

See Also:

• Constant Field Values

SMALLRYE_ARRAY_REFERENCES_ENABLE

public static final String SMALLRYE_ARRAY_REFERENCES_ENABLE

See Also:

• Constant Field Values

SMALLRYE_CUSTOM_SCHEMA_REGISTRY_CLASS

public static final String SMALLRYE_CUSTOM_SCHEMA_REGISTRY_CLASS

See Also:

• Constant Field Values

SMALLRYE_APP_PATH_DISABLE

public static final String SMALLRYE_APP_PATH_DISABLE

See Also:

• Constant Field Values

SMALLRYE_PRIVATE_PROPERTIES_ENABLE

public static final String SMALLRYE_PRIVATE_PROPERTIES_ENABLE

See Also:

• Constant Field Values

SMALLRYE_PROPERTY_NAMING_STRATEGY

public static final String SMALLRYE_PROPERTY_NAMING_STRATEGY

See Also:

• Constant Field Values

SMALLRYE_SORTED_PROPERTIES_ENABLE

public static final String SMALLRYE_SORTED_PROPERTIES_ENABLE

See Also:

• Constant Field Values

SMALLRYE_REMOVE_UNUSED_SCHEMAS

public static final String SMALLRYE_REMOVE_UNUSED_SCHEMAS

See Also:

• Constant Field Values

SCAN_PROFILES

public static final String SCAN_PROFILES

See Also:

• Constant Field Values

SCAN_EXCLUDE_PROFILES

public static final String SCAN_EXCLUDE_PROFILES

See Also:

• Constant Field Values

SCAN_RESOURCE_CLASS_PREFIX

public static final String SCAN_RESOURCE_CLASS_PREFIX

See Also:

• Constant Field Values

SCAN_COMPOSITION_EXCLUDE_PACKAGES

public static final String SCAN_COMPOSITION_EXCLUDE_PACKAGES

See Also:

• Constant Field Values

VERSION

public static final String VERSION

See Also:

• Constant Field Values

INFO_TITLE

public static final String INFO_TITLE

See Also:

• Constant Field Values

INFO_VERSION

public static final String INFO_VERSION

See Also:

• Constant Field Values

INFO_DESCRIPTION

public static final String INFO_DESCRIPTION

See Also:

• Constant Field Values

INFO_TERMS

public static final String INFO_TERMS

See Also:

• Constant Field Values

INFO_CONTACT_EMAIL

public static final String INFO_CONTACT_EMAIL

See Also:

• Constant Field Values

INFO_CONTACT_NAME

public static final String INFO_CONTACT_NAME

See Also:

• Constant Field Values

INFO_CONTACT_URL

public static final String INFO_CONTACT_URL

See Also:

• Constant Field Values

INFO_LICENSE_NAME

public static final String INFO_LICENSE_NAME

See Also:

• Constant Field Values

INFO_LICENSE_URL

public static final String INFO_LICENSE_URL

See Also:

• Constant Field Values

OPERATION_ID_STRAGEGY

public static final String OPERATION_ID_STRAGEGY

See Also:

• Constant Field Values

DUPLICATE_OPERATION_ID_BEHAVIOR

public static final String DUPLICATE_OPERATION_ID_BEHAVIOR

See Also:

• Constant Field Values

DEFAULT_PRODUCES

public static final String DEFAULT_PRODUCES

See Also:

• Constant Field Values

DEFAULT_CONSUMES

public static final String DEFAULT_CONSUMES

See Also:

• Constant Field Values

DEFAULT_PRODUCES_PRIMITIVES

public static final String DEFAULT_PRODUCES_PRIMITIVES

See Also:

• Constant Field Values

DEFAULT_CONSUMES_PRIMITIVES

public static final String DEFAULT_CONSUMES_PRIMITIVES

See Also:

• Constant Field Values

DEFAULT_PRODUCES_STREAMING

public static final String DEFAULT_PRODUCES_STREAMING

See Also:

• Constant Field Values

DEFAULT_CONSUMES_STREAMING

public static final String DEFAULT_CONSUMES_STREAMING

See Also:

• Constant Field Values

MAXIMUM_STATIC_FILE_SIZE

public static final String MAXIMUM_STATIC_FILE_SIZE

See Also:

• Constant Field Values

AUTO_INHERITANCE

public static final String AUTO_INHERITANCE

See Also:

• Constant Field Values

NEVER_SCAN_CLASSES

public static final Set<String> NEVER_SCAN_CLASSES

Set of classes which should never be scanned, regardless of user configuration.

NEVER_SCAN_PACKAGES

public static final Set<String> NEVER_SCAN_PACKAGES

Set of packages which should never be scanned, regardless of user configuration.

CLASS_SUFFIX

public static final String CLASS_SUFFIX

See Also:

• Constant Field Values

JAR_SUFFIX

public static final String JAR_SUFFIX

See Also:

• Constant Field Values

WEB_ARCHIVE_CLASS_PREFIX

public static final String WEB_ARCHIVE_CLASS_PREFIX

See Also:

• Constant Field Values

PROP_SERVER

public static final String PROP_SERVER

See Also:

• Constant Field Values

PROP_OPERATION_ID

public static final String PROP_OPERATION_ID

See Also:

• Constant Field Values

PROP_OPERATION_REF

public static final String PROP_OPERATION_REF

See Also:

• Constant Field Values

PROP_MEDIA_TYPE

public static final String PROP_MEDIA_TYPE

See Also:

• Constant Field Values

PROPERTY_ANNOTATIONS

public static final Set<org.jboss.jandex.DotName> PROPERTY_ANNOTATIONS

REF_PREFIX_API_RESPONSE

public static final String REF_PREFIX_API_RESPONSE

See Also:

• Constant Field Values

REF_PREFIX_CALLBACK

public static final String REF_PREFIX_CALLBACK

See Also:

• Constant Field Values

REF_PREFIX_EXAMPLE

public static final String REF_PREFIX_EXAMPLE

See Also:

• Constant Field Values

REF_PREFIX_HEADER

public static final String REF_PREFIX_HEADER

See Also:

• Constant Field Values

REF_PREFIX_LINK

public static final String REF_PREFIX_LINK

See Also:

• Constant Field Values

REF_PREFIX_PARAMETER

public static final String REF_PREFIX_PARAMETER

See Also:

• Constant Field Values

REF_PREFIX_REQUEST_BODY

public static final String REF_PREFIX_REQUEST_BODY

See Also:

• Constant Field Values

REF_PREFIX_SCHEMA

public static final String REF_PREFIX_SCHEMA

See Also:

• Constant Field Values

REF_PREFIX_SECURITY_SCHEME

public static final String REF_PREFIX_SECURITY_SCHEME

See Also:

• Constant Field Values

VALUE

public static final String VALUE

See Also:

• Constant Field Values

REFS

public static final String REFS

See Also:

• Constant Field Values

OPEN_API_VERSION

public static final String OPEN_API_VERSION

See Also:

• Constant Field Values

DEFAULT_MEDIA_TYPES

public static final Supplier<String[]> DEFAULT_MEDIA_TYPES

REF

public static final String REF

See Also:

• Constant Field Values

EXTENSION_PROFILE_PREFIX

public static final String EXTENSION_PROFILE_PREFIX

See Also:

• Constant Field Values

DEFAULT_COMPOSITION_EXCLUDE_PACKAGES

public static final Set<String> DEFAULT_COMPOSITION_EXCLUDE_PACKAGES

Default set of packages with annotations that should not be checked for nested/composed annotations. For example, the annotations org.jetbrains.annotations.NotNull will not be checked for additional annotations. Generally, only application-provided custom annotations would be used to compose multiple OpenAPI annotations. This list allows the scanner to short-circuit the scanning of an excessive number of annotations.