Top Description Annotations
module org.eclipse.microprofile.openapi

Package org.eclipse.microprofile.openapi.annotations.media

Annotations
@Version:1.3
@ProviderType

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")))

Annotation Summary

Modifier and TypeAnnotation and Description
public @interface
Content

This object provides schema and examples for a particular media type.

public @interface
DependentRequired

A property name and an associated list of other property names.

public @interface
DependentSchema

A property name and an associated schema.

public @interface
DiscriminatorMapping

This object maps payload values to a particular Schema.

public @interface
Encoding

Single encoding definition to be applied to single Schema Object

public @interface
ExampleObject

This object illustrates an example of a particular content

public @interface
PatternProperty

A regular expression and an associated schema.

public @interface
Schema

The Schema Object allows the definition of input and output data types.

public @interface
SchemaProperty

The SchemaProperty Object allows the definition of input and output data types nested within the properties attribute of a Schema annotation.