Package com.atlassian.graphql.annotations.expansions

Annotation Type GraphQLExpandable

@Target({FIELD,TYPE,METHOD}) @Retention(RUNTIME) public @interface GraphQLExpandable
Marks a field or field type (such as a Reference class) as an expansion field. An expansion field is one that can be expanded via the 'expand' query parameter on an Atlassian REST API.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    skip
     
    String
    value
     

  • Element Details

    • value

      String value
      Returns:
      the explicit path to use to expand this node. If not provided, defaults to the current node name.
      Default:
      ""

    • skip

      boolean skip
      Returns:
      Whether to skip this field in an expandable calculation or not.
      Default:
      false