Package org.wildfly.extension.microprofile.openapi.deployment

Interface OpenAPIModelConfiguration

All Superinterfaces:
OpenAPIEndpointConfiguration
All Known Implementing Classes:
DeploymentUnitOpenAPIModelConfiguration
public interface OpenAPIModelConfiguration extends OpenAPIEndpointConfiguration
Encapsulates the configuration of an OpenAPI model.
Author:
Paul Ferraro

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.wildfly.service.descriptor.TernaryServiceDescriptor<io.smallrye.openapi.api.SmallRyeOpenAPI>
    SERVICE_DESCRIPTOR
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.eclipse.microprofile.config.Config
    getMicroProfileConfig()
    Returns the MicroProfile configuration for this deployment.
    Function<String,URL>
    getResourceResolver()
    Returns a function that resolves a relative deployment path to a URL.
    Optional<URL>
    getStaticFile()
    Returns an optional static file, only present if the deployment defines one.
    boolean
    isEnabled()
    Indicates whether or not an OpenAPI endpoint is enabled for this deployment.
    boolean
    useRelativeServerURLs()
    Indicates whether or not the OpenAPI document should use relative URLs.

    Methods inherited from interface org.wildfly.extension.microprofile.openapi.deployment.OpenAPIEndpointConfiguration

    getHostName, getPath, getServerName

  • Field Details

    • SERVICE_DESCRIPTOR

      static final org.wildfly.service.descriptor.TernaryServiceDescriptor<io.smallrye.openapi.api.SmallRyeOpenAPI> SERVICE_DESCRIPTOR

  • Method Details

    • isEnabled

      boolean isEnabled()
      Indicates whether or not an OpenAPI endpoint is enabled for this deployment.
      Returns:
      true, if an OpenAPI endpoint is enabled for this deployment, false otherwise.

    • getMicroProfileConfig

      org.eclipse.microprofile.config.Config getMicroProfileConfig()
      Returns the MicroProfile configuration for this deployment.
      Returns:
      the MicroProfile configuration for this deployment.

    • getStaticFile

      Optional<URL> getStaticFile()
      Returns an optional static file, only present if the deployment defines one.
      Returns:
      an optional static file, only present if the deployment defines one.

    • getResourceResolver

      Function<String,URL> getResourceResolver()
      Returns a function that resolves a relative deployment path to a URL.
      Returns:
      a function that resolves a relative deployment path to a URL.

    • useRelativeServerURLs

      boolean useRelativeServerURLs()
      Indicates whether or not the OpenAPI document should use relative URLs.
      Returns:
      true, if the OpenAPI document for this deployment should use relative URLs, false otherwise.