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<org.eclipse.microprofile.openapi.models.OpenAPI>
    SERVICE_DESCRIPTOR
     

  • Method Summary

    Modifier and Type
    Method
    Description
    io.smallrye.openapi.api.OpenApiConfig
    getOpenApiConfig()
    Returns the OpenAPI configuration for this deployment.
    Map.Entry<org.jboss.vfs.VirtualFile,io.smallrye.openapi.runtime.io.Format>
    getStaticFile()
    Returns a tuple containing the static file and its format, or null, if the deployment does not define a static file.
    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<org.eclipse.microprofile.openapi.models.OpenAPI> 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.

    • getOpenApiConfig

      io.smallrye.openapi.api.OpenApiConfig getOpenApiConfig()
      Returns the OpenAPI configuration for this deployment.
      Returns:
      the OpenAPI configuration for this deployment.

    • getStaticFile

      Map.Entry<org.jboss.vfs.VirtualFile,io.smallrye.openapi.runtime.io.Format> getStaticFile()
      Returns a tuple containing the static file and its format, or null, if the deployment does not define a static file.
      Returns:
      a tuple containing the static file and its format, or null, if the deployment does not define a static file.

    • 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.