io.swagger.v3.oas.annotations.media

Annotation Type Content

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

The annotation may be used to define the content/media type of a parameter, request or response, by defining it as field Parameter.content(), RequestBody.content() or ApiResponse.content().

If schema() is defined, swagger-jaxrs2 reader engine will consider it along with JAX-RS annotations, element type and context as input to resolve the annotated element into an OpenAPI schema definition for such element.

See Also:

Example (OpenAPI specification), Schema, Parameter, ApiResponse, RequestBody

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Schema	additionalPropertiesSchema The schema properties defined for schema provided in @Schema
ArraySchema	array The schema of the array that defines the type used for the content.
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.
Extension[]	extensions The list of optional extensions
String	mediaType The media type that this object applies to.
Schema	schema The schema defining the type used for the content.
SchemaProperty[]	schemaProperties The schema properties defined for schema provided in @Schema

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 content.

Returns:

the schema of this media type

Default:

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

schemaProperties

public abstract SchemaProperty[] schemaProperties

The schema properties defined for schema provided in @Schema

Returns:

the schema properties

Since:

2.2.0

Default:

{}

additionalPropertiesSchema

public abstract Schema additionalPropertiesSchema

The schema properties defined for schema provided in @Schema

Returns:

the schema properties

Since:

2.2.0

Default:

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

array

public abstract ArraySchema array

The schema of the array that defines the type used for the content.

Returns:

the schema of the array

Default:

@io.swagger.v3.oas.annotations.media.ArraySchema

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:

{}

extensions

public abstract Extension[] extensions

The list of optional extensions

Returns:

an optional array of extensions

Default:

{}