com.atlassian.rest.annotation

Annotation Type ResponseType

@Retention(value=RUNTIME)
 @Target(value={METHOD,TYPE})
public @interface ResponseType

Declares an actual type returned by a REST method so that the WADL generator can create JSON schemas.

This annotation can be placed on a single method and also on a class. When it's on a class that means it's applied to all methods in this class. That's useful for declaring error types, as they are usually the same for all methods.

Use ResponseTypes annotation to declare more than one return type.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<?>	value Type of the returned response.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>[]	genericTypes If the response class is generic you are supposed to provide all its generic types here.
int	status Status for which this type applies.
ResponseType.StatusType	statusType General type of the status.

Element Detail

value

public abstract Class<?> value

Type of the returned response.

status

public abstract int status

Status for which this type applies. Note that for the JSON schema generation to work, the type also needs to be declared in the javadoc.

Returns:

status

Default:

0

statusType

public abstract ResponseType.StatusType statusType

General type of the status.

Instead of specifying an exact status, you can select a group of statues. If any status from the group is present in the method's javadoc, it will have a schema generated for the type declared here.

Returns:

Default:

com.atlassian.rest.annotation.ResponseType.StatusType.SUCCESS

genericTypes

public abstract Class<?>[] genericTypes

If the response class is generic you are supposed to provide all its generic types here.

Default:

{}