Annotation Interface Schema
- See Also:
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionClass<?>[]
Provides an array of java class implementations which can be used to describe multiple acceptable schemas.Class<?>[]
Provides an array of java class implementations which can be used to describe multiple acceptable schemas.Provides a default value.boolean
Specifies that a schema is deprecated and SHOULD be transitioned out of usage.A description of the schema.An array of discriminator mappings.Provides a discriminator property value.String[]
Provides a list of enum values.A free-form property to include an example of an instance for this schema.boolean
If true, makes the maximum value exclusive, or a less-than criteria.boolean
If true, makes the minimum value exclusive, or a greater-than criteria.Additional external documentation for this schema.Provides an optional override for the format.boolean
Allows schema to be marked as hidden.Class<?>
Provides a java class as implementation for this schema.Sets the maximum numeric value for a property.int
Only applicable if type=array.int
Sets the maximum length of a string value.int
Constrains the number of arbitrary properties when additionalProperties is defined.Sets the minimum numeric value for a property.int
Only applicable if type=array.int
Sets the minimum length of a string value.int
Constrains the number of arbitrary properties when additionalProperties is defined.double
Constrains a value such that when divided by the multipleOf, the remainder must be an integer.The name of the schema or property.Class<?>
Provides a java class to be used to disallow matching properties.boolean
Allows sending a null value for the defined schema.Class<?>[]
Provides an array of java class implementations which can be used to describe multiple acceptable schemas.A pattern that the value must satisfy.Provides a list of properties present in this schema.boolean
Relevant only for Schema "properties" definitions.Reference value to a Schema definition.boolean
Mandates whether the annotated item is required or not.String[]
Allows multiple properties in an object to be marked as required.A title to explain the purpose of the schema.Provides an override for the basic type of the schema.boolean
Only applicable if type=array.boolean
Relevant only for Schema "properties" definitions.
-
Element Details
-
implementation
Class<?> implementationProvides a java class as implementation for this schema. When provided, additional information in the Schema annotation (except for type information) will augment the java class after introspection.- Returns:
- a class that implements this schema
- Default:
- java.lang.Void.class
-
not
Class<?> notProvides a java class to be used to disallow matching properties. Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.- Returns:
- a class with disallowed properties
- Default:
- java.lang.Void.class
-
oneOf
Class<?>[] oneOfProvides an array of java class implementations which can be used to describe multiple acceptable schemas. If more than one match the derived schemas, a validation error will occur.Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
- Returns:
- the list of possible classes for a single match
- Default:
- {}
-
anyOf
Class<?>[] anyOfProvides an array of java class implementations which can be used to describe multiple acceptable schemas. If any match, the schema will be considered valid.Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
- Returns:
- the list of possible class matches
- Default:
- {}
-
allOf
Class<?>[] allOfProvides an array of java class implementations which can be used to describe multiple acceptable schemas. If all match, the schema will be considered valid.Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
- Returns:
- the list of classes to match
- Default:
- {}
-
name
String nameThe name of the schema or property.The name is REQUIRED when the schema is defined within
Components
. The name will be used as the key to add this schema to the 'schemas' map for reuse.- Returns:
- the name of the schema
- Default:
- ""
-
title
String titleA title to explain the purpose of the schema.- Returns:
- the title of the schema
- Default:
- ""
-
multipleOf
double multipleOfConstrains a value such that when divided by the multipleOf, the remainder must be an integer. Ignored if the value is 0.- Returns:
- the multiplier constraint of the schema
- Default:
- 0.0
-
maximum
String maximumSets the maximum numeric value for a property. Value must be a valid number. Ignored if the value is an empty string or not a number.- Returns:
- the maximum value for this schema
- Default:
- ""
-
exclusiveMaximum
boolean exclusiveMaximumIf true, makes the maximum value exclusive, or a less-than criteria.- Returns:
- the exclusive maximum value for this schema
- Default:
- false
-
minimum
String minimumSets the minimum numeric value for a property. Value must be a valid number. Ignored if the value is an empty string or not a number.- Returns:
- the minimum value for this schema
- Default:
- ""
-
exclusiveMinimum
boolean exclusiveMinimumIf true, makes the minimum value exclusive, or a greater-than criteria.- Returns:
- the exclusive minimum value for this schema
- Default:
- false
-
maxLength
int maxLengthSets the maximum length of a string value. Ignored if the value is negative.- Returns:
- the maximum length of this schema
- Default:
- 2147483647
-
minLength
int minLengthSets the minimum length of a string value. Ignored if the value is negative.- Returns:
- the minimum length of this schema
- Default:
- 0
-
pattern
String patternA pattern that the value must satisfy. Ignored if the value is an empty string.- Returns:
- the pattern of this schema
- Default:
- ""
-
maxProperties
int maxPropertiesConstrains the number of arbitrary properties when additionalProperties is defined. Ignored if value is 0.- Returns:
- the maximum number of properties for this schema
- Default:
- 0
-
minProperties
int minPropertiesConstrains the number of arbitrary properties when additionalProperties is defined. Ignored if value is 0.- Returns:
- the minimum number of properties for this schema
- Default:
- 0
-
requiredProperties
String[] requiredPropertiesAllows multiple properties in an object to be marked as required.- Returns:
- the list of required schema properties
- Default:
- {}
-
required
boolean requiredMandates whether the annotated item is required or not.- Returns:
- whether or not this schema is required
- Default:
- false
-
description
String descriptionA description of the schema.- Returns:
- this schema's description
- Default:
- ""
-
format
String formatProvides an optional override for the format.If a consumer is unaware of the meaning of the format, they shall fall back to using the basic type without format. For example, if \"type: integer, format: int128\" were used to designate a very large integer, most consumers will not understand how to handle it, and fall back to simply \"type: integer\"
- Returns:
- this schema's format
- Default:
- ""
-
ref
String refReference value to a Schema definition.This property provides a reference to an object defined elsewhere. This property and all other properties are mutually exclusive. If other properties are defined in addition to the ref property then the result is undefined.
- Returns:
- a reference to a schema definition
- Default:
- ""
-
nullable
boolean nullableAllows sending a null value for the defined schema.- Returns:
- whether or not this schema is nullable
- Default:
- false
-
readOnly
boolean readOnlyRelevant only for Schema "properties" definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request.If the property is marked as readOnly being true and is in the required list, the required will take effect on the response only. A property MUST NOT be marked as both readOnly and writeOnly being true.
- Returns:
- whether or not this schema is read only
- Default:
- false
-
writeOnly
boolean writeOnlyRelevant only for Schema "properties" definitions. Declares the property as "write only". Therefore, it MAY be sent as part of a request but SHOULD NOT be sent as part of the response.If the property is marked as writeOnly being true and is in the required list, the required will take effect on the request only. A property MUST NOT be marked as both readOnly and writeOnly being true.
- Returns:
- whether or not this schema is write only
- Default:
- false
-
example
String exampleA free-form property to include an example of an instance for this schema.To represent examples that cannot be naturally represented in JSON or YAML, a string value is used to contain the example with escaping where necessary.
When associated with a specific media type, the example string shall be parsed by the consumer to be treated as an object or an array.- Returns:
- an example of this schema
- Default:
- ""
-
externalDocs
ExternalDocumentation externalDocsAdditional external documentation for this schema.- Returns:
- additional schema documentation
- Default:
- @org.eclipse.microprofile.openapi.annotations.ExternalDocumentation
-
deprecated
boolean deprecatedSpecifies that a schema is deprecated and SHOULD be transitioned out of usage.- Returns:
- whether or not this schema is deprecated
- Default:
- false
-
type
SchemaType typeProvides an override for the basic type of the schema.Value MUST be a string. Multiple types via an array are not supported.
MUST be a valid type per the OpenAPI Specification.- Returns:
- the type of this schema
- Default:
- DEFAULT
-
enumeration
String[] enumerationProvides a list of enum values. Corresponds to the enum property in the OAS schema and the enumeration property in the schema model.- Returns:
- a list of allowed schema values
- Default:
- {}
-
defaultValue
String defaultValueProvides a default value. The default value represents what would be assumed by the consumer of the input as the value of the schema if one is not provided.Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object defined at the same level.
For example, if type is string, then default can be "foo" but cannot be 1.- Returns:
- the default value of this schema
- Default:
- ""
-
discriminatorProperty
String discriminatorPropertyProvides a discriminator property value. Adds support for polymorphism.The discriminator is an object name that is used to differentiate between other schemas which may satisfy the payload description.
- Returns:
- the discriminator property
- Default:
- ""
-
discriminatorMapping
DiscriminatorMapping[] discriminatorMappingAn array of discriminator mappings.- Returns:
- the discriminator mappings for this schema
- Default:
- {}
-
maxItems
int maxItemsOnly applicable if type=array. Sets the maximum number of items in an array. This integer MUST be greater than, or equal to, 0.An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword.
Ignored if value is Integer.MIN_VALUE.- Returns:
- the maximum number of items in this array
- Default:
- -2147483648
-
minItems
int minItemsOnly applicable if type=array. Sets the minimum number of items in an array. This integer MUST be greater than, or equal to, 0.An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword.
Ignored if value is Integer.MAX_VALUE.- Returns:
- the minimum number of items in this array
- Default:
- 2147483647
-
uniqueItems
boolean uniqueItemsOnly applicable if type=array. Determines if the items in the array SHOULD be unique.If false, the instance validates successfully. If true, the instance validates successfully if all of its elements are unique.
- Returns:
- whether the items in this array are unique
- Default:
- false
-
properties
SchemaProperty[] propertiesProvides a list of properties present in this schema. Use of the properties list does not preclude the annotation scanning runtime from also including other properties found in the scan process. For example, if animplementation
is also specified, the final set of properties used by the annotation scanner will include properties from both this list and those found from introspection of the implementation class, if any.In the case where properties are specified here in addition to an
implementation
, the attributes given for a property using aSchemaProperty
will override the same attributes scanned (or derived) from the implementation class.Example:
@Schema(properties = { @SchemaProperty(name = "creditCard", example = "4567100043210001"), @SchemaProperty(name = "departureFlight", description = "The departure flight information."), @SchemaProperty(name = "returningFlight") })
- Returns:
- a list of defined properties
- Since:
- 2.0
- Default:
- {}
-