Annotation Type Header

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String name
      Required: The name of the header.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean deprecated
      Specifies that a header is deprecated and should be transitioned out of usage.
      String description
      Additional description data to provide on the purpose of the header
      String ref
      A reference to a header defined in components headers.
      boolean required
      Determines whether this header is mandatory.
      Schema schema
      The schema defining the type used for the header.
    • Element Detail

      • name

        String name
        Required: The name of the header. The name is only used as the key to store this header in a map.
        Returns:
        the header's name
      • description

        String description
        Additional description data to provide on the purpose of the header
        Returns:
        the header's description
        Default:
        ""
      • schema

        Schema schema
        The schema defining the type used for the header. Ignored if the properties content or array are specified.
        Returns:
        the schema of the header
        Default:
        @io.swagger.v3.oas.annotations.media.Schema
      • required

        boolean required
        Determines whether this header is mandatory. The property may be included and its default value is false.
        Returns:
        whether or not the header is required
        Default:
        false
      • deprecated

        boolean deprecated
        Specifies that a header is deprecated and should be transitioned out of usage.
        Returns:
        whether or not the header is deprecated
        Default:
        false
      • ref

        String ref
        A reference to a header defined in components headers.
        Returns:
        the reference
        Since:
        2.0.3
        Default:
        ""