Annotation Type Encoding

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean allowReserved
      Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 to be included without percent-encoding.
      String contentType
      The Content-Type for encoding a specific property.
      boolean explode
      When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map.
      Extension[] extensions
      The list of optional extensions
      Header[] headers
      An array of header objects
      String name
      The name of this encoding object instance.
      String style
      Describes how a specific property value will be serialized depending on its type
    • Element Detail

      • name

        String name
        The name of this encoding object instance. This property is a key in encoding map of MediaType object and MUST exist in a schema as a property.
        Returns:
        name of the encoding
        Default:
        ""
      • contentType

        String contentType
        The Content-Type for encoding a specific property.
        Returns:
        content type of the encoding
        Default:
        ""
      • style

        String style
        Describes how a specific property value will be serialized depending on its type
        Returns:
        style of the encoding
        Default:
        ""
      • explode

        boolean explode
        When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map.
        Returns:
        boolean
        Default:
        false
      • allowReserved

        boolean allowReserved
        Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 to be included without percent-encoding.
        Returns:
        boolean
        Default:
        false
      • headers

        Header[] headers
        An array of header objects
        Returns:
        array of headers
        Default:
        {}
      • extensions

        Extension[] extensions
        The list of optional extensions
        Returns:
        an optional array of extensions
        Default:
        {}