Top Description Interfaces
module org.eclipse.microprofile.openapi

Package org.eclipse.microprofile.openapi.models.links

Annotations
@Version:1.0
@ProviderType

An interface of a model to represent a design-time link for a response.

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

Example usage:

 .components(OASFactory.createObject(Components.class)
     .links(new HashMap<String, Link>())
         .addLink("UserName", OASFactory.createObject(Link.class)
             .description("The username corresponding to provided user id")
             .operationId("getUserByName")
             .parameters(new HashMap<String, Object>())
                 .addParameter("userId", "$request.link-path.userId")))

Interface Summary

Modifier and TypeInterface and Description
public interface
Link

Link

The Link object represents a possible design-time link for a response.