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