@Documented @Retention(value=RUNTIME) public @interface Items
A limited subset of JSON-Schema's items object.
Used to populate the auto-generated Swagger documentation and UI for server-side
Also used to define OpenAPI schema information for POJOs serialized through OpenApiSerializer
and parsed through OpenApiParser
.
Modifier and Type | Optional Element and Description |
---|---|
String[] |
_default
|
String[] |
_enum
|
String |
$ref
|
String |
collectionFormat
|
boolean |
exclusiveMaximum
|
boolean |
exclusiveMinimum
|
String |
format
|
SubItems |
items
|
String |
maximum
|
long |
maxItems
|
long |
maxLength
|
String |
minimum
|
long |
minItems
|
long |
minLength
|
String |
multipleOf
|
String |
pattern
|
String |
type
|
boolean |
uniqueItems
|
String[] |
value
Free-form value for the Swagger Items Object.
|
public abstract String type
public abstract String format
public abstract String collectionFormat
public abstract String pattern
public abstract String maximum
public abstract String minimum
public abstract String multipleOf
public abstract long maxLength
public abstract long minLength
public abstract long maxItems
public abstract long minItems
public abstract boolean exclusiveMaximum
public abstract boolean exclusiveMinimum
public abstract boolean uniqueItems
public abstract String[] _default
public abstract String[] _enum
public abstract String $ref
public abstract String[] value
This is a Simple JSON object that makes up the swagger information for this field.
The following are completely equivalent ways of defining the swagger description of an Items object:
The reasons why you may want to use this field include:
Copyright © 2016–2019 The Apache Software Foundation. All rights reserved.