Class OASConfig

java.lang.Object
org.eclipse.microprofile.openapi.OASConfig

public final class OASConfig extends Object
Configurable properties in MicroProfile OpenAPI
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Recommended prefix for vendor specific configuration properties.
    static final String
    Configuration property to specify the fully qualified name of the OASFilter implementation.
    static final String
    Configuration property to specify the fully qualified name of the OASModelReader implementation.
    static final String
    Configuration property to enable or disable scanning Jakarta Bean Validation annotations
    static final String
    Configuration property to specify the list of classes to scan.
    static final String
    Configuration property to disable annotation scanning.
    static final String
    Configuration property to specify the list of classes to exclude from scans.
    static final String
    Configuration property to specify the list of packages to exclude from scans.
    static final String
    Configuration property to specify the list of packages to scan.
    static final String
    Prefix of the configuration property to specify a schema for a specific class, in JSON format.
    static final String
    Configuration property to specify the list of global servers that provide connectivity information.
    static final String
    Prefix of the configuration property to specify an alternative list of servers to service an operation.
    static final String
    Prefix of the configuration property to specify an alternative list of servers to service all operations in a path.
  • Method Summary

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • MODEL_READER

      public static final String MODEL_READER
      Configuration property to specify the fully qualified name of the OASModelReader implementation.
      See Also:
    • FILTER

      public static final String FILTER
      Configuration property to specify the fully qualified name of the OASFilter implementation.
      See Also:
    • SCAN_DISABLE

      public static final String SCAN_DISABLE
      Configuration property to disable annotation scanning.
      See Also:
    • SCAN_PACKAGES

      public static final String SCAN_PACKAGES
      Configuration property to specify the list of packages to scan.
      See Also:
    • SCAN_CLASSES

      public static final String SCAN_CLASSES
      Configuration property to specify the list of classes to scan.
      See Also:
    • SCAN_EXCLUDE_PACKAGES

      public static final String SCAN_EXCLUDE_PACKAGES
      Configuration property to specify the list of packages to exclude from scans.
      See Also:
    • SCAN_EXCLUDE_CLASSES

      public static final String SCAN_EXCLUDE_CLASSES
      Configuration property to specify the list of classes to exclude from scans.
      See Also:
    • SCAN_BEANVALIDATION

      public static final String SCAN_BEANVALIDATION
      Configuration property to enable or disable scanning Jakarta Bean Validation annotations
      See Also:
    • SERVERS

      public static final String SERVERS
      Configuration property to specify the list of global servers that provide connectivity information.
      See Also:
    • SERVERS_PATH_PREFIX

      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.
      See Also:
    • SERVERS_OPERATION_PREFIX

      public static final String SERVERS_OPERATION_PREFIX
      Prefix of the configuration property to specify an alternative list of servers to service an operation.
      See Also:
    • SCHEMA_PREFIX

      public static final String SCHEMA_PREFIX
      Prefix of the configuration property to specify a schema for a specific class, in JSON format.
      See Also:
    • EXTENSIONS_PREFIX

      public static final String EXTENSIONS_PREFIX
      Recommended prefix for vendor specific configuration properties.
      See Also: