Package de.kosmos_lab.web.annotations

Annotation Type Parameter

@Target({PARAMETER,LOCAL_VARIABLE,METHOD,FIELD,ANNOTATION_TYPE,TYPE})
@Retention(RUNTIME)
@Repeatable(Parameters.class)
@Inherited
public @interface Parameter

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
ParameterIn	in

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	allowEmptyValue
boolean	allowReserved
ArraySchema	array
String	componentName
Content[]	content
boolean	deprecated
String	description
String	example
ExampleObject[]	examples
Explode	explode
Extension[]	extensions
boolean	hidden
String	name
String	ref
boolean	required
Schema	schema
ParameterStyle	style

Element Detail

in

ParameterIn in

componentName

String componentName

Default:

""

name

String name

Default:

""

description

String description

Default:

""

required

boolean required

Default:

false

deprecated

boolean deprecated

Default:

false

allowEmptyValue

boolean allowEmptyValue

Default:

false

style

ParameterStyle style

Default:

de.kosmos_lab.web.annotations.enums.ParameterStyle.DEFAULT

explode

Explode explode

Default:

de.kosmos_lab.web.annotations.enums.Explode.DEFAULT

allowReserved

boolean allowReserved

Default:

false

schema

Schema schema

Default:

@de.kosmos_lab.web.annotations.media.Schema

array

ArraySchema array

Default:

@de.kosmos_lab.web.annotations.media.ArraySchema

content

Content[] content

Default:

{}

hidden

boolean hidden

Default:

false

examples

ExampleObject[] examples

Default:

{}

example

String example

Default:

""

extensions

Extension[] extensions

Default:

{}

ref

String ref

Default:

""