@Target(value={FIELD,METHOD,PARAMETER,TYPE,ANNOTATION_TYPE}) @Retention(value=RUNTIME) @Inherited public @interface ArraySchema
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
Schema
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
|
public abstract Schema schema
public abstract int maxItems
public abstract int minItems
public abstract boolean uniqueItems
public abstract Extension[] extensions
Copyright © 2022. All rights reserved.