io.swagger.oas.annotations

Annotation Type Parameter

@Target(value={PARAMETER,METHOD})
 @Repeatable(value=Parameters.class)
 @Retention(value=RUNTIME)
 @Inherited
public @interface Parameter

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	allowEmptyValue When true, allows sending an empty value.
boolean	allowReserved
ArraySchema	array
Content[]	content
boolean	deprecated
String	description Additional description data to provide on the purpose of the parameter
Explode	explode
boolean	hidden allows parameter to be marked as hidden
String	in the location of the parameter.
String	name the name of the parameter
boolean	required Specifies that the parameter is not optional and must be present
Schema	schema
String	style

Element Detail

name

public abstract String name

the name of the parameter

Default:

""

in

public abstract String in

the location of the parameter. Ignored when empty string

Default:

""

description

public abstract String description

Additional description data to provide on the purpose of the parameter

Default:

""

required

public abstract boolean required

Specifies that the parameter is not optional and must be present

Default:

false

deprecated

public abstract boolean deprecated

Default:

false

allowEmptyValue

public abstract boolean allowEmptyValue

When true, allows sending an empty value. If false, the parameter will be considered \"null\" if no value is present. This may create validation errors when the parameter is required.

Default:

false

style

public abstract String style

Default:

""

explode

public abstract Explode explode

Default:

io.swagger.oas.annotations.enums.Explode.DEFAULT

allowReserved

public abstract boolean allowReserved

Default:

false

schema

public abstract Schema schema

Default:

@io.swagger.oas.annotations.media.Schema

array

public abstract ArraySchema array

Default:

@io.swagger.oas.annotations.media.ArraySchema

content

public abstract Content[] content

Default:

@io.swagger.oas.annotations.media.Content

hidden

public abstract boolean hidden

allows parameter to be marked as hidden

Default:

false