io.swagger.oas.annotations.media

Annotation Type ArraySchema

@Target(value={FIELD,METHOD,PARAMETER,TYPE})
 @Retention(value=RUNTIME)
 @Inherited
public @interface ArraySchema

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	maxItems sets the maximum number of items in an array.
int	minItems sets the minimum number of items in an array.
Schema	schema The schema of the items in the array
boolean	uniqueItems determines whether an array of items will be unique

Element Detail

schema

public abstract Schema schema

The schema of the items in the array

Returns:

schema

Default:

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

maxItems

public abstract int maxItems

sets the maximum number of items in an array. Ignored if value is Integer.MIN_VALUE.

Returns:

integer representing maximum number of items in array

Default:

-2147483648

minItems

public abstract int minItems

sets the minimum number of items in an array. Ignored if value is Integer.MAX_VALUE.

Returns:

integer representing minimum number of items in array

Default:

2147483647

uniqueItems

public abstract boolean uniqueItems

determines whether an array of items will be unique

Returns:

boolean - whether items in an array are unique or repeating

Default:

false