@Retention(value=RUNTIME)
public @interface ParameterDescription
Modifier and Type | Fields and Description |
---|---|
static java.lang.String |
BODY_DESCRIPTION
name of the parameter that contains the body
|
static java.lang.String |
BODY_NAME
name of the parameter that contains the body
|
static java.lang.String |
BODY_TYPE
paramType : HTTP header parameter type
|
static java.lang.String |
FLOAT_FORMAT
format : float
|
static java.lang.String |
FORMAT_BYTE
format : byte
|
static java.lang.String |
FORMAT_DATE
format : date
|
static java.lang.String |
FORMAT_DATE_TIME
format : date-time
|
static java.lang.String |
FORMAT_DOUBLE
format : double
|
static java.lang.String |
FORMAT_INT32
format : int32
|
static java.lang.String |
FORMAT_INT64
format : int64
|
static java.lang.String |
FORMAT_NONE
format : no format
|
static java.lang.String |
HEADER_TYPE
paramType : HTTP header parameter type
|
static java.lang.String |
PATH_TYPE
paramType : HTTP header parameter type
|
static java.lang.String |
QUERY_TYPE
paramType : HTTP query parameter type
|
static java.lang.String |
TYPE_ARRAY
type : array
|
static java.lang.String |
TYPE_BOOLEAN
type : boolean
|
static java.lang.String |
TYPE_INTEGER
type : integer
|
static java.lang.String |
TYPE_NUMBER
type : number
|
static java.lang.String |
TYPE_OBJECT
type : object
|
static java.lang.String |
TYPE_STRING
type : string
|
Modifier and Type | Required Element and Description |
---|---|
java.lang.String |
description |
Modifier and Type | Optional Element and Description |
---|---|
java.lang.String |
format |
boolean |
multipleValue |
java.lang.String |
name |
java.lang.String |
paramType |
boolean |
required |
java.lang.Class |
typeClass |
java.lang.String |
typeParameterGroup |
java.lang.String |
typeResourceName |
java.lang.Class<? extends ValueProvider> |
valueProviderClass |
java.lang.String[] |
values |
java.lang.String |
valueSamplePath |
public static final java.lang.String BODY_NAME
public static final java.lang.String BODY_DESCRIPTION
public abstract java.lang.String description
public abstract java.lang.String name
public abstract java.lang.String paramType
public abstract java.lang.Class typeClass
public abstract java.lang.String typeResourceName
public abstract java.lang.String typeParameterGroup
public abstract java.lang.String format
FORMAT_INT64
. If the value is set to
FORMAT_NONE
, the format value will be extracted from the
typeClasspublic abstract boolean required
public abstract boolean multipleValue
public abstract java.lang.String[] values
public abstract java.lang.Class<? extends ValueProvider> valueProviderClass