@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 |
cf
Synonym for
collectionFormat() . |
String |
collectionFormat
|
String[] |
df
Synonym for
_default() . |
String[] |
e
Synonym for
_enum() . |
boolean |
emax
Synonym for
exclusiveMaximum() . |
boolean |
emin
Synonym for
exclusiveMinimum() . |
boolean |
exclusiveMaximum
|
boolean |
exclusiveMinimum
|
String |
f
Synonym for
format() . |
String |
format
|
SubItems |
items
|
String |
max
Synonym for
maximum() . |
long |
maxi
Synonym for
maxItems() . |
String |
maximum
|
long |
maxItems
|
long |
maxl
Synonym for
maxLength() . |
long |
maxLength
|
String |
min
Synonym for
minimum() . |
long |
mini
Synonym for
minItems() . |
String |
minimum
|
long |
minItems
|
long |
minl
Synonym for
minLength() . |
long |
minLength
|
String |
mo
Synonym for
multipleOf() . |
String |
multipleOf
|
String |
p
Synonym for
pattern() . |
String |
pattern
|
String |
t
Synonym for
type() . |
String |
type
|
boolean |
ui
Synonym for
uniqueItems() . |
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 cf
collectionFormat()
.public abstract String pattern
public abstract String maximum
public abstract String minimum
public abstract String multipleOf
public abstract String mo
multipleOf()
.public abstract long maxLength
public abstract long maxl
maxLength()
.public abstract long minLength
public abstract long minl
minLength()
.public abstract long maxItems
public abstract long maxi
maxItems()
.public abstract long minItems
public abstract long mini
minItems()
.public abstract boolean exclusiveMaximum
public abstract boolean emax
exclusiveMaximum()
.public abstract boolean exclusiveMinimum
public abstract boolean emin
exclusiveMinimum()
.public abstract boolean uniqueItems
public abstract boolean ui
uniqueItems()
.public abstract String[] _default
public abstract String[] df
_default()
.public abstract String[] _enum
public abstract String $ref
public abstract String[] value
This is a Overview > juneau-marshall > JSON Details > Simplified 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–2020 The Apache Software Foundation. All rights reserved.