com.atlassian.rest.annotation

Annotation Type RestProperty

@Retention(value=RUNTIME)
 @Target(value={FIELD,METHOD})
public @interface RestProperty

This annotation can give hints to the JSON schema generator about a bean property.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description Description of the property.
String	pattern Property pattern for Map fields.
boolean	required Whether the property is required.
RestProperty.Scope	scope Sets the scope for the field.

Element Detail

scope

public abstract RestProperty.Scope scope

Sets the scope for the field.

Each schema is generated in one of two scopes: REQUEST and RESPONSE. Use this annotation to control whether the field should appear in a scope.

Default:

com.atlassian.rest.annotation.RestProperty.Scope.AUTO

pattern

public abstract String pattern

Property pattern for Map fields.

Default:

".+"

description

public abstract String description

Description of the property.

Default:

""

required

public abstract boolean required

Whether the property is required.

Default:

false