io.swagger.v3.oas.annotations.media

Annotation Type ArraySchema

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

The annotation may be used to define a schema of type "array" for a set of elements of the OpenAPI spec, and/or to define additional properties for the schema. It is applicable e.g. to parameters, schema classes (aka "models"), properties of such models, request and response content, header.

swagger-core resolver and swagger-jaxrs2 reader engine consider this annotation along with JAX-RS annotations, element type and context as input to resolve the annotated element into an OpenAPI schema definition for such element.

The annotation Schema shall be used for non array elements; ArraySchema and Schema cannot coexist

See Also:

Schema (OpenAPI specification), Schema

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Schema	arraySchema Allows to define the properties to be resolved into properties of the schema of type `array` (not the ones of the `items` of such schema which are defined in schema.
Extension[]	extensions The list of optional extensions
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.v3.oas.annotations.media.Schema

arraySchema

public abstract Schema arraySchema

Allows to define the properties to be resolved into properties of the schema of type `array` (not the ones of the `items` of such schema which are defined in schema.

Returns:

arraySchema

Since:

2.0.2

Default:

@io.swagger.v3.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

extensions

public abstract Extension[] extensions

The list of optional extensions

Returns:

an optional array of extensions

Default:

{}