org.eclipse.microprofile.openapi.annotations.links

Annotation Type Link

@Target(value={})
 @Retention(value=RUNTIME)
 @Inherited
public @interface Link

The Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.

See Also:

OpenAPI Specification Link Object

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description A description of the link.
String	name The name of this link.
String	operationId The name of an existing, resolvable OAS operation, as defined with a unique operationId.
String	operationRef A relative or absolute reference to an OAS operation.
LinkParameter[]	parameters Array of parameters to pass to an operation as specified with operationId or identified via operationRef.
String	ref Reference value to a Link object.
String	requestBody A literal value or {expression} to use as a request body when calling the target operation.
Server	server An alternative server to service this operation.

Element Detail

name

public abstract String name

The name of this link.

The name is REQUIRED when the link is defined within Components. The name will be used as the key to add this link to the 'links' map for reuse.

Returns:

the link's name

Default:

""

operationRef

public abstract String operationRef

A relative or absolute reference to an OAS operation. This field is mutually exclusive of the operationId field, and must point to an Operation Object. Relative operationRef values may be used to locate an existing Operation Object in the OpenAPI definition. Ignored if the operationId property is specified.

Returns:

an operation reference

Default:

""

operationId

public abstract String operationId

The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.

Returns:

an operation ID

Default:

""

parameters

public abstract LinkParameter[] parameters

Array of parameters to pass to an operation as specified with operationId or identified via operationRef.

Returns:

the list of parameters for this link

Default:

{}

description

public abstract String description

A description of the link. CommonMark syntax may be used for rich text representation.

Returns:

the link's description

Default:

""

requestBody

public abstract String requestBody

A literal value or {expression} to use as a request body when calling the target operation.

Returns:

the request body of this link

Default:

""

server

public abstract Server server

An alternative server to service this operation.

Returns:

the server associated to this link

Default:

@org.eclipse.microprofile.openapi.annotations.servers.Server

ref

public abstract String ref

Reference value to a Link object.

This property provides a reference to an object defined elsewhere. This property and all other properties are mutually exclusive. If other properties are defined in addition to the ref property then the result is undefined.

Returns:

reference to a link

Default:

""