org.apache.juneau.jsonschema.annotation

Annotation Type SubItems

@Documented
 @Retention(value=RUNTIME)
public @interface SubItems

Swagger items annotation.

This class is essentially identical to Items except it's used for defining items of items.

Since annotations cannot be nested, we're forced to create a separate annotation for it.
If you want to nest items further, you have to define them free-form using items() as free-form JSON.

• Overview > juneau-rest-server > Swagger
• Swagger Items Object

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	_default default field of the Swagger Items Object.
String[]	_enum enum field of the Swagger Items Object.
String	$ref $ref field of the Swagger Items Object.
String	collectionFormat collectionFormat field of the Swagger Items Object.
boolean	exclusiveMaximum exclusiveMaximum field of the Swagger Items Object.
boolean	exclusiveMinimum exclusiveMinimum field of the Swagger Items Object.
String	format format field of the Swagger Items Object.
String[]	items items field of the Swagger Items Object.
String	maximum maximum field of the Swagger Items Object.
long	maxItems maxItems field of the Swagger Items Object.
long	maxLength maxLength field of the Swagger Items Object.
String	minimum minimum field of the Swagger Items Object.
long	minItems minItems field of the Swagger Items Object.
long	minLength minLength field of the Swagger Items Object.
String	multipleOf multipleOf field of the Swagger Items Object.
String	pattern pattern field of the Swagger Items Object.
String	type type field of the Swagger Items Object.
boolean	uniqueItems uniqueItems field of the Swagger Items Object.
String[]	value Free-form value for the Swagger Items Object.

Element Detail

type

public abstract String type

type field of the Swagger Items Object.

• The format is a plain-text string.
• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

Default:

""

format

public abstract String format

format field of the Swagger Items Object.

• The format is a plain-text string.
• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

Default:

""

collectionFormat

public abstract String collectionFormat

collectionFormat field of the Swagger Items Object.

• The format is a plain-text string.
• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

Default:

""

pattern

public abstract String pattern

pattern field of the Swagger Items Object.

• The format is a plain-text string.
• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

Default:

""

maximum

public abstract String maximum

maximum field of the Swagger Items Object.

• The format is a plain-text string.
• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

Default:

""

minimum

public abstract String minimum

minimum field of the Swagger Items Object.

• The format is a plain-text string.
• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

Default:

""

multipleOf

public abstract String multipleOf

multipleOf field of the Swagger Items Object.

• The format is a plain-text string.
• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

Default:

""

maxLength

public abstract long maxLength

maxLength field of the Swagger Items Object.

• The format is a plain-text string.
• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

Default:

-1L

minLength

public abstract long minLength

minLength field of the Swagger Items Object.

• The format is a plain-text string.
• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

Default:

-1L

maxItems

public abstract long maxItems

maxItems field of the Swagger Items Object.

• The format is a plain-text string.
• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

Default:

-1L

minItems

public abstract long minItems

minItems field of the Swagger Items Object.

• The format is a plain-text string.
• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

Default:

-1L

exclusiveMaximum

public abstract boolean exclusiveMaximum

exclusiveMaximum field of the Swagger Items Object.

• The format is a plain-text string.
• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

Default:

false

exclusiveMinimum

public abstract boolean exclusiveMinimum

exclusiveMinimum field of the Swagger Items Object.

• The format is a plain-text string.
• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

Default:

false

uniqueItems

public abstract boolean uniqueItems

uniqueItems field of the Swagger Items Object.

• The format is a plain-text string.
• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

Default:

false

_default

public abstract String[] _default

default field of the Swagger Items Object.

• The format is a plain-text string.
• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

Default:

{}

_enum

public abstract String[] _enum

enum field of the Swagger Items Object.

• The format is a plain-text string.
• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

Default:

{}

$ref

public abstract String $ref

$ref field of the Swagger Items Object.

• The format is a plain-text string.
• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

Default:

""

items

public abstract String[] items

items field of the Swagger Items Object.

Describes the type of items in the array.

This is a Simple JSON object.
It must be declared free-form because it's not possible to nest annotations in Java.

Default:

{}

value

public abstract String[] value

Free-form value for the Swagger Items Object.

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:

// Normal @Query( name="status", type="array", items=@Items( type="string", _enum="AVAILABLE,PENDING,SOLD", _default="AVAILABLE" ) )

// Free-form @Query( name="status", type="array", items=@Items({ "type: 'string'", "enum: ['AVAILABLE','PENDING','SOLD'],", "default: 'AVAILABLE'" }) )

// Free-form as part of parent @Query( name="status", api={ "type:'array',", "items: {", "type: 'string',", "enum: ['AVAILABLE','PENDING','SOLD'],", "default: 'AVAILABLE'", "}") } )

// Free-form with variables @Query( name="status", type="array", items=@Items("$L{statusItemsSwagger}") )

// Contents of MyResource.properties statusItemsSwagger = { type: "string", enum: ["AVAILABLE","PENDING","SOLD"], default: "AVAILABLE" }

The reasons why you may want to use this field include:

• You want to pull in the entire Swagger JSON definition for this field from an external source such as a properties file.
• You want to add extra fields to the Swagger documentation that are not officially part of the Swagger specification.

• Note that the only swagger field you can't specify using this value is "name" whose value needs to be known during servlet initialization.
• The format is a Simple JSON object.
• The leading/trailing { } characters are optional.
  The following two example are considered equivalent:

  @Items(api="{type: 'string'}")

  @Items(api="type: 'string'")

• Multiple lines are concatenated with newlines so that you can format the value to be readable.
• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").
• Values defined in this field supersede values pulled from the Swagger JSON file and are superseded by individual values defined on this annotation.

Default:

{}