io.swagger.oas.annotations.media

Annotation Type Content

@Target(value=FIELD)
 @Retention(value=RUNTIME)
 @Inherited
public @interface Content

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

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Encoding[]	encoding An array of encodings The key, being the property name, MUST exist in the schema as a property.
ExampleObject[]	examples An array of examples used to show the use of the associated schema.
String	mediaType The media type that this object applies to.
Schema	schema The schema defining the type used for the request body.

Element Detail

mediaType

public abstract String mediaType

The media type that this object applies to.

Returns:

the media type value

Default:

""

examples

public abstract ExampleObject[] examples

An array of examples used to show the use of the associated schema.

Returns:

the list of examples

Default:

{}

schema

public abstract Schema schema

The schema defining the type used for the request body.

Returns:

the schema of this media type

Default:

@io.swagger.oas.annotations.media.Schema

encoding

public abstract Encoding[] encoding

An array of encodings The key, being the property name, MUST exist in the schema as a property.

Returns:

the array of encodings

Default:

{}