Annotation Type ArraySchema
-
@Target({FIELD,METHOD,PARAMETER,TYPE,ANNOTATION_TYPE}) @Retention(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
andSchema
cannot coexist- See Also:
- Schema (OpenAPI specification),
Schema
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element 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 inschema
.Extension[]
extensions
The list of optional extensionsint
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 arrayboolean
uniqueItems
determines whether an array of items will be unique
-