MicroProfile 7.0 · org.eclipse.microprofile.openapi.annotations.media.Schema

Modifier and Type	Class and Description
public static class	Schema.False Marker class to indicate that a boolean `false` schema should be used.
public static class	Schema.True Marker class to indicate that a boolean `true` schema should be used.

Method Summary

Modifier and Type	Method and Description
public Class<?>	Returns: a class that describes the allowable schema for additional properties not explicitly defined additionalProperties() Provides a Java class as implementation for additional properties that may be present in instances of this schema.
public Class<?>[]	Returns: the list of classes to match allOf() Provides an array of java class implementations which can be used to describe multiple acceptable schemas.
public Class<?>[]	Returns: the list of possible class matches anyOf() Provides an array of java class implementations which can be used to describe multiple acceptable schemas.
public String	Returns: the comment comment() A comment to be included in the schema This value is set in the `$comment` property of the schema object
public String	Returns: the value which the instance must be equal to, expressed according to the type of the schema constValue() Requires that the instance must be a specific value.
public Class<?>	Returns: a class used to create a schema which at least one element of an array instance must validate against contains() A schema which at least one element of an array instance must validate against.
public String	Returns: the encoding contentEncoding() The encoding used to allow binary data to be stored in a string.
public String	Returns: the media type of the data in a string contentMediaType() The media type of the data in a string.
public Class<?>	Returns: a class used to create a schema used to validate the data in a string contentSchema() The schema that data in a string must validate against.
public String	Returns: the default value of this schema defaultValue() Provides a default value.
public DependentRequired[]	Returns: the properties required if certain other properties are present dependentRequired() Specifies that certain properties must be present if other properties are present.
public DependentSchema[]	Returns: an array of DependentSchema entries dependentSchemas() Schemas which an instance must validate against if the instance has certain properties.
public boolean	Returns: whether or not this schema is deprecated deprecated() Specifies that a schema is deprecated and SHOULD be transitioned out of usage.
public String	Returns: this schema's description description() A description of the schema.
public DiscriminatorMapping[]	Returns: the discriminator mappings for this schema discriminatorMapping() An array of discriminator mappings.
public String	Returns: the discriminator property discriminatorProperty() Provides a discriminator property value.
public Class<?>	Returns: a class used to create the `else` schema elseSchema() A class used to create a schema that an instance must validate against if it does not validate against the `if` schema.
public String[]	Returns: a list of allowed schema values enumeration() Provides a list of enum values.
public String	Returns: an example of this schema example() Deprecated since 4.0. use `examples()` A free-form property to include an example of an instance for this schema.
public String[]	Returns: an array of examples of this schema examples() A free-form property to include examples of an instance for this schema.
public boolean	Returns: the exclusive maximum value for this schema exclusiveMaximum() If true, makes the maximum value exclusive, or a less-than criteria.
public boolean	Returns: the exclusive minimum value for this schema exclusiveMinimum() If true, makes the minimum value exclusive, or a greater-than criteria.
public Extension[]	Returns: array of extensions extensions() List of extensions to be added to the `Schema` model corresponding to the containing annotation.
public ExternalDocumentation	Returns: additional schema documentation externalDocs() Additional external documentation for this schema.
public String	Returns: this schema's format format() Provides an optional override for the format.
public boolean	Returns: whether or not this schema is hidden hidden() Allows schema to be marked as hidden.
public Class<?>	Returns: a class used to create the `if` schema ifSchema() A class used to create a schema used to control conditional evaluation.
public Class<?>	Returns: a class that implements this schema implementation() Provides a java class as implementation for this schema.
public int	Returns: the maximum number of elements which may validate against the `contains()` schema maxContains() Specifies the maximum number of elements which may validate against the `contains()` schema.
public String	Returns: the maximum value for this schema maximum() Sets the maximum numeric value for a property.
public int	Returns: the maximum number of items in this array maxItems() Only applicable if type=array.
public int	Returns: the maximum length of this schema maxLength() Sets the maximum length of a string value.
public int	Returns: the maximum number of properties for this schema maxProperties() Constrains the number of arbitrary properties when additionalProperties is defined.
public int	Returns: the minimum number of elements which must validate against the `contains()` schema minContains() Specifies the minimum number of elements which must validate against the `contains()` schema.
public String	Returns: the minimum value for this schema minimum() Sets the minimum numeric value for a property.
public int	Returns: the minimum number of items in this array minItems() Only applicable if type=array.
public int	Returns: the minimum length of this schema minLength() Sets the minimum length of a string value.
public int	Returns: the minimum number of properties for this schema minProperties() Constrains the number of arbitrary properties when additionalProperties is defined.
public double	Returns: the multiplier constraint of the schema multipleOf() Constrains a value such that when divided by the multipleOf, the result must be an integer.
public String	Returns: the name of the schema name() The name of the schema or property.
public Class<?>	Returns: a class with disallowed properties not() Provides a java class to be used to disallow matching properties.
public boolean	Returns: whether or not this schema is nullable nullable() Allows sending a null value for the defined schema.
public Class<?>[]	Returns: the list of possible classes for a single match oneOf() Provides an array of java class implementations which can be used to describe multiple acceptable schemas.
public String	Returns: the ECMA-262 regular expression to match against pattern() A regular expression that the value must satisfy.
public PatternProperty[]	Returns: a mapping from regular expressions to schemas patternProperties() Applies subschemas against properties matched by regular expressions.
public Class<?>[]	Returns: an array of classes used to create an array of schemas used to validate the leading elements of an array instance prefixItems() Schemas which the leading elements of an array instance must validate against.
public SchemaProperty[]	Returns: a list of defined properties properties() Provides a list of properties present in this schema.
public Class<?>	Returns: a schema that property names must validate against propertyNames() A schema which the names of properties of an object instance must validate against.
public boolean	Returns: whether or not this schema is read only readOnly() Declares the property as "read only".
public String	Returns: a reference to a schema definition ref() Reference value to a Schema definition.
public boolean	Returns: whether or not this schema is required required() Specifies whether the annotated item is required or not.
public String[]	Returns: the list of required schema properties requiredProperties() Allows multiple properties in an object to be marked as required.
public Class<?>	Returns: a class used to create the `then` schema thenSchema() A class used to create a schema that an instance must validate against if it validates against the `if` schema.
public String	Returns: the title of the schema title() A title to explain the purpose of the schema.
public SchemaType	Returns: the type of this schema type() Provides an override for the basic type of the schema.
public boolean	Returns: whether the items in this array are unique uniqueItems() Only applicable if type=array.
public boolean	Returns: whether or not this schema is write only writeOnly() Declares the property as "write only".

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

additionalProperties back to summary

additionalProperties	back to summary
public Class<?> additionalProperties() Provides a Java class as implementation for additional properties that may be present in instances of this schema. If no additional properties are allowed, the value of this property should be set to `False.class` which will be rendered as boolean `false` in the resulting OpenAPI document. The default value `Void.class` will result in no `additionalProperties` attribute being generated in the resulting OpenAPI document. The effective value in that case is `true` per the OpenAPI specification. Implementations MAY ignore this property if this schema's type is not OBJECT, either explicitly or as derived by the placement of the annotation. Returns:Class<?> a class that describes the allowable schema for additional properties not explicitly defined Since 3.1 See Also `True`, `False`

public Class<?> additionalProperties()

Provides a Java class as implementation for additional properties that may be present in instances of this schema.

If no additional properties are allowed, the value of this property should be set to False.class which will be rendered as boolean false in the resulting OpenAPI document.

The default value Void.class will result in no additionalProperties attribute being generated in the resulting OpenAPI document. The effective value in that case is true per the OpenAPI specification.

Implementations MAY ignore this property if this schema's type is not OBJECT, either explicitly or as derived by the placement of the annotation.

Returns:Class<?>: a class that describes the allowable schema for additional properties not explicitly defined
Since: 3.1
See Also: True, False

allOf	back to summary
public Class<?>[] allOf() Provides an array of java class implementations which can be used to describe multiple acceptable schemas. If all match, the schema will be considered valid. Returns:Class<?>[] the list of classes to match

allOf

public @Interface Schema

Defining subschemas

Nested and Inner Type Summary

Method Summary

Method Detail

public final Class Schema.False

Constructor Summary

Method Summary

Constructor Detail

public final Class Schema.True

Constructor Summary

Method Summary

Constructor Detail