Package com.inteliqua.rest.common

Annotation Type VersionAwareProperty

  • @Target({METHOD,CONSTRUCTOR,FIELD})
@Retention(RUNTIME)
public @interface VersionAwareProperty
    Custom annotation to mark properties that are version-aware. This annotation can be used on methods, constructors, and fields to indicate that the property should only be included in the API response if the specified minimum version is met.

    The SupportedApiVersion is used to define the minimum version of the API where this property will be included in the response. If the API version is lower than the specified minimum, the property will be excluded from the response.

    Example usage:

    Author:
    pziogas VersionAwareProperty (minimumVersion = SupportedApiVersion.V3) private String featureProperty;

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      SupportedApiVersion minimumVersion
      The minimum version of the API where the property should be included.

    • Element Detail

      • minimumVersion

        SupportedApiVersion minimumVersion
        The minimum version of the API where the property should be included.
        Returns:
        The minimum supported API version.