5.9.8

wow-api/me.ahoo.wow.api.annotation/CommandRoute

CommandRoute

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS])

annotation class CommandRoute( val action: String = DEFAULT_COMMAND_ACTION, val enabled: Boolean = true, val method: CommandRoute.Method = Method.DEFAULT, val prefix: String = "", val appendIdPath: CommandRoute.AppendPath = AppendPath.DEFAULT, val appendTenantPath: CommandRoute.AppendPath = AppendPath.DEFAULT, val appendOwnerPath: CommandRoute.AppendPath = AppendPath.DEFAULT, val summary: String = "", val description: String = "")

Types

enum AppendPath : Enum<CommandRoute.AppendPath>

@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.PROPERTY, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.ANNOTATION_CLASS])

annotation class HeaderVariable(val name: String = "", val nestedPath: Array<String> = [], val required: Boolean = true)

enum Method : Enum<CommandRoute.Method>

@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.PROPERTY, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.ANNOTATION_CLASS])

annotation class PathVariable(val name: String = "", val nestedPath: Array<String> = [], val required: Boolean = true)

Properties

val action: String

action name or sub resource name

val appendIdPath: CommandRoute.AppendPath

appendOwnerPath

val appendOwnerPath: CommandRoute.AppendPath

appendTenantPath

val appendTenantPath: CommandRoute.AppendPath

val ~~description~~: String

val enabled: Boolean = true

val method: CommandRoute.Method

val prefix: String

val ~~summary~~: String