Top Description Interfaces
module org.eclipse.microprofile.openapi

Package org.eclipse.microprofile.openapi.models.media

Annotations
@Version:3.0
@ProviderType
A set of interfaces for programmable models to represent input and output data types and media types.

The behaviour of methods inherited from java.lang.Object are undefined by the MicroProfile OpenAPI specification.

Example usage: 

.responses(OASFactory.createObject(APIResponses.class)
     .addApiResponse("200", OASFactory.createObject(APIResponse.class)
         .description("Bookings retrieved")
         .content(OASFactory.createObject(Content.class)
             .addMediaType("applictaion/json", OASFactory.createObject(MediaType.class)
                 .schema(OASFactory.createObject(Schema.class)
                     .type(Schema.SchemaType.ARRAY)
                     .ref("#/components.schemas.Booking")))))

Interface Summary

Modifier and TypeInterface and Description
public interface
Content

Content

A map to assist describing the media types for an operation's parameter or response.

public interface
Discriminator

Discriminator

When request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation.

public interface
Encoding

Encoding

public interface
MediaType

MediaType

Each Media Type Object provides a schema and examples for the media type identified by its key.

public interface
Schema

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

public interface
XML

A metadata object that allows for more fine-tuned XML model definitions.