Annotation Interface OpenApi.Header

Enclosing class:
OpenApi
@Target({}) @Retention(CLASS) @Documented public static @interface OpenApi.Header
OpenAPI Header Object metadata.

Declarative OpenAPI annotations do not model Header Object example, examples, or explode metadata. To use such metadata, define the complete containing operation in a static OpenAPI document or an OpenApiDocumentSource, and configure Helidon not to generate the same path and method from annotations.

  • Element Details

    • name

      String name
      Header name.

      Response header names cannot be Content-Type and cannot repeat case-insensitively within one response. Use OpenApi.Content to describe response media types.

      Returns:
      header name

    • value

      String value
      Header description.
      Returns:
      description
      Default:
      ""

    • required

      OpenApi.Required required
      Requiredness override.
      Returns:
      requiredness
      Default:
      UNSPECIFIED

    • deprecated

      boolean deprecated
      Whether the header is deprecated.
      Returns:
      deprecated flag
      Default:
      false

    • schema

      Class<?> schema
      Schema class. Defaults to String.
      Returns:
      schema class
      Default:
      java.lang.Void.class

    • content

      OpenApi.Content[] content
      Header content entries.

      At most one entry is supported.

      Returns:
      content
      Default:
      {}