Package de.kosmos_lab.web.annotations.media

Annotation Type Schema

@Target({FIELD,METHOD,PARAMETER,TYPE,ANNOTATION_TYPE})
@Retention(RUNTIME)
@Repeatable(Schemas.class)
@Inherited
public @interface Schema

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Schema.AccessMode	accessMode
String	additionalProperties
Class<?>[]	allOf
String[]	allOfRef
String[]	allowableValues
Class<?>[]	anyOf
String[]	anyOfRef
String	defaultValue
boolean	deprecated
String	description
DiscriminatorMapping[]	discriminatorMapping
String	discriminatorProperty
boolean	enumAsRef
String	example
boolean	exclusiveMaximum
boolean	exclusiveMinimum
Extension[]	extensions
ExternalDocumentation	externalDocs
String	format
boolean	hidden
Class<?>	implementation
String	maximum
int	maxLength
int	maxProperties
String	minimum
int	minLength
int	minProperties
double	multipleOf
String	name
Class<?>	not
String[]	notRef
boolean	nullable
Class<?>[]	oneOf
String[]	oneOfRef
String	pattern
boolean	readOnly	Deprecated.
String	ref
boolean	required
String[]	requiredProperties
Class<?>[]	subTypes
String	title
SchemaType	type
boolean	writeOnly	Deprecated.

Element Detail

implementation

Class<?> implementation

Default:

java.lang.Void.class

not

Class<?> not

Default:

java.lang.Void.class

notRef

String[] notRef

Default:

{}

oneOf

Class<?>[] oneOf

Default:

{}

oneOfRef

String[] oneOfRef

Default:

{}

anyOf

Class<?>[] anyOf

Default:

{}

anyOfRef

String[] anyOfRef

Default:

{}

allOf

Class<?>[] allOf

Default:

{}

allOfRef

String[] allOfRef

Default:

{}

name

String name

Default:

""

title

String title

Default:

""

multipleOf

double multipleOf

Default:

0.0

maximum

String maximum

Default:

""

exclusiveMaximum

boolean exclusiveMaximum

Default:

false

minimum

String minimum

Default:

""

exclusiveMinimum

boolean exclusiveMinimum

Default:

false

maxLength

int maxLength

Default:

2147483647

minLength

int minLength

Default:

0

pattern

String pattern

Default:

""

maxProperties

int maxProperties

Default:

0

minProperties

int minProperties

Default:

0

requiredProperties

String[] requiredProperties

Default:

{}

required

boolean required

Default:

false

description

String description

Default:

""

format

String format

Default:

""

ref

String ref

Default:

""

nullable

boolean nullable

Default:

false

readOnly

@Deprecated
boolean readOnly

Deprecated.

Default:

false

writeOnly

@Deprecated
boolean writeOnly

Deprecated.

Default:

false

accessMode

Schema.AccessMode accessMode

Default:

de.kosmos_lab.web.annotations.media.Schema.AccessMode.AUTO

example

String example

Default:

""

externalDocs

ExternalDocumentation externalDocs

Default:

@de.kosmos_lab.web.annotations.ExternalDocumentation

deprecated

boolean deprecated

Default:

false

type

SchemaType type

Default:

de.kosmos_lab.web.annotations.enums.SchemaType.DEFAULT

allowableValues

String[] allowableValues

Default:

{}

defaultValue

String defaultValue

Default:

""

discriminatorProperty

String discriminatorProperty

Default:

""

discriminatorMapping

DiscriminatorMapping[] discriminatorMapping

Default:

{}

hidden

boolean hidden

Default:

false

enumAsRef

boolean enumAsRef

Default:

false

subTypes

Class<?>[] subTypes

Default:

{}

extensions

Extension[] extensions

Default:

{}

additionalProperties

String additionalProperties

Default:

""