Annotation Interface OpenApi.Document

Enclosing class:
OpenApi
@Target(TYPE) @Retention(CLASS) @Documented public static @interface OpenApi.Document
Marker for a type that contributes document-level OpenAPI metadata.

A type annotated with @OpenApi.Document must also be annotated with @OpenApi.Info.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    jsonSchemaDialect
    JSON Schema dialect URI.
    String
    self
    Document identity URI.

  • Element Details

    • self

      String self
      Document identity URI.

      Rendered only for OpenAPI 3.2 output. A relative identity is resolved against the configured OpenAPI web context. When the identity is relative, Helidon cannot determine whether an absolute reference identifies this document because composition does not have the request scheme or authority. That combination is not supported; use an absolute document identity or relative references instead.

      Returns:
      document identity URI
      Default:
      ""

    • jsonSchemaDialect

      String jsonSchemaDialect
      JSON Schema dialect URI.

      Rendered only for OpenAPI 3.1 and later output.

      Returns:
      JSON Schema dialect URI
      Default:
      ""