@Version("1.2") @ProviderType
Package org.eclipse.microprofile.openapi.annotations.media
A set of annotations to represent input and output data type, media type and relevant examples.
Example usage:
content = @Content( examples = @ExampleObject( name = "example", value = "1")))
-
Class Summary Class Description Schema.False Marker class for use inadditionalProperties
to indicate that the corresponding schema'sadditionalPropertiesBoolean
value is to be set to booleanfalse
.Schema.True Marker class for use inadditionalProperties
to indicate that the corresponding schema'sadditionalPropertiesBoolean
value is to be set to booleantrue
. -
Annotation Types Summary Annotation Type Description Content This object provides schema and examples for a particular media type.DiscriminatorMapping This object maps payload values to a particular Schema.Encoding Single encoding definition to be applied to single Schema ObjectExampleObject This object illustrates an example of a particular contentSchema The Schema Object allows the definition of input and output data types.SchemaProperty The SchemaProperty Object allows the definition of input and output data types nested within theproperties
attribute of aSchema
annotation.