Annotation Interface Content
This object provides schema and examples for a particular media type.
- See Also:
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionEncoding[]
An array of encoding corresponding to a map of property name and its encoding information in MediaType model.An array of examples used to show the use of the associated schema.The media type that this object applies to.The schema defining the type used for the request body.
-
Element Details
-
mediaType
String mediaTypeThe media type that this object applies to.- Returns:
- the media type value
- Default:
- ""
-
examples
ExampleObject[] examplesAn array of examples used to show the use of the associated schema.- Returns:
- the list of examples
- Default:
- {}
-
schema
Schema schemaThe schema defining the type used for the request body.- Returns:
- the schema of this media type
- Default:
- @org.eclipse.microprofile.openapi.annotations.media.Schema
-
encoding
Encoding[] encodingAn array of encoding corresponding to a map of property name and its encoding information in MediaType model. The key, being the property name, MUST exist in the schema as a property.The encoding object SHALL only apply to requestBody objects when the media type is multipart or application/x-www-form-urlencoded.
- Returns:
- the array of encodings
- Default:
- {}
-