Package io.smallrye.openapi.api

Class OpenApiDocument

java.lang.Object
io.smallrye.openapi.api.OpenApiDocument
@Deprecated public class OpenApiDocument extends Object
Deprecated.
use the SmallRyeOpenAPI builder API instead. This class may be moved, have reduced visibility, or be removed in a future release.
Holds the final OpenAPI document produced during the startup of the app.

Note that the model must be initialized first!

Author:
Martin Kouba

  • Field Details

  • Method Details

    • newInstance

      public static OpenApiDocument newInstance()
      Deprecated.

    • get

      public org.eclipse.microprofile.openapi.models.OpenAPI get()
      Deprecated.
      Returns:
      the final OpenAPI document produced during the startup of the app
      Throws:
      IllegalStateException - If the final model is not initialized yet

    • set

      public void set(org.eclipse.microprofile.openapi.models.OpenAPI model)
      Deprecated.
      Set the final OpenAPI document. This method should only be used for testing.
      Parameters:
      model - OpenAPI model instance

    • reset

      public void reset()
      Deprecated.
      Reset the holder.

    • isSet

      public boolean isSet()
      Deprecated.
      Returns:
      true if model initialized

    • config

      public void config(OpenApiConfig config)
      Deprecated.

    • modelFromAnnotations

      public void modelFromAnnotations(org.eclipse.microprofile.openapi.models.OpenAPI model)
      Deprecated.

    • modelFromReader

      public void modelFromReader(org.eclipse.microprofile.openapi.models.OpenAPI model)
      Deprecated.

    • modelFromStaticFile

      public void modelFromStaticFile(org.eclipse.microprofile.openapi.models.OpenAPI model)
      Deprecated.

    • filter

      public void filter(org.eclipse.microprofile.openapi.OASFilter filter)
      Deprecated.

    • defaultRequiredProperties

      public void defaultRequiredProperties(boolean defaultRequiredProperties)
      Deprecated.

    • archiveName

      public void archiveName(String archiveName)
      Deprecated.

    • version

      public void version(String version)
      Deprecated.

    • initialize

      public void initialize()
      Deprecated.