Package org.kohsuke.github

Annotation Type Preview

  • @Retention(RUNTIME)
@Documented
public @interface Preview
    Indicates that the method/class/etc marked maps to GitHub API in the preview period.

    These APIs are subject to change and not a part of the backward compatibility commitment. It is advised to update the target's documentation with text indicating that a preview feature being used.

    Author:
    Kohsuke Kawaguchi

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      Previews[] value
      An optional field defining what API media types must be set inorder to support the usage of this annotations target.

    • Element Detail

      • value

        Previews[] value
        An optional field defining what API media types must be set inorder to support the usage of this annotations target.

        This value must be set using the existing constants defined in Previews

        Returns:
        The API preview media type.