Module neberus.core
Package net.oneandone.neberus.annotation

Annotation Type ApiHeader

  • @Target({})
@Retention(SOURCE)
public @interface ApiHeader
    Define a response Header within a ApiResponse.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String name
      Name of the header.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      ApiAllowedValue[] allowedValues
      Define allowed value that is returned to the client.
      boolean deprecated
      If true, the header will be marked as deprecated.
      java.lang.String deprecatedDescription
      Additional description that will be shown if the header is deprecated.
      java.lang.String description
      Description of the header.
      boolean optional
      If true, the header will be marked as optional, else as mandatory.

    • Element Detail

      • name

        java.lang.String name
        Name of the header. May be used on a method to reference a header defined on the class.
        Returns:
        the name

      • description

        java.lang.String description
        Description of the header.
        Returns:
        the description
        Default:
        ""

      • allowedValues

        ApiAllowedValue[] allowedValues
        Define allowed value that is returned to the client.
        Returns:
        the allowed value
        Default:
        {}

      • optional

        boolean optional
        If true, the header will be marked as optional, else as mandatory.
        Returns:
        whether the header is optional
        Default:
        false

      • deprecated

        boolean deprecated
        If true, the header will be marked as deprecated.
        Returns:
        whether the header is deprecated
        Default:
        false

      • deprecatedDescription

        java.lang.String deprecatedDescription
        Additional description that will be shown if the header is deprecated.
        Returns:
        additional description for a deprecated header
        Default:
        ""