1 package com.atlassian.plugins.rest.common.expand;
2
3 import java.lang.annotation.Documented;
4 import static java.lang.annotation.ElementType.*;
5 import java.lang.annotation.Retention;
6 import static java.lang.annotation.RetentionPolicy.*;
7 import java.lang.annotation.Target;
8
9 /**
10 * This is an annotation to design field on REST resources that can be expanded.
11 */
12 @Retention(RUNTIME)
13 @Target(FIELD)
14 @Documented
15 public @interface Expandable
16 {
17 /**
18 * The value to match with the expansion parameter to determine whether the given field should be expanded.
19 * @return the parameter value to match for expansion.
20 */
21 String value() default "";
22 }