Top Description Interfaces
module org.eclipse.microprofile.openapi

Package org.eclipse.microprofile.openapi.models.examples

Annotations
@Version:1.0
@ProviderType

An interface to represent a programmable model of an example of a data type or a media type.

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

Example usage:

.components(OASFactory.createObject(Components.class)
     .examples(new HashMap<String, Example>())
         .addExample("review", OASFactory.createObject(Example.class)
             .summary("External review example")
             .description("This example exemplifies the content on our site.")
             .externalValue("http://foo.bar/examples/review-example.json"))
         .addExample("user", OASFactory.createObject(Example.class)
             .summary("External user example")
             .externalValue("http://foo.bar/examples/user-example.json"))

Interface Summary

Modifier and TypeInterface and Description
public interface
Example

Example

An object containing sample data for the related object.