Stratastax Entity/dev.buijs.stratastax.entity.core.spi.annotations/RestProperty

RestProperty

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.PROPERTY])

annotation class RestProperty(val name: String = "", val type: KClass<*> = Unit::class)(source)

The REST DTO property of this property or parameter, when it differs from the domain: in the response DTO and in the request DTOs alike. Without it, a response DTO property has the name of the entity property, and a request DTO property the name of the command property it is written to.

On a property in the class body, it also adds the property to the response DTO.

Properties

name

val name: String

The DTO property name; blank means the domain name.

type

val type: KClass<*>

The REST DTO type to convert the value to. Like RestEntity, only the name of the type is used. Unit means no conversion.